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.

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
  • Onboarding the Amazon environment
  • Creating the network blueprint

create

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

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py environment-create [-h] [--waitfor TIME_OUT_SECONDS] --name NAME --description DESCRIPTION --podname NAME --environmentblueprint NAME|id:<GUID> [--environmentblueprintversion NUMBER] [--allowspublicip]

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, description=None, blueprint=None, environmentBlueprintVersion=None, podName=None, allowsPublicIP=False)

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

--description
description

A description of the new environment.

Yes

--podname
podName

Name of the pod in the environment.

Yes

--environmentblueprint
blueprint

Name or GUID of the environment blueprint.

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.

 

--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
python com/bmc/cloud/sdk/commandline/clmcmd.py 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
python com/bmc/cloud/sdk/commandline/clmcmd.py environment-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]]

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, filters=None)

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

Command-line argument

API parameter

Description

Required?

-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
python com/bmc/cloud/sdk/commandline/clmcmd.py 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

 

reprovision

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

Command-line syntax
python com/bmc/cloud/sdk/commandline/clmcmd.py 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
python com/bmc/cloud/sdk/commandline/clmcmd.py 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

 

 

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