Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

resource-pool


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

Note

To delete or list pools, use the pool noun, which applies to all pool types. See pool for more information.

create

Use resource-pool-create from the command line to create a new compute pool containing the specified resource pools.

Command-line syntax
clm resource-pool-create [-h] [--waitfor TIME_OUT_SECONDS] --poolname NAME --description DESCRIPTION
--podname NAME --environmentname NAME --providername NAME --vendorname NAME --resourcenames NAME --hwarch HWARCH

Use resource_pool_create in the API to create a new compute pool containing the specified resource pools. This command returns a StaticPool Python object with the same attributes and relationships.

API syntax
obj=resource_pool_migrate(gcac, provider=None, dryrun=None,sourcepodname=None,sourcecluster=None, destinationpodname=None,destinationcluster= None, resourcepoolfilter=None,resourcepoolname=None)

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

Command-line argument

API parameter

Description

Required?

--poolname
poolName

Name of the new pool.

Yes

--description
description

Description of the new pool.

Yes

--podname
podName

Name of the pod for the pool.

Yes

--environmentname
networkContainerName

Name of the environment/network container to associate with the pool.

Yes

--providername
providerName

Name of the provider of the resource pool.

Yes

--vendorname
vendorName

Name of the vendor of the resource pool.

Yes

--resourcenames
listofResourceNames

Name of the resource pools to add.

 

--hwarch
hwArch

Hardware architecture of the resource.

 

--waitfor

 

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

 

 

gcac

GenericCloudAPIClient instance/user authentication

 

update

Use resource-pool-update from the command line to update a compute pool or its resource pools.

Command-line syntax
clm resource-pool-update [-h] [--waitfor TIME_OUT_SECONDS] --poolname NAME [--description DESCRIPTION]
[--addresource NAME|id:<GUID>] [--removeresource NAME|id:<GUID>]

Use resource_pool_update in the API to update a compute pool or its resource pools. This command returns a StaticPool Python object with the same attributes and relationships.

API syntax
obj = resource_pool_update(gcac, pool_name=None, description=None, add_resources=None, remove_resources=None)

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

Command-line argument

API parameter

Description

Required?

--poolname
pool_name

Name of the compute pool to update.

Yes

--description
description

New description of the compute pool.

 

--addresource
add_resources

Name or GUID of a resource pool to add to the compute pool.

 

--removeresource
remove_resources

Name or GUID of a resource pool to remove from the compute pool.

 

--waitfor

 

Time in seconds to wait for 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*