environment

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

Note

Some configuration for Amazon Web Services must be done outside of the SDK, including the following tasks:

Creating the Amazon Web Service account
Creating the network blueprint

create

Use environment-create from the command line to create a new environment.

Command-line syntax

clm environment-create [-h] [--waitfor TIME_OUT_SECONDS] --name NAME --environmentblueprint NAME|id:<GUID> --provider NAME [--environmentblueprintversion NUMBER] [--allowspublicip] [--description DESCRIPTION] [--podname NAME] [--account ACCOUNT] [--region REGION] [--publicip IP_ADDRESS/NETWORK_MASK [IP_ADDRESS/NETWORK_MASK ...]]

Use environment_create in the API to create a new environment. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.

API syntax

obj = environment_create(gcac, name=None, environmentblueprint=None, provider=None, environmentBlueprintVersion=None, allowsPublicIP=False, description=None, podName=None, account=None, region=None, publicip=IP/Mask)

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

Command-line argument	API parameter	Description	Required?
--name	name	Name of the new environment.	Yes
--environmentblueprint	blueprint	Name or GUID of the environment blueprint.	Yes
--provider	provider	Name of the provider in which the environment resides.	Yes
--environmentblueprintversion	environmentBlueprintVersion	An environment blueprint specific version, otherwise the latest version will be used by default.
--allowspublicip	allowsPublicIP	Allow public IP for the new environment.
--description	description	A description of the new environment.
--podname	podName	Name of the pod in the environment.
--acount	account	Name of the BMC Cloud Lifecycle Management account that corresponds to an Amazon Web Services account.
--region	region	Name of the Amazon Web Services region.
--publicip	publicip	IP address and mask address values.
--waitfor		Time in seconds to wait for response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication

delete

Use environment-delete from the command line to delete an environment.

Command-line syntax

clm environment-delete [-h] --environmentname NAME --providername NAME

Use environment_delete in the API to delete an environment. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.

API syntax

obj = environment_delete(gcac, environmentName=None, providerName=None)

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

Command-line argument	API parameter	Description	Required?
--name	environmentName	Name of the environment to delete.	Yes
--providername	providerName	Name of the provider in which the environment resides.	Yes
	gcac	GenericCloudAPIClient instance/user authentication

list

Use environment-list from the command line to list available environments.

Command-line syntax

clm environment-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]] --provider NAME [--account NAME] [--isonboard]

Use environment_list in the API to list available environments. This command returns a list of LogicalHostingEnvironment API objects with the same attributes and relationships.

API syntax

obj = environment_list(gcac, provider=None, account=None, isonboard=True, filters=None)

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

Command-line argument	API parameter	Description	Required?
provider	provider	Name of the provider in which the environment resides.	Yes
account	account	Name of the BMC Cloud Lifecycle Management account that corresponds to an Amazon Web Service account.
isonboard	isonboard	Indicates that environments not yet onboarded should be listed. For the command line, this parameter does not need a value. For the API, specify True, False, or None.
-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 as the value for this parameter.
--filter	filters	Filter the output according to the specified criteria.
	gcac	GenericCloudAPIClient instance/user authentication

map-to

Use environment-map-to from the command line to map compute pools, tenants, or tags to an environment.

Command-line syntax

clm environment-map-to [-h] [--waitfor TIME_OUT_SECONDS] --providername NAME --environmentname NAME [--computepoolname NAME] [--tenantname NAME] [--tag GROUP[TAG1,TAG2,...]]

Use environment_map in the API to map compute pools, tenants, or tags to an environment. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.

API syntax

obj = environment_map(gcac, environmentName=None, providerName=None, listOfStaticPoolNames=None, listOfTenantNames=None, tagList=None)

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

Command-line argument	API parameter	Description	Required?
--providername	providerName	Name of the provider.	Yes
--environmentname	environmentName	Name of the environment.	Yes
--computepoolname	listOfStaticPoolNames	Name of a compute pool to map to the environment.
--tenantname	listOfTenantNames	Name of a tenant to map to the environment.
--tag	tagList	Tag or tags to map to the environment. Any tags or tag groups specified here will be created if they do not already exist.
--waitfor		Time in seconds to wait for a response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication

offboard

Use environment-offboard from the command line to offboard the specified environment.

Command-line syntax

clm environment-offboard [-h] [--waitfor TIME_OUT_SECONDS] --environment NAME --provider NAME

Use environment_offboard in the API to offboard the specified environment. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.

API syntax

obj = environment_offboard(gcac, environment=None, provider=None)

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

Command-line argument	API parameter	Description	Required?
--environment	environment	Name or GUID of an environment to offboard.	Yes
--provider	provider	Name or GUID of a provider.	Yes
--waitfor		Time in seconds to wait for a response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

onboard

Use environment-onboard from the command line to onboard the specified environment.

Command-line syntax

clm environment-onboard [-h] [--waitfor TIME_OUT_SECONDS] --environment NAME --provider NAME [--account NAME]

Use environment_onboard in the API to onboard the specified environment. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.

API syntax

obj = environment_onboard(gcac, environment=None, provider=None, account=None)

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

Command-line argument	API parameter	Description	Required?
--environment	environment	Name or GUID of an environment to onboard.	Yes
--provider	provider	Name or GUID of a provider.	Yes
--account	account	Name of the BMC Cloud Lifecycle Management account that corresponds to an Amazon Web Service account.
--waitfor		Time in seconds to wait for a response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

reprovision

Use environment-reprovision from the command line to re-provision an environment with a newer version of a blueprint.

Command-line syntax

clm environment-reprovision [-h] --environmentname NAME|id:<GUID> --blueprint NAME|id:<GUID> [--version NUMBER]

Use environment_reprovision from the command line to re-provision an environment with a newer version of a blueprint. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.

API syntax

obj = environment_reprovision(gcac, environment=None, blueprint=None, version=None)

Command-line argument	API parameter	Description	Required?
--environmentname	environment	Name or GUID of the environment to re-provision.	Yes
--blueprint	blueprint	Name or GUID of the new environment blueprint.	Yes
--version	version	A specific environment blueprint version number, otherwise the latest version will be used by default
	gcac	GenericCloudAPIClient instance/user authentication

unmap-to

Use environment-unmap-to from the command line to unmap compute pools, tenants, or tags from an environment.

Command-line syntax

clm environment-unmap-to [-h] [--waitfor TIME_OUT_SECONDS] --providername NAME --environmentname NAME [--computepoolname NAME] [--tenantname NAME] [--tag GROUP[TAG1,TAG2,...]]

Use environment_unmap in the API to unmap compute pools, tenants, or tags from an environment. This command returns a LogicalHostingEnvironment API object with the same attributes and relationships.

API syntax

obj = environment_unmap(gcac, environmentName=None, providerName=None, listOfStaticPoolNames=None, listOfTenantNames=None, tagList=None)

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

Command-line argument	API parameter	Description	Required?
--providername	providerName	Name of the provider.	Yes
--environmentname	environmentName	Name of the environment.	Yes
--computepoolname	listOfStaticPoolNames	Name of a compute pool to unmap from the environment.
--tenantname	listOfTenantNames	Name of a tenant to unmap from the environment.
--tag	tagList	Tag or tags to unmap from the environment.
--waitfor		Time in seconds to wait for a response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication

environment

create

delete

list

map-to

offboard

onboard

reprovision

unmap-to

On this page