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 following 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 examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.
Python using XML-RPC