provider
This topic describes the verbs, command-line arguments, and API parameters available for the provider noun in the BMC Cloud Lifecycle Management SDK.
create
Use provider-create from the command line to create a new provider based on the specified definition.
Use provider_create in the API to create a new provider based on the specified definition. This command returns a Provider Python object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--providerdefinition | provider_definition_name | Name or GUID of a provider deinition to use for the new provider. | Yes |
--providername | provider_name | Name of the new provider. | Yes |
--attr | access_attributes | Value for each access attribute defined for the provider definition | Yes |
--description | description | Description of the new provider. |
|
--waitfor |
| Time in seconds to wait for response from the server, otherwise return running task details. |
|
| gcac | Instance of the gcac authentication instance |
|
delete
Use provider-delete from the command line to delete a provider.
Use provider_delete in the API to delete a provider. This command returns a Provider Python 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 | provider_name | Name of the provider to delete. | Yes |
| gcac | Instance of the gcac authentication instance |
|
list
Use provider-list from the command line to list registered providers.
Use provider_list in the API to list registered providers. This command returns a list of Provider Python 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? |
|---|---|---|---|
-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 | Instance of the gcac authentication instance |
|
update
Use provider-update from the command line to update a provider description or the values of its access attributes.
Use provider_update in the API to update a provider description or the values of its access attributes. This command returns a Provider Python 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 | Name of the provider to update. | Yes |
--description | description | New description of the provider. |
|
--attr | access_attributes | Value of each access attribute to be updated. |
|
--waitfor |
| Time in seconds to wait for response from the server, otherwise return running task details. |
|
| gcac | Instance of the gcac authentication instance |
|