database
This topic describes the verbs, command-line arguments, and API parameters available for the database noun in the BMC Cloud Lifecycle Management SDK.
list
Use database-list from the command line to list available databases.
[--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]] [--provider NAME|id:<GUID>]
[--nonboarded]
Use database_list in the API to list available databases. This command returns a list of SoftwareContainer 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. |
|
--provider | providerName | Name or GUID of the provider of the database. |
|
--nonboarded | onboarded | Indicates that databases 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 database-offboard from the command line to offboard a database.
Use database_offboard in the API to offboard a database. This command returns a SoftwareContainer 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? |
|---|---|---|---|
--database | database | Name or GUID of the database 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 database-onboard from the command line to onboard a database.
--pod NAME|id:<GUID> --database NAME|id:<GUID>
Use database_onboard in the API to onboard a database. This command returns a SoftwareContainer 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? |
|---|---|---|---|
--provider | provider | Name or GUID of the provider of the database to onboard. | Yes |
--pod | pod | Name or GUID of the pod to which the database belongs. | Yes |
--database | database | Name or GUID of the database 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. |
|