pod
This topic describes the verbs, command-line arguments, and API parameters available for the pod noun in the BMC Cloud Lifecycle Management SDK.
list
Use pod-list from the command line to list available pods.
[-k FIELD_NAME [FIELD_NAME ...]] [--providername NAME] [--nonboarded]
Use pod_list in the API to list available pods. This command returns a list of Pod API objects with the same attributes and relationships.
obj[n].guid returns the GUID
obj[n].name returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--providername | provider_name | Name of the provider of the pods to list. This parameter is required if the --nonboarded parameter is used. | Conditional |
--nonboarded | onboarded | Indicates that pods not yet onboarded should be listed. For the command line, this parameter does not need a value. For the API, the value must be True or False. | Conditional |
-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. |
|
| gcac | GenericCloudAPIClient instance/user authentication |
|
offboard
Use pod-offboard from the command line to offboard a pod.
Use pod_offboard in the API to offboard a pod. This command returns a Pod 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? |
|---|---|---|---|
--podname | podName | Name of the pod to offboard. | Yes |
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication |
|
onboard
Use pod-onboard from the command line to onboard a pod.
Use pod_onboard in the API to onboard a pod. This command returns a Pod 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? |
|---|---|---|---|
--providername | providerName | Name of the provider of the pod to onboard. | Yes |
--podname | podName | Name of the pod to onboard. | 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 pod-refresh from the command line to synchronize the state of a pod, making it current with its provider.
Use pod_refresh in the API to synchronize the state of a pod, making it current with its provider. This command returns a Pod 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? |
|---|---|---|---|
--podname | pod_name | Name of the pod 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 |
|