Reference Guide › Command-Line Scripting › CA VMware vCenter Server CLI Commands › dpmvc cycle Command--Cycle a VM

dpmvc cycle Command--Cycle a VM

The dpmvc cycle command powers on, powers off, resets, or suspends a VM.

This command has the following format:

dpmvc cycle 
[-sc sc_url] 
-powerop {poweron|poweroff|reset|suspend|shutdown guest} 
-datacenter_name datacentername 
-vm_name vmname 
[-vc_server vcserver] 
[-vc_user vcuser] 
[-vc_password vcpassword] 
[-auth_file authorizationfilename] 
[-auth_comp componentID] 
[-wait [timeout]] 
[-pre] 
[-post] 
[-ws_user wsuser] 
[-ws_password wspassword] 
[-prompt {yes|no}] 
[-encrypted_password {yes|no}]
[-locale iso639value]

-sc sc_url

(Optional) Defines the URL for the service controller host.

Example: https://hostname:port/...

hostname

Defines the fully qualified host where the service controller is installed.

Example: localhost.ca.com

port

Defines the listening port for the service controller server.

Example: 80

-powerop {poweron|poweroff|reset|suspend|shutdown guest}

Specifies the power operation to perform on the VM. Options include the following:

poweron

Powers on the VM.

poweroff

Powers off the VM.

reset

Resets the VM.

suspend

Temporarily suspends the VM.

shutdown guest

Shuts down the guest OS gracefully.

-datacenter_name datacentername

Specifies the data center where the VM is located.

-vm_name vmname

Specifies the VM.

-vc_server vcservername

Specifies the vCenter Server to access when you have multiple vCenter Servers. Optional for single vCenter Server environments.

-vc_user vcuser

(Optional) Specifies the vCenter Server user ID. It is optional depending on whether global credentials are enabled.

-vc_password vcpassword

(Optional) Specifies the password for the vCenter server user ID. When this option is omitted an encrypted password is retrieved for the user (-vc_user option) and component (-auth_comp option), if specified from either the default authorization file or a specific authorization file (-auth_file).

-auth_file authorizationfilename

(Optional) Specifies the full path name of the authorization file to use to retrieve the encrypted password. This file contains the CA Virtual Assurance administrator credentials that were generated using the dpmutil set auth command. When this option is not specified, the default authorization file is used.

-auth_comp componentID

(Optional) Specifies a component ID that you can use to group hosts and users.

-wait timeout

(Optional) Indicates whether to display the status of the job and not return until the operation completes, fails, or the timeout period is met (if you specify a timeout value). If you do not specify this option, the CLI returns without waiting for completion. If there is no response, the optional timeout value defines the timeout period in minutes. If you enter the wait option with no timeout value, the CLI uses the default wait time from the caimgconf.cfg file or defaults to 120 minutes. In addition to any positive integer, the following timeout values are also possible:

""

No timeout value.

0

Wait indefinitely.

-pre

(Optional) Specifies whether to generate an event before the operation is performed.

-post

(Optional) Specifies whether to generate an event after the operation is performed.

-ws_user wsuser

(Optional) Specifies the web service user name to connect to the VC Platform Management Module (PMM).

-ws_password wspassword

(Optional) Specifies the password for the web service user to connect to the VC Performance Management Module (PMM).

-prompt {yes|no}

(Optional) Specifies whether you are prompted for the web service user ID and password.

Default: Yes

-encrypted_password {yes|no}

(Optional) Specifies whether you want to encrypt the VC user password.

Default: Yes

-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: Turn off a VM when there are Multiple vCenter Servers in the Data Center

This example turns off a VM from a specific vCenter Server.

dpmvc cycle -powerop poweroff -vc_server my_server1 -datacenter_name my_dc -vm_name my_vm

Example: Turn off a VM using Global Credentials in Single vCenter Server Environment

This example turns off the VM, "testvm" that belongs to the data center "DCA/MyCitySan Diego."

dpmvc cycle -vm_name testvm -powerop poweroff -datacenter_name DCA/MyCity

Example: Turn off a VM using Default Authorization File

This example turns off the VM, "testvm" that belongs to the data center "DCA/MyCitySan Diego."

dpmvc cycle -vm_name testvm -powerop poweroff -datacenter_name DCA/MyCity 
-vc_server vc_server_1

Example: Turn on a VM using Specified Authorization File and Component

This example turns on the VM, "testvm" that belongs to the data center "DCA/MyCitySan Diego."

dpmvc cycle -vm_name testvm -powerop poweron -datacenter_name DPM/San Diego 
-vc_server vc_server_1 -vc_user VCAdmin1 -auth_file c:\localauth.dat 
-auth_component Imaging

Example: Turn on a VM using Default Authorization File and Specified Component

This example turns on the VM, "testvm" that belongs to the data center "DCA/MyCitySan Diego."

dpmvc cycle -vm_name testvm -powerop poweron -datacenter_name DPM/San Diego 
-vc_server vc_server_1 -vc_user VCAdmin1 -auth_component Imaging