Reference Guide › Command Line Scripting › CA Hyper-V CLI Commands › dpmhyperv SetClustered Command--Add or Remove a VM from a Cluster

dpmhyperv SetClustered Command--Add or Remove a VM from a Cluster

The dpmhyperv SetClustered command either adds or removes a VM from the Hyper-V cluster.

This command has the following format:

dpmhyperv SetClustered 
[-ws_user username] 
[-ws_password password] 
[-ws_encrypted_password] 
-hypervHost hostname 
-vm VM_name|-vmguid vm_ID 
-clustered {on|off} 
[-pre] 
[-post]
[-locale iso639value]

-ws_user username

(Optional) Specifies the CA Server Automation user name.

-ws_password password

(Optional) Specifies the CA Server Automation user password.

-ws_encrypted_password

(Optional) Indicates whether the CA Server Automation password is encrypted.

-host hostname

Specifies the host name of the Hyper-V server.

-vm vm_name

Specifies the VM name.

-vmguid vm_ID

Specifies the unique GUID of the VM.

-clustered {on|off}

Indicates whether to add or remove the VM from the cluster.

on

Indicates to add the VM to the cluster.

off

Indicates to remove the VM from the cluster.

-pre

(Optional) Generates an event before the operation is complete.

-post

(Optional) Generates an event after the operation is complete.

-locale iso639value

(Optional) Specifies an IS0 639_3166 combination to override the default English output, for example, fr_FR for French. To use the locale of the command prompt, specify "native".

Example: Append a VM to a Hyper-V Cluster

This example appends the VM with the GUID, "38F29B6A-TEST-BFED14644376" to the Hyper-V cluster.

dpmhyperv SetClustered -ws_user admin -ws_password #test# -hypervHost hserver -vmguid 38F29B6A-TEST-BFED14644376 -clustered on

Example: Remove a VM from a Hyper-V Cluster

This example removes the VM, "test-vm01" from the Hyper-V cluster.

dpmhyperv SetClustered -ws_user admin -ws_password #test# -hypervHost hserver -vm test-vm01 -clustered off