cluster-pool and compute_pool

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

Note

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

create

Use cluster-pool-create from the command line to create a new compute pool with the specified clusters.

Command-line syntax

clm cluster-pool-create [-h] [--waitfor TIME_OUT_SECONDS] --poolname NAME --description DESCRIPTION --podname NAME --environmentname NAME --providername NAME --vendorname NAME --clustername NAME --hwarch HWARCH

Use compute_pool_create in the API to create a new compute pool with the specified clusters. This command returns a StaticPool Python object with the same attributes and relationships.

API syntax

obj = compute_pool_create(gcac, poolName=None, description=None, listofClusterNames=None, podName=None, networkContainerName=None, providerName=None, vendorName=None, hwArch=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 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 cluster.	Yes
--vendorname	vendorName	Name of the vendor of the cluster.	Yes
--clustername	listofClusterNames	Name of the cluster to add to the pool.	Yes
--hwarch	hwArch	The hardware architecture of the cluster.	Yes
--waitfor		Time in seconds to wait for response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

update

Use cluster-pool-update from the command line to update the compute pool description or the clusters in the pool.

Command-line syntax

clm cluster-pool-update [-h] [--waitfor TIME_OUT_SECONDS] --poolname NAME [--description DESCRIPTION] [--addcluster NAME|id:<GUID>] [--removecluster NAME|id:<GUID>]

Use compute_pool_update in the API to update the compute pool description or the clusters in the pool. This command returns a StaticPool Python object with the same attributes and relationships.

API syntax

obj = compute_pool_update(gcac, pool_name=None, description=None, add_clusters=None, remove_clusters=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 that needs to be updated.	Yes
--description	description	New description of the compute pool.
--addcluster	add_clusters	Name or GUID of a cluster to add to the compute pool
--removecluster	remove_clusters	Name or GUID of a cluster 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.

cluster-pool and compute_pool

create

update

On this page