cluster
This topic describes the verbs, command-line arguments, and API parameters available for the cluster noun in the BMC Cloud Lifecycle Management SDK.
list
Use cluster-list from the command line to list available clusters.
[--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]] [--providername NAME] [--nonboarded]
Use cluster_list in the API to list available clusters. This command returns a list of VirtualCluster API objects with the same attributes and relationships.
obj.guid # returns the GUID
obj.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. |
|
--providername | providerName | Name of the provider of the cluster. |
|
--nonboarded | onboarded | Indicates that clusters not yet onboarded should be listed. For the command line, this parameter does not need a value. For the API, specify true, false, or None. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
migrate
In BMC Cloud Lifecycle Management 4.6.05 and later, use cluster-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.
[--clusterfilter ATTRIBUTENAME=ATTRIBUTEVALUE] [--provider NAME|id:GUID]
[--destinationcluster NAME|id:GUID] [--destinationpodname NAME]
(--sourcecluster NAME|id:GUID | --file CSV FORMAT FILE)
Use cluster_migrate in the API to migrate infrastructure resources of one or more services from a specified vCenter, cluster, or host to another.
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. |
|
--clusterfilter ATTRIBUTENAME=ATTRIBUTEVALUE | Filter applicable for clusters to be migrated.
|
|
--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. |
|
--provider NAME|id:GUID | Name or GUID of the provider. Note: Currently, only BMC BladeLogic Server Automation (BBSA) is supported as a provider. |
|
--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 |
--file CSV FORMAT FILE | Full path of the CSV file. | Yes |
offboard
Use cluster-offboard from the command line to offboard a cluster.
--cluster NAME|id:<GUID>
Use cluster_offboard in the API to offboard a cluster. This command returns a VirtualCluster API object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--cluster | clusterName | Name or GUID of the cluster to offboard. | Yes |
--podname | podName | Name of the pod to which the cluster belongs. |
|
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
onboard
Use cluster-onboard from the command line to onboard a cluster.
--providername NAME --podname PODNAME
Use onboard_cluster in the API to onboard a cluster. This command returns a VirtualCluster API object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--clustername | clusterName | Name of the cluster to onboard. | Yes |
--providername | providerName | Name of the provider of the cluster to onboard. | Yes |
--podname | podName | Name of the pod to which the cluster belongs. | Yes |
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
refresh
Use cluster-refresh from the command line to synchronize the state of a cluster, making it current with its actual configuration.
Use cluster_refresh in the API to synchronize the state of a cluster, making it current with its actual configuration. This command returns a VirtualCluster API object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--cluster | cluster_name | Name or GUID of the cluster to refresh. | Yes |
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|