st_volume_add_label
A label is an arbitrary string that can be used to identify or classify a volume.
It has no impact on the operation of the volume. The number of labels for a volume
is not limited. Labels are by default stored in the same order as they have been added.
Setting the 'front' flag will add the label in front of any other labels.
Mandatory Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| vid | integer | ID of an existing volume |
| label | string | The label. Can be any string |
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