Reference Guide › Command Line Scripting › CA Hyper-V CLI Commands › dpmhyperv GetVMState Command--Get a VM State

dpmhyperv GetVMState Command--Get a VM State

The dpmhyperv GetVMState command returns the current state of a VM. The following list describes the four states:

• disabled: VM is turned off
• enabled: VM is up and running
• paused: VM is temporarily stopped
• suspended: VM is stopped

This command has the following format:

GetVMState 
[-ws_user username] 
[-ws_password password] 
[-ws_encrypted_password] 
-hypervHost hostname 
-vm vmname|-vmguid vm_ID 
[-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.

-hypervHost hostname

Specifies the name of the Hyper-V host.

-vm vm_name

Specifies the VM name.

-vmguid vm_ID

Specifies the unique GUID of the VM.

-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: Get a VM State Using the VM Name

This example returns the state of the VM, "vm01" on the host, "hserver."

dpmhyperv GetVMState -ws_user admin -ws_password #test# -hypervHost hserver -vm test-vm01

Example: Get a VM State Using the VM GUID

This example returns the state of the virtual machine having the GUID, "38FTESTED14644376" on the host, "hserver."

dpmhyperv GetVMState -ws_user admin -ws_password #test# -hypervHost hserver -vmguid 38FTESTED14644376