Skip to Content
Information
Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

environmentblueprint

This topic describes the verbs, command-line arguments, and API parameters available for the environmentblueprint noun in the BMC Cloud Lifecycle Management SDK.

list

Use environmentblueprint-list from the command line to list available environment blueprints.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py environmentblueprint-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] --podname NAME [--nonboarded]

Use environment_blueprint_list in the API to list available environment blueprints. This command returns a list of  LogicalHostingEnvironmentBlueprint Python objects with the same attributes and relationships.

API syntax
obj = environment_blueprint_list(gcac, podName=None, onboarded=False)

obj[n].guid returns the GUID
obj[n].name returns the name
...

Command-line argument

API parameter

Description

Required?

--podname
podName

Name of the pod containing the blueprint.

Yes

-l

 

List all fields. This parameter does not need a value.

 

-u

 

List only GUIDs. This parameter does not need a value.

 

-n

 

List only names. This parameter does not need a value.

 

-s

 

List GUIDs, names, and status (if applicable). This parameter does not need a value.

 

-k

 

List the field names specified in the value for this parameter.

 

--nonboarded
onboarded

Indicates that blueprints not yet onboarded should be listed. This parameter does not need a value.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

offboard

Warning

Note

This command works only when an on-premises pod exists. In other cases, an environment blueprint must be created through the BMC Cloud Lifecycle Management graphical interface. For more information, see Creating-network-pod-blueprints.

Use environmentblueprint-offboard from the command line to offboard an environment blueprint.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py environmentblueprint-offboard [-h] [--waitfor TIME_OUT_SECONDS] --podname NAME --blueprint NAME|id:<GUID>

Use environment_blueprint_offboard in the API to offboard an environment blueprint. This command returns a  LogicalHostingEnvironmentBlueprint Python object with the same attributes and relationships.

API syntax
obj = environment_blueprint_offboard(gcac, podName, blueprintName)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument

API parameter

Description

Required?

--podname
podName

Name of the pod containing the blueprint to offboard.

Yes

--blueprint
blueprintName

Name or GUID of the blueprint to offboard.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

onboard

Warning

Note

This command works only when an on-premises pod exists. In other cases, an environment blueprint must be created through the BMC Cloud Lifecycle Management graphical interface. For more information, see Creating-network-pod-blueprints.

Use environmentblueprint-onboard from the command line to onboard an environment blueprint.

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py environmentblueprint-onboard [-h] [--waitfor TIME_OUT_SECONDS] --providername NAME --podname NAME --blueprintname NAME [--environmentblueprintversion NUMBER]

Use environment_blueprint_onboard in the API to onboard an environment blueprint. This command returns a  LogicalHostingEnvironmentBlueprint Python object with the same attributes and relationships.

API syntax
obj = environment_blueprint_onboard(gcac, blueprintName=None, providerName=None, podName=None, environmentBlueprintVersion=None)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument

API parameter

Description

Required?

--providername
providerName

Name of the provider of the blueprint to onboard.

Yes

--podname
podName

Name of the pod containing the blueprint to onboard.

Yes

--blueprintname
blueprintName

Name of the blueprint to onboard.

Yes

--environmentblueprintversion
environmentBlueprintVersion

Specific version of the blueprint to onboard, otherwise the latest version will be onboarded by default

 

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Cloud Lifecycle Management 4.0