host-pool

This topic describes the verbs, command-line arguments, and API parameters available for the host-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 host-pool-create from the command line to create a new compute pool with the specified hosts.

Command-line syntax

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

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

API syntax

obj = host_pool_create(gcac, poolName=None, description=None, listofHostNames=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 host.	Yes
--vendorname	vendorName	Name of the vendor of the host.	Yes
--hostnames	listofHostNames	Names of the hosts to add to the pool.	Yes
--hwarch	hwarch	The hardware architecture of the host.	Yes
--waitfor		Time in seconds to wait for response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication

update

Use host-pool-update from the command line to update the compute pool description or the hosts in the pool.

Command-line syntax

clm host-pool-update [-h] [--waitfor TIME_OUT_SECONDS] --poolname NAME
[--description DESCRIPTION] [--addhost NAME|id:<GUID>] [--removehost NAME|id:<GUID>]

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

API syntax

obj = host_pool_update(gcac, pool_name=None, description=None, add_hosts=None, remove_hosts=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.
--addhost	add_hosts	Name or GUID of a host to add to the compute pool
--removehost	remove_hosts	Name or GUID of a host 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

host-pool

create

update

On this page