deploy vm_agent

Deploys Agent for VMware (Virtual Appliance) to an ESX(i) host managed by a vCenter Server or to a stand-alone ESX(i) host.

You can deploy only one agent at a time. The --service=ams parameter is mandatory because the command is executed by the management server.

Examples

Parameters

--vsphere_address=<IP address or hostname>

vCenter Server that manages the vSphere to which you want to deploy the agent. If you need to deploy the agent to a stand-alone ESX(i) host, specify this host.

If the parameter is not specified, the command will fail.

--credentials=<user name>,<password>,encrypted

Credentials for the vCenter Server or stand-alone ESX(i) host.

--vmconnection_credentials=<user name>,<password>,encrypted

Credentials that the agent will use to access the vCenter Server or the ESX(i) host. The account must have the necessary privileges on the vCenter Server, as described in the "Privileges for VM backup and recovery" section of the "Backing up virtual machines" document.

If the parameter is not specified, the agent will use the credentials specified after the --vsphere_address parameter.

--vmhost=<IP address or hostname>

ESX(i) host to which you want to deploy the agent. If not specified, the host will be selected automatically.

The parameter is used only if the --vsphere_address parameter points to a vCenter Server. If it points to a stand-alone ESX(i) host, the --vmhost parameter is redundant.

--vmname=<virtual machine name>

Name of the virtual appliance. If not specified, the value is AcronisESXAppliance-[N] where [N] is a sequence number of the appliance deployment attempt.

--vmstorage=<datastore name>

Location of the virtual appliance. If not specified, the software will automatically select one of the datastores available to the host.

--vmnic={flexible|E1000|vmxnet|vmxnet2|vmxnet3}

Type of the virtual appliance's network adapter. If not specified, the value is vmxnet3.

--vmnetwork=<network label>

Network to which the virtual appliance's network adapter will be connected. For example, --vmnetwork="VM Network". If not specified, the software will automatically select one of the available networks.

--mac_address=<MAC address>

MAC address of the virtual appliance's network adapter. The format is XX:XX:XX:XX:XX:XX. For example, --mac_address=00:50:56:8c:00:00. If not specified, the software will generate the MAC address.

Network settings of the virtual appliance

If any of the parameters described in this section are not specified, the virtual appliance will obtain the values from the DHCP server that is present on your network.

--ip_address=<IP address>

IP address. For example, --ip_address=10.200.200.10.

--subnet_mask=<subnet mask>

Subnet mask. For example, --subnet_mask=255.255.255.0.

--gateway=<default gateway>

Default gateway. For example, --gateway=10.200.200.1.

--dns=<DNS servers>

IP addresses of the DNS servers. For example, --dns=10.200.200.101,10.200.200.102.

--dns_suffix=<DNS suffix>

DNS suffix. For example, --dns_suffix=mydomain.com.

--wins=<WINS servers>

IP addresses of the WINS servers. For example, --wins=10.200.200.111,10.200.200.112.

General parameters

--log=<full path>
--log_format={structured|unstructured}
--progress
{-f|--file_params}=<full local path>

Access to a remote management server

--host=<IP address or hostname>
--credentials=<user name>,<password>,encrypted

Access to the management server service

--service=ams