Reference Guide › Command Line Scripting › CA VMware vCenter Server CLI Commands › dpmvc vmtotemplate Command--Convert VM to Template

dpmvc vmtotemplate Command--Convert VM to Template

The dpmvc vmtotemplate command converts virtual machines to templates. This capability helps you to enforce consistency across multiple servers in the data center.

This command has the following format:

dpmvc vmtotemplate 
[-sc sc_url] 
-vm_name vmname 
-datacenter_name datacentername 
[-vc_server vmserver] 
[-vc_user vcuser] 
[-vc_password vcpassword] 
[-auth_file authorizationfilename] 
[-auth_comp componentID] 
[-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

-vm_name vmname

Specifies the VM.

-datacenter_name datacentername

Specifies the data center where the VM is located.

-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 Server Automation 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.

-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: Convert a VM into a Template using Global Credentials in a Single vCenter Server Environment

This example converts the VM named convertTest test into a template.

dpmvc vmtotemplate -datacenter_name VAS/MyCity -template_name convertTest 
-compute_resource_name onDemand/myhost.myco.com -esx_host_name myhost.myco.com 
-resource_pool_name Resources/QA

Example: Convert a VM into a Template using Global Credentials in a Multiple vCenter Server Environment

This example converts the template named payrollSystem1 into a VM.

dpmvc vmtotemplate -datacenter_name VAS/MyCity -template_name payrollSystem1 
-compute_resource_name onDemand/myhost.myco.com -esx_host_name myhost.myco.com 
-resource_pool_name Resources/QA -vc_server vc_server_1

Example: Convert VM into a Template using Specified Authorization File and Component ID

This example converts the template named Win2K3 into a VM.

dpmvc vmtotemplate -datacenter_name VAS/MyCity -template_name Win2K3 
-compute_resource_name onDemand/myhost.myco.com -esx_host_name myhost.myco.com 
-resource_pool_name Resources/QA -vc_server vc_server_1 -vc_user VCAdmin1 
-auth_file c:\localauth.dat -auth_comp Imaging