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.

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

 

migrate

In BMC Cloud Lifecycle Management 4.6.05 and later, use resource-pool-migrate from the command line to migrate infrastructure resources of one or more services from a specified vCenter, cluster, or host to another. Because BMC Cloud Lifecycle Management retains only cluster information, specify the source and target clusters as input. For more information, see Synchronizing-migrated-server-infrastructure.

Note

This command detects only infrastructure that is designated to be migrated and updates internal data structure accordingly. Before calling this command, migrate the actual infrastructure using native tools specific to vendors (for example, VMWare).

Command-line syntax
clm resource-pool-migrate [-h] [--waitfor TIME_OUT_SECONDS] [--sourcepodname NAME]
[--sourcecluster NAME|id:GUID] [--dryrun true/false] [--provider NAME|id:GUID]
[--destinationcluster NAME|id:GUID] [--destinationpodname NAME]
(--resourcepool ATTRIBUTENAME=ATTRIBUTEVALUE |
--resourcepoolfilter ATTRIBUTENAME=ATTRIBUTEVALUE | --file CSV FORMAT FILE)

Use resource_pool_migrate in the API to migrate infrastructure resources of one or more services from a specified vCenter, cluster, or host to another.

Command-line 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

Description

Required?

-h, --help

Show help message and exit.

 

--waitfor TIME_OUT_SECONDS

Time-out in seconds to wait for a response from the server; otherwise, return the running task’s details.

If you enter -1 as the number of timeout seconds, the timeout will wait indefinitely.

 

--sourcepodname NAME 

Name of the pod containing the source cluster. This argument is required only if you specify NAME as a value for the --sourcecluster argument and the cluster name is not unique across vCenters.

 

--dryrun true/false

Used for report generation. By default, it is true.

 

--provider NAME|id:GUID

Name or GUID of the provider.

Note: Currently, only BMC BladeLogic Server Automation (BBSA) is supported as a provider.

 

--destinationcluster NAME|id:GUID

Name or GUID of the destination cluster. This argument is used to extract destination vCenter details.

--destinationcluster and --destinationpodname are required only when you migrate infrastructure across different vCenters.

 

--destinationpodname NAME

Name of the pod containing the destination cluster. This argument is required only if you specify NAME as a value for the --destinationcluster argument

 

--sourcecluster NAME|id:GUID

Name or GUID of the source cluster. This argument is used to extract source vCenter details.

Yes

--resourcepool ATTRIBUTENAME=ATTRIBUTEVALUE

Name of resource-pool to be migrated.

Yes

--resourcepoolfilter ATTRIBUTENAME=ATTRIBUTEVALUE

Filter applicable for resource-pools to be migrated.

Yes

--file CSV FORMAT FILE

Full path of the CSV file.

Yes

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*