object_volume_remove
This job removes a data volume and its associated running storage service. The data volume cannot be in use when you use this command.
Mandatory Parameters
Parameter Name | Data Type | Description |
---|---|---|
name | string | The name of the data volume. |
Optional Parameters
Parameter Name | Data Type | Description |
---|---|---|
vol_id | integer | The ID of the data volume. |
Substitute Parameters
The below table describes what parameters can be substituted for another parameter.
Parameter Name | Substitute Parameter |
---|---|
name | vol_id |
vol_id | name |
Allowed Users
The following users are allowed to run this job:
- root
Allowed Groups
The following groups are allowed to run this job:
- root
- exaadm
- exastoradm
Examples
The following code snippets show how to use this job using both Python (via XML-RPC) and on the command-line using confd_client.