st_volume_info
Return information about a volume given the ID or volume name.
Mandatory Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| vid | integer | ID of an existing volume. 'all_volumes' will return information about all existing volumes. |
Optional Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| vname | string | Volume name |
Substitute Parameters
The below table describes what parameters can be substituted for another parameter.
| Parameter Name | Substitute Parameter |
|---|---|
| vid | vname |
| vname | vid |
Allowed Users
The following users are allowed to run this job:
- root
Allowed Groups
The following groups are allowed to run this job:
- root
- exastoradm
- exaadm
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.
Python using XML-RPC