Specifying Deployment Parameters Through Substitution Variables

Access through:

Service Request Approval page (accessed from approval email) OR

Request Details dialog > Add Comment

Available to:

Approvers set up in the Approval Workflow

Administrator, Operator, Operator with Approval Access Rights

A deployment parameter is a configuration setting applied to a VM component at deployment time. When expressed through substitution variables, deployment parameters are key-value pairs with a syntax read as instructions for how to configure a VM. Deployment parameter keys are case-sensitive and must be in uppercase. Invalid values like a spelling mistake in a datastore name will cause deployment failures.

Deployment parameter values can be set:

Notes:

  • You can use multiple deployment parameters in a request, but all values must make sense together.
  • Only the last occurrence of a deployment parameter is used.

Deployment Parameters

Parameter Syntax

Purpose

Examples

$DATASTORE=
<datastore_name>$

Specify the datastore for the VM. Every disk of all VMs in a request will be deployed to the specified datastore.

Supported for vCenter and SCVMM only.

$DATASTORE=My Datastore$

$DESTINATION=
<destination_name>$

Specify the deployment destination. Valid values are destination names for the targeted managed system. The requester must have access to the specified deployment destination.

$DESTINATION=Development Lab$

$IP<x>=<ip_address>$

$NETMASK<x>=
<netmask>$

$GATEWAY<x>=
<gateway>$

$DNS<x>=<dns>$

Specify the IP address, Netmask, Gateway and DNS name for the VM. All four properties must be configured for successful deployment.

Substitute <x> in the syntax with a number (1, 2, 3 and so on), as shown in the examples.

The specified netmask, gateway and DNS server will be applied to all VMs in a request.

Supported for:

  • single-VM services only
  • vCenter and SCVMM only

$IP1=1.1.1.1$ $NETMASK1=255.255.255.0$

$GATEWAY1=1.1.1.1$ $DNS1=1.1.1.10$

Specify multiple sets of these properties by changing the number in the string. For example:

$IP1=1.1.1.1$, $IP2=2.2.2.2$

If you use multiple sets, they will be applied during the deployment process in the order in which they are specified. For example, $IP1=1.1.1.1$ is applied to Network adapter 1 and $IP2=2.2.2.2$ is applied to Network adapter 2.

You can also specify an alternate DNS server for an adapter as shown in this example for the first adapter:

$DNS1=10.10.10.21;10.10.10.22$

Example of alternate DNS servers for the second adapter:

$DNS2=10.10.10.21;10.10.10.22$

$NETWORK<x>=
<network_name>$

vCenter: Specify the network the VM's NICs will be connected to.

SCVMM: Specify the logical network the VMs NICs will be connected to. If you have multiple virtual networks that are connected to the provided logical network you can specify $VIRTUALNETWORK to ensure that the proper one is selected. If $NETWORK is specified and $VIRTUALNETWORK is not specified, then Commander chooses a matching virtual network.

Not supported for AWS or Microsoft Azure.

Syntax: Substitute <x> in the syntax with a number (1, 2, 3 and so on), as shown in the examples. Networks are assigned to the NICs in the order specified.

Notes:

  • Supported for single-VM services only
  • Returns the network name, not the network zone name
  • Overrides the network zone specified on the request form

$NETWORK1=VM Network$
$NETWORK2=Private Network$

$ORGANIZATION=<organization_name>

Specify the organization for the VM when the Primary Owner is changed during a change request, and the Organization element doesn't appear on the form. The organization must be specified in order for the owner to have visibility of the VM. Supported only for change requests.

This parameter is ignored if the Organization form element appears on the change request form.

When multiple organizations are available, approvers can also use a drop-down menu on the approval landing page to specify the organization. The drop-down menu selection overrides the manually entered deployment parameter.

$ORGANIZATION=Verification$

$VIRTUALNETWORK<x>=
<virtual_network_name>$

Specify the virtual network the VM's NICs will be connected to. (By default, Commander chooses a matching virtual network that is a valid option for the logical network that was specified.)

Substitute <x> in the syntax with a number (1, 2, 3 and so on), as shown in the examples.

Supported for:

  • single-VM services only
  • SCVMM only

$VIRTUALNETWORK1=External Network$
$VIRTUALNETWORK2=Virtual Network$

$VMNAME=<vm_name>$

Specify the deployed name for the VM.

Multi-VM requests: To ensure that multiple VMs in a request are successfully deployed with unique names, you must also specify the variable #{uniqueNumber[*]} as shown in the example.

See Syntax for Naming Conventions.

See also About VM and Virtual Service Naming for information on order of precedence for VM names.

$VMNAME=MyVMName$

results in a VM named MyVMName

$VMNAME=My VM Name$

results in a VM named My VM Name

Multi-VM requests:

$VMNAME=MyVM #{uniqueNumber[3]}$

results in VMs named MyVM 001, MyVM 002 and so on.