Previous Topic: dpmsd deployprocgrp Command--Deliver a Procedure Group

Next Topic: dpmsd imgjobcheck Command--Get OS Imaging Job Status


dpmsd image Command--Deploy an Image

The dpmsd image command deploys an image to a server.

This command has the following format:

dpmsd image [-sc sc_url] -img_name imagename -target_host targethostname -target_mac macaddress -auto_deploy {yes|no} [-itcm_server itcmdomainmanager]  -computer_username username [-computer_password password] [-auth_file authorizationfilename] [-auth_comp componentID] [-deploy_template templatename] -boot_server bootserver [-interface interface] [-net_protocol netprotocol] [-net_ip_address netipaddress] [-net_def_gateway netdefgateway] [-net_sub_mask netsubmask] [-dns_server dnsserver] [-dns_suffix dnssuffix] [-boot_sepcial bootspecial] [-install_drive installdrive] [-wait [timeout]][-pre][-post][-ws_user username -ws_password password][-locale iso629value]
-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

-img_name imagename

Defines the name of the image to deploy.

-target_host targethostname

Defines the name of the target host server to which you are deploying the image.

-target_mac macaddress

Defines the hardware address of the computer to which you are deploying the image.

-auto_deploy {yes|no}

Specifies whether CA Server Automation agents are deployed automatically. Options include the following:

yes

Deploys CA Server Automation agents automatically.

no

Prevents CA Server Automation agents from being deployed automatically.

Default: no

-itcm_server itcmdomainmanager

(Optional) Defines the name of the CA ITCM Domain Manager where the software delivery adapter resides. Optional when only one Software Delivery adapter or CA ITCM domain manager is configured. Valid for CA Server Automation only.

-computer_username computerusername

Defines the user name of the target host server for the deployment operation.

Windows: Administrator access is required.

UNIX/Linux: Root access is required.

-computer_password computerpassword

(Optional) Defines the user password used for deploying agents to the target host server to which you are deploying. If you do not specify the password, is retrieved from the authorization file.

Note: Use the dpmutil CLI to set up the authorization 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.

-deploy_template templatename

(Optional) Specifies the name of the generic template created in CA Server Automation.

Note: Do not confuse this template with the templates created and managed by VMware vCenter.

-boot_server bootserver

Defines the CA ITCM boot server to deliver an image to a server.

-interface interface

(Optional; for ESX only) Defines the uplink device for the virtual switch created for the service console for VMware ESX 4.0 (vmnic0, vmnic1, and so on).

Defines an Ethernet device for the installation for VMware ESX 3.5 (eth0, eth1, and so on).

-net_protocol netprotocol

(Optional; for ESX only) Defines the use of static IP addresses for VMware ESX installations. Values can be either DHCP or static.

Default: DHCP

-net_ip_address netipaddress

(Optional; for ESX only) Defines the IP address of the server to install.

-net_def_gateway netdefgateway

(Optional; for ESX only) Defines the default gateway as an IP address.

-net_sub_mask netsubmask

(Optional; for ESX only) Defines the subnet mask for the installed system.

Default: 255.255.255.0

-dns_server dnsserver

(Optional; for ESX only) Defines the primary name server as an IP address. You can add the IP address of a secondary name with a preceding comma.

-dns_suffix dnssuffix

(Optional; for ESX only) Defines a search list for host name lookup. Use spaces to separate multiple suffixes.

-boot_special bootspecial

(Optional) Defines the Windows PE boot image for the VMware ESX installation. DOSX boot images are not supported.

-install_drive installdrive

(Optional) Defines the drive for installing the OS. hda1=IDE sda1=SCSI, RAID. You can specify multiple drives.

Default: sda1

-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 username -ws_password password

(Optional) Specifies the credentials to use for the web service security check. If you do not include credentials, you are prompted to enter them. Avoid the prompt for credentials by setting up your own session using caaipsecurity.

-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: Deploy an OS Image on a Host without Deploying Agents

This example installs an operating system image on the target host server001 using boot server bootserver001 and image ghost001 without deploying the agents.

dpmsd image -target_host server001 -target_mac 00:00:00:00:00:00 -auto_deploy no -boot_server bootserver001 -img_name ghost001 -computer_username administrator -computer_password adminpassword

Example: Deploy an OS Image on a Host without Deploying Agents in a Multiple ITCM Domain Manager Environment

This example installs an operating system image on the target host server001 using boot server bootserver001 and image ghost001 without deploying the agents. This operation is routed to the sd adapter on ITCM domain manager domainmanager001.

dpmsd image -target_host server001 -target_mac 00:00:00:00:00:00 -auto_deploy no -itcm_server domainmanager001 -boot_server bootserver001 -img_name ghost001 -computer_username administrator -computer_password adminpassword