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.

pool


This topic describes the verbs, command-line arguments, and API parameters available for the pool noun in the BMC Cloud Lifecycle Management SDK. These verbs apply to all pool types in the SDK, including the following nouns:

delete

Use pool-delete from the command line to delete a pool of any type.

Command-line syntax
clm pool-delete [-h] --poolname NAME

Use pool_delete in the API to delete a pool of any type. This command returns a StaticPool Python object with the same attributes and relationships.

API syntax
obj = pool_delete(gcac, poolName=None)

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

Command-line argument

API parameter

Description

Required?

--poolname
poolName

Name of the pool to delete.

Yes

 

gcac

GenericCloudAPIClient instance/user authentication.

 

list

Use pool-list from the command line to list pools of any type.

Command-line syntax
clm pool-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]]

Use pool_list in the API to list pools of any type. This command returns a list of StaticPool Python objects with the same attributes and relationships.

API syntax
obj = pool_list(gcac, filters=None)

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

Use resourcepool_list in the API to list resource pools. This command returns a list of VirtualResourcePool Python objects with the same attributes and relationships.

API syntax
obj = resourcepool_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 in the value for this parameter.

 

--filter
filters

List the output that matches the specified filters.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

 

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