Skip to main content

volume rename

Contributors
Suggest changes
PDFs

Rename an existing volume

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The volume rename command renames a volume. The volume name must be unique among the other volumes in the same Vserver.

Parameters

-vserver <vserver name> - Vserver Name

This specifies the Vserver on which the volume is located. For a node's root volume, use the name of the node for this parameter.

-volume <volume name> - Volume Name

This specifies the volume that is to be renamed.

-newname <volume name> - Volume New Name

This specifies the volume's new name. A volume's name must start with an alphabetic character (a to z or A to Z) and be 203 or fewer characters in length.

[-foreground {true|false}] - Foreground Process

This specifies whether the operation runs in the foreground. The default setting is true (the operation runs in the foreground). When set to true, the command will not return until the operation completes. This parameter applies only to FlexGroups. For FlexVol volumes, the command always runs in the foreground.

Examples

The following example renames a volume named vol3_backup as vol3_save on a Vserver named vs0:

node::> volume rename -vserver vs0 -volume vol3_backup -newname vol3_save