vserver rename

Rename a Vserver

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


The vserver rename command renames the Vserver. If the vserver being renamed is participating in an Inter-cluster Vserver peer relationship, all the corresponding remote clusters will be updated with the new peer Vserver name.


-vserver <text> - Vserver
This specifies the Vserver that is to be renamed.
-newname <vserver> - New Vserver name (Use Fully Qualified Domain Name, For example: data.example.com)
This specifies the Vserver's new name. The name must be a unique Vserver name in the cluster. Use a fully qualified domain name (FQDN) - for example, "data.example.com" - for the Vserver name to reduce name collisions in cluster leagues.
Note: Maximum number of characters supported is 47, and 41 for a Vserver with subtype "sync-source". "all" is a reserved name and must not be used as a Vserver name.
[-foreground {true|false}] - Foreground Process
This specifies whether the rename job will be run in foreground or backgound. By default, the job runs in foreground.


The following examples rename a Vserver named vs1.example.com as vs2.example.com, and then finally back to its original name:
            (When there is no intercluster Vserver peer relationship with the vserver)

            cluster1::> vserver rename -vserver vs1.example.com -newname vs2.example.com

            (When there is at least one intercluster peer relationship with the Vserver)

            cluster1::> vserver rename -vserver vs1.example.com -newname vs2.example.com

            [Job 277] Job succeeded: Vserver rename completed successfully

            cluster1::> vserver rename -vserver vs2.example.com -newname vs1.example.com -foreground false

            [Job 278] Job is queued: Rename Vserver vs2.example.com to vs1.example.com.