st_volume_lock
This job locks the specified volume. Manually locking a volume does not
add an unlock condition, so the volume will never be automatically unlocked.
If a volume is locked, it will also be closed for all current users.
Mandatory Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| vid | integer | Volume ID |
Optional Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| vname | string | Name of an existing volume |
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