physicalserver
This topic describes the verbs, command-line arguments, and API parameters available for the physicaler noun in the BMC Cloud Lifecycle Management SDK.
list
Use physicalserver-list from the command line to list onboarded physical servers.
Use physicalserver_list in the API to list onboarded physical servers. This command returns a list of PhysicalServer 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. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
offboard
Use physicalserver-offboard from the command line to offboard a physical server.
Use physicalserver_offboard in the API to offboard a physical server from a pod. This command returns a PhysicalServer 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? |
|---|---|---|---|
--macaddress | macaddress | MAC address of the physical server 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 physicalserver-onboard from the command line to onboard a physical server.
Use physicalserver_onboard in the API to onboard a physical server. This command returns a PhysicalServer 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 server to onboard. | Yes |
--podname | podname | Name of the pod for the server. | Yes |
--macaddress | macaddress | MAC address of the physical server 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. |
|