Reference Guide › Command Line Scripting › CA Hyper-V CLI Commands › dpmhyperv AgentGet Command--Return an Agent Value

dpmhyperv AgentGet Command--Return an Agent Value

The dpmhyperv AgentGet command returns an agent value.

This command has the following format:

dpmhyperv AgentGet 
[-ws_user username] 
[-ws_password password] 
[-ws_encrypted_password] 
-hypervHost hostname 
-modelPath modelpath_value attributeName attribute_name 
[-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.

-jobRef job_ref_identifier

Specifies the reference identifier of the asynchronous job.

-modelPath modelpath_value

Specifies the model path of the object to get value from.

-attributeName attribute_name

Specifies the name of the attribute that you want to get.

-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: Return an Agent Value

This example returns the agent value.

dpmhyperv AgentGet 
-ws_user dcaadmin 
-ws_password #test# 
-hypervHost hserver -modelPath "https://localhost/aip/AOM/root/cimv2:CA_ComputerSystem.CreationClassName=\"CA_ComputerSystem\",Name=\"8a2a30a0-a184-11df-84a8-00155d7c7405\""  -attributeName DPM.HYPERV.SERVER.CRITICALVMS.MONITOR