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.
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. |
|
offboard
Use cluster-offboard from the command line to offboard a cluster.
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.
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. |
|