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