Creating and Adding Custom Properties and Property Groups 7
Using Properties in Machine Provisioning 7
Understanding Custom Properties Precedence 8
Custom Properties Grouped by Function 11
Custom Properties for Deployments 12
Custom Properties for Naming and Analyzing Deployments 14
Custom Properties for OpenStack Endpoints 15
Custom Properties for Clone Blueprints 15
Custom Properties for Linked Clone Blueprints 19
Custom Properties for FlexClone Blueprints 21
Custom Properties for Basic Workflow Blueprints 24
Custom Properties for Linux Kickstart Blueprints 25
Custom Properties for SCCM Blueprints 27
Custom Properties for WIM Blueprints 28
Custom Properties for vCloud Air and vCloud Director Blueprints 32
Custom Properties for Networking and Security 35
Custom Properties and Property Groups for Containers 45
Custom Properties for PXE Provisioning 46
Custom Properties for OVF Import 49
Custom Properties for vRealize Automation Guest Agent 49
Custom Properties for BMC BladeLogic Configuration Manager Integration 52
Custom Properties for HP Server Automation Integration 54
Custom Properties Grouped by Name 57
Custom Properties Underscore (_) 57
Custom Properties A 58
Custom Properties B 60
Custom Properties C 61
Custom Properties E 63
Custom Properties H 65
Custom Properties I 65
Custom Properties L 67
Custom Properties M 67
Custom Properties N 68
Custom Properties O 70
VMware, Inc.
3
Custom Properties Reference
Custom Properties P 71
Custom Properties R 72
Custom Properties S 72
Custom Properties V 77
Custom Properties X 99
Using the Property Dictionary 99
Using Property Definitions 99
Using Property Groups 120
Defining Component Profile Settings 122
Configure Component Profile Image Settings for Catalog Deployments 123
Configure Component Profile Size Settings for Catalog Deployments 124
VMware, Inc. 4
Custom Properties Reference
Custom Properties Reference provides information about the custom properties, and their use, that are
available when you use vRealize Automation.
This documentation is intended to be used with the vRealize Automation product documentation available
from the vRealize Automation Documentation page at https://www.vmware.com/support/pubs/vcac-
pubs.html.
Intended Audience
This information is intended for IaaS administrators, fabric administrators, and business group managers
of vRealize Automation. This content is written for experienced Windows or Linux system administrators
who are familiar with virtualization technology and the basic concepts described in Foundations andConcepts.
VMware Technical Publications Glossary
VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For
definitions of terms as they are used in VMware technical documentation, go to
http://www.vmware.com/support/pubs.
VMware, Inc.
5
Custom Properties and the
Property Dictionary1
You can use supplied vRealize Automation custom properties to control various aspects of machine
provisioning. You can also use the property dictionary to create new property definitions and property
groups that are tailored to your specific needs.
You can use properties to add values or override existing or default values for configuring network,
platform, and guest agent settings and many other deployment-related parameters.
This chapter includes the following topics:
n
Using Custom Properties
n
Custom Properties Grouped by Function
n
Custom Properties Grouped by Name
n
Using the Property Dictionary
n
Defining Component Profile Settings
Using Custom Properties
You can use vRealize Automation custom properties to add values or override existing or default values
for configuring settings for network, platform, guest agent, and many other deployment parameters.
Some properties are determined by standard settings that you must specify for all machines. For
example, memory and disk size values are required for all blueprints. You can specify additional
properties individually or in property groups in blueprints and in reservations. When you add a property to
a blueprint or a property group, you can mark it as a required property. When a property is specified as
required, the user must provide a value for that property when they request a machine, such as in the
following examples.
n
Require information about multiple disks sharing the machine’s allocated storage.
n
Require information about users or groups to be added to a local group on the machine.
n
Require the host name of the machine.
The Windows guest agent records property values on the provisioned machine in the %SystemDrive
%\VRMGuestAgent\site\workitem.xml file.
The Linux guest agent records property values on the provisioned machine in
the /usr/share/gugent/site/workitem.xml file.
VMware, Inc.
6
Custom Properties Reference
Creating and Adding Custom Properties and Property Groups
You can use custom properties to control machine provisioning. You can add supplied custom properties
and also create and add your own properties and property groups.
You can add properties and property groups to overall blueprints, components in a blueprint, reservations
and other vRealize Automation items, including some endpoint types. You can also create new custom
properties and property groups.
You can add properties and property groups when you create a blueprint, or later when the blueprint is in
the draft or published state. Alternatively you can add custom properties and property groups to individual
components in the blueprint.
Blueprint-level custom properties take precedence over custom properties that are configured at the
component level. For information about custom property precedence, see Understanding Custom
Properties Precedence.
You can edit blueprint-level properties by using the blueprint properties page.
A custom property can optionally require that the user specify a property value when they create a
machine request.
n
Custom property names and values are typically case-sensitive. For example, a custom property
expressed as hostname and another custom property expressed as HOSTNAME are considered
different custom properties.
n
Custom property names cannot contain spaces. When creating and using custom properties, do not
include a space in the property name.
n
Some custom property names are reserved and cannot be used as names when you create new
custom properties. For example the property name Encrypted and encrypted is reserved.
For more information about creating new custom properties and property groups, see Using the Property
Dictionary.
Using Properties in Machine Provisioning
Custom properties are vRealize Automation-supplied properties. You can also define your own properties.
Properties are name-value pairs used to specify attributes of a machine or to override default
specifications.
You can use custom properties to control different provisioning methods, types of machines, and machine
options as in the following examples:
n
Specify a particular type of guest OS.
n
Enable WIM-based provisioning, in which a Windows Imaging File Format (WIM) image of a
reference machine is used to provision new machines.
n
Customize the behavior of Remote Desktop Protocol when connecting to a machine.
n
Register a virtual machine with a XenDesktop Desktop Delivery Controller (DDC) server.
VMware, Inc. 7
Custom Properties Reference
n
Customize a virtual machine’s system specifications, such as adding multiple disk drives.
n
Customize the guest OS for a machine, for instance, by including specified users in selected local
groups.
n
Specify network and security settings.
n
Add additional control options such as drop-down menus to make input and selection options
available to the consumer at request time.
When you add a property to a blueprint, reservation, or other form you can specify if the property is to be
encrypted and also if the user must be prompted to specify a value when provisioning. These options
cannot be overridden when provisioning.
For an example of how to additional control options to dynamically set a custom property based on a
consumer's selection from a list of predefined options, see the Adding a Network Selection Drop-Down in
vRA 7 blog post.
A property specified in a blueprint overrides the same property specified in a property group. This enables
a blueprint to use most of the properties in a property group while differing from the property group in
some limited way. For example, a blueprint that incorporates a standard developer workstation property
group might override the US English settings in the group with UK English settings.
You can apply properties in reservations and business groups to many machines. Their use is typically
limited to purposes related to their sources, such as resource management. Specifying the characteristics
of the machine to be provisioned is generally done by adding properties to blueprints and property
groups.
Understanding Custom Properties Precedence
Properly authorized users can specify custom properties for blueprints, endpoints, business groups, and
reservations. When the same property exists in more than one source, vRealize Automation follows a
specific order of precedence when applying properties to the machine.
You can add custom properties that apply to provisioned machines to the following elements:
n
A reservation, to apply the custom properties to all machines provisioned from that reservation.
n
A business group, to apply the custom properties to all machines provisioned by business group
members.
n
A blueprint, to apply the custom properties to all machines provisioned from the blueprint.
n
Property groups, which can be included in a blueprint, to apply all the custom properties in the group
to all machines provisioned from the blueprint.
A blueprint can contain one or more property groups.
n
A machine request to apply the custom properties to the machine being provisioned.
n
An approval policy, if advanced approval support is enabled, to require approvers to provide values
for the machine being approved.
VMware, Inc. 8
Custom Properties Reference
The following list shows the order of precedence for custom properties. Property value specified in a
source that appears later in the list override values for the same property specified in sources that appear
earlier in the list.
Note If a conflict exists between a vRealize Automation-supplied custom property name and a user-
defined property name, the vRealize Automation-supplied custom property name takes precedence.
1Property group
2Blueprint
3Business group
4Compute resource
5Reservations
6Endpoint
7Runtime
Property group, blueprint, and business group custom properties are assigned at request time, while
other compute resource, reservation, and endpoint properties are assigned during provisioning.
This order is further clarified as follows:
1Custom properties and groups at the overall blueprint level
2Custom properties and groups at the component level
3Custom properties for the business group
4Custom properties for the compute resource
5Custom properties for the reservation
6Custom properties for the endpoint
7Custom properties at the nested blueprint request level
8Custom properties at the component request level
In most situations, a runtime property takes precedence over other properties. A runtime property meets
the following conditions:
n
The property option to prompt the user is selected, which specifies that the user must supply a value
for the property when they request machine provisioning.
n
A business group manager is requesting machine provisioning and the property appears in the
custom properties list on the machine request confirmation page.
VMware, Inc. 9
Custom Properties Reference
There are exceptions to the precedence rules. For example, you add the
VMware.VirtualCenter.Folder custom property to a business group, provide a property value, and do
not select the option to show the property in the request. You add the same custom property to a blueprint
and specify that the property be shown in the request. When your designated users request provisioning
from the catalog, the property does not appear in the catalog request form because the property applies
to reservation information that is only available after provisioning begins, and not when you request
provisioning.
Custom Property Types
You can use vRealize Automation external and updated property types for cloned machines. You cannot
use Internal and read-only property types for cloned machines.
The following vRealize Automation custom property types are available.
n
Internal
The specified value is maintained in the database only. For example, the email address of the
manager who approved a machine request is recorded in the VirtualMachine.Admin.Approver
property but the property has no effect on the machine.
n
Read-only
The specified value is implemented on the machine and cannot be changed. For example,
VirtualMachine.Admin.UUID specifies the UUID of the machine, which cannot be changed.
n
External
A machine’s external properties are determined when the virtualization platform creates the machine
or during the WinPE phase of the build process. To set these properties, their values must be
provided to the proxy agent, which passes them on to the virtualization platform, or to the guest
agent , which implements them in the WinPE phase.
The specified value is implemented on the machine but is never updated. For example, if the property
VirtualMachine.Admin.AddOwnerToAdmins is set to true, the owner of the machine is added to its
local administrators group. If the owner is later removed from this group, the property is not updated
to false.
n
Updated
The specified value is implemented on the machine and is updated through data collection. For
example, if the compute resource of a machine is changed, a proxy agent updates the value of the
machine’s VirtualMachine.Admin.Hostname property.
Internal and read-only property types set attributes that the template determines.
You can use the vRealize Automation machine menu to change all reserved custom properties except the
read-only properties VirtualMachine.Admin.AgentID, VirtualMachine.Admin.UUID, and
VirtualMachine.Admin.Name.
VMware, Inc. 10
Custom Properties Reference
Custom Properties Grouped by Function
You can use custom properties to provide additional vRealize Automation controls.
Custom properties have been grouped here by function. To explore custom properties grouped by name,
see Custom Properties Grouped by Name.
n
Custom Properties for Deployments
vRealize Automation provides several custom properties that are applicable to most deployments.
n
Custom Properties for Naming and Analyzing Deployments
If provisioning fails, vRealize Automation rolls back all resources included in the catalog item. For
deployments that contain multiple components, you can use a custom property to override that
default and receive information to debug the failure. These properties are best used when applied to
the overall blueprint.
n
Custom Properties for OpenStack Endpoints
vRealize Automation includes custom properties you might want to use when you configure your
OpenStack endpoints in vRealize Automation.
n
Custom Properties for Clone Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for
clone blueprints.
n
Custom Properties for Linked Clone Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for
linked clone blueprints.
n
Custom Properties for FlexClone Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for
FlexClone blueprints.
n
Custom Properties for Basic Workflow Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for
basic workflow blueprints.
n
Custom Properties for Linux Kickstart Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for
Linux Kickstart blueprints.
n
Custom Properties for SCCM Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for
SCCM blueprints.
n
Custom Properties for WIM Blueprints
vRealize Automation includes custom properties that provide additional controls for WIM blueprints.
VMware, Inc. 11
Custom Properties Reference
n
Custom Properties for vCloud Air and vCloud Director Blueprints
You can add certain custom properties to a vCloud Air or vCloud Director machine component
definition in a blueprint.
n
Custom Properties for Networking and Security
The vRealize Automation custom properties for networking specify configuration for a specific
network device on a machine.
n
Custom Properties and Property Groups for Containers
You can add predefined property groups to a containers component in a vRealize Automation
blueprint. When machines are provisioned by using a blueprint that contain these properties, the
provisioned machine is registered as a Docker Container host machine.
n
Custom Properties for PXE Provisioning
PXE is the only provisioning method supported for Cisco UCS Manager. You can use the network
bootstrap program with vRealize Automation custom properties to initiate WIM, SCCM, or Linux
Kickstart provisioning. You can also use custom properties to call your own PowerShell scripts. Linux
Kickstart provisioning does not require custom properties.
n
Custom Properties for OVF Import
When you import an OVF to a blueprint, you can import and configure several settings as custom
properties.
n
Custom Properties for vRealize Automation Guest Agent
If you have installed the vRealize Automation guest agent in your templates for cloning or in your
WinPE, you can use custom properties to run custom scripts within the guest operating system of a
provisioned machine after the machine is fully deployed.
n
Custom Properties for BMC BladeLogic Configuration Manager Integration
vRealize Automation includes custom properties that you can use to provide additional controls for
BMC BladeLogic Configuration Manager integration.
n
Custom Properties for HP Server Automation Integration
vRealize Automation includes custom properties that you can use to provide additional controls for
HP Server Automation integration. Some custom properties are required for HP Server Automation
integration. Other custom properties are optional.
Custom Properties for Deployments
vRealize Automation provides several custom properties that are applicable to most deployments.
VMware, Inc. 12
Custom Properties Reference
Table 1‑1. Custom Properties for Blueprints and Deployments
Custom PropertyDescription
_debug_deployment
Except for scale operations which allow partially successful
deployments, the default behavior is to destroy the entire
deployment if any of the individual resources fail to provision.
You can override the default behavior by setting the
_debug_deployment custom property value to true. If
provisioning fails, the debugging custom property stops the
resources from being rolled back so you can identify which of
the components failed to provision successfully.
A failed catalog item is inaccessible because it is immediately
rolled back on failure. But when _debug_deployment is set to
true, vRealize Automation treats the otherwise failed deployment
as partially successful, which enables its accessibility. This
behavior matches how failures are treated in scale operations.
If a virtual machine deployment fails, the deployment process
does not have awareness of the machine being provisioned. If it
is not provisioned, then there is nothing for the
_debug_deployment preserve from being rolled back.
To apply the custom property to a blueprint, add
_debug_deployment to the Blueprint Properties page using
the Properties tab when you create or edit a blueprint. The
_debug_deployment property is consumed at the software
provisioning level, not the guest agent or machine provisioning
level.
You can also configure vRealize Automation to not delete virtual
machines after deployment failure by using settings in the
VRMAgent.exe.config file.
_deploymentName
_number_of_instances
When added to a blueprint, this property allows you to specify a
custom name for the deployment by setting the value of
_deploymentName to your custom string. If more than one
instance of this deployment is provisioned in a single request,
your custom name becomes a prefix. If you want users to
specify their own deployment names, set this custom property to
allow override. The following two caveats are required for usage:
n
You must add this property at the blueprint level, not at the
component level. For example, when creating or editing a
blueprint, click the Properties tab and then select Custom
Properties > New to add the _deploymentName property to
the blueprint. Do not add the property to a machine or other
component in the blueprint.
n
You must add this property as a separate property and not
as a member of a property group.
When added to a blueprint, this property allows you to specify
the number of instances of the deployment that a user can
provision in a single request.
VMware, Inc. 13
Custom Properties Reference
Custom Properties for Naming and Analyzing Deployments
If provisioning fails, vRealize Automation rolls back all resources included in the catalog item. For
deployments that contain multiple components, you can use a custom property to override that default
and receive information to debug the failure. These properties are best used when applied to the overall
blueprint.
Table 1‑2. Custom Properties for Analyzing Deployments
Custom PropertyDescription
_debug_deployment
Except for scale operations which allow partially successful
deployments, the default behavior is to destroy the entire
deployment if any of the individual resources fail to provision.
You can override the default behavior by setting the
_debug_deployment custom property value to true. If
provisioning fails, the debugging custom property stops the
resources from being rolled back so you can identify which of
the components failed to provision successfully.
A failed catalog item is inaccessible because it is immediately
rolled back on failure. But when _debug_deployment is set to
true, vRealize Automation treats the otherwise failed deployment
as partially successful, which enables its accessibility. This
behavior matches how failures are treated in scale operations.
If a virtual machine deployment fails, the deployment process
does not have awareness of the machine being provisioned. If it
is not provisioned, then there is nothing for the
_debug_deployment preserve from being rolled back.
To apply the custom property to a blueprint, add
_debug_deployment to the Blueprint Properties page using
the Properties tab when you create or edit a blueprint. The
_debug_deployment property is consumed at the software
provisioning level, not the guest agent or machine provisioning
level.
You can also configure vRealize Automation to not delete virtual
machines after deployment failure by using settings in the
VRMAgent.exe.config file.
_deploymentName
VMware, Inc. 14
When added to a blueprint, this property allows you to specify a
custom name for the deployment by setting the value of
_deploymentName to your custom string. If more than one
instance of this deployment is provisioned in a single request,
your custom name becomes a prefix. If you want users to
specify their own deployment names, set this custom property to
allow override. The following two caveats are required for usage:
n
You must add this property at the blueprint level, not at the
component level. For example, when creating or editing a
blueprint, click the Properties tab and then select Custom
Properties > New to add the _deploymentName property to
the blueprint. Do not add the property to a machine or other
component in the blueprint.
n
You must add this property as a separate property and not
as a member of a property group.
Custom Properties Reference
Custom Properties for OpenStack Endpoints
vRealize Automation includes custom properties you might want to use when you configure your
OpenStack endpoints in vRealize Automation.
Table 1‑3. Custom Properties for Openstack Endpoints
Custom PropertyDescription
VirtualMachine.Admin.ConnectAddress.Regex
VirtualMachine.NetworkN.AdditionAddressMDefines additional M IP address allocated for an OpenStack
Specifies the version of OpenStack identity provider (Keystone)
to use when authenticating an OpenStack endpoint. Configure a
value of 3 to authenticate with Keystone V3 OpenStack identity
provider. If you use any other value, or do not use this custom
property, authentication defaults to Keystone V2.
Custom Properties for Clone Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for clone
blueprints.
VMware, Inc. 15
Custom Properties Reference
Table 1‑4. Custom Properties for Clone Blueprints
Custom PropertyDescription
VirtualMachine.DiskN.StorageReservationPolicy
VirtualMachine.NetworkN.ProfileName and
VirtualMachine.NetworkN.NetworkProfileName
Specifies the storage reservation policy to use to find storage for
disk N. Also assigns the named storage reservation policy to a
volume. To use this property, substitute the volume number for N
in the property name and specify a storage reservation policy
name as the value. This property is equivalent to the storage
reservation policy name specified on the blueprint. Disk
numbering must be sequential. This property is valid for all
Virtual and vCloud reservations. This property is not valid for
Physical, Amazon, or OpenStack reservations.
Specifies the name of a network profile from which to assign a
static IP address to network device N or from which to obtain the
range of static IP addresses that can be assigned to network
device N of a cloned machine, where N=0 for the first device, 1
for the second, and so on.
n
Use VirtualMachine.NetworkN.ProfileName to select
any network from the reservation regardless of whether it
has a corresponding network profile.
n
Use VirtualMachine.NetworkN.NetworkProfileName to
only select networks that have a corresponding network
profile with the same name.
The network profile that the property points to is used to allocate
an IP address. However, the provisioned machine is attached to
any network that is selected in the reservation using a round-
robin fashion model.
Changing this property value after the network is assigned has
no effect on the expected IP address values for the designated
machines.
With WIM-based provisioning for virtual machines, you can use
this property to specify a network profile and network interface or
you can use the Network section of the Virtual Reservation
page. You can also assign the network interface to a virtual
network using the VirtualMachine.NetworkN.Name custom
property.
The following attributes of the network profile are available to
enable static IP assignment in a cloning blueprint:
n
VirtualMachine.NetworkN.SubnetMask
n
VirtualMachine.NetworkN.Gateway
n
VirtualMachine.NetworkN.PrimaryDns
n
VirtualMachine.NetworkN.SecondaryDns
n
VirtualMachine.NetworkN.PrimaryWins
n
VirtualMachine.NetworkN.SecondaryWins
n
VirtualMachine.NetworkN.DnsSuffix
n
VirtualMachine.NetworkN.DnsSearchSuffixes
VirtualMachine.NetworkN custom properties are specific to
individual blueprints and machines. When a machine is
requested, network and IP address allocation is performed
before the machine is assigned to a reservation. Because
blueprints are not guaranteed to be allocated to a specific
reservation, do not use this property on a reservation.
VMware, Inc. 16
Custom Properties Reference
Table 1‑4. Custom Properties for Clone Blueprints (Continued)
Custom PropertyDescription
Linux.ExternalScript.Name
Linux.ExternalScript.LocationType
Linux.ExternalScript.Server
Linux.ExternalScript.Path
Specifies the name of an optional customization script, for
example config.sh, that the Linux guest agent runs after the
operating system is installed. This property is available for Linux
machines cloned from templates on which the Linux agent is
installed.
If you specify an external script, you must also define its location
by using the Linux.ExternalScript.LocationType and
Linux.ExternalScript.Path properties.
Specifies the location type of the customization script named in
the Linux.ExternalScript.Name property. This can be either
local or nfs.
You must also specify the script location using the
Linux.ExternalScript.Path property. If the location type is
nfs, also use the Linux.ExternalScript.Server property.
Specifies the name of the NFS server, for example lab-
ad.lab.local, on which the Linux external customization script
named in Linux.ExternalScript.Name is located.
Specifies the local path to the Linux customization script or the
export path to the Linux customization on the NFS server. The
value must begin with a forward slash and not include the file
name, for example /scripts/linux/config.sh.
If your administrators installed the guest agent to run scripts that accept custom properties and customize
provisioned machines, you can use custom properties to further customize cloned machines that use the
guest agent.
Table 1‑5. Custom Properties for Customizing Cloned Machines with a Guest Agent
Custom PropertyDescription
VirtualMachine.Admin.AllowLogin
VirtualMachine.Admin.UseGuestAgent
VirtualMachine.DiskN.Active
Set to True (default) to add the machine owner to the local
remote desktop users group, as specified by the
VirtualMachine.Admin.Owner property.
If the guest agent is installed as a service on a template for
cloning, set to True on the machine blueprint to enable the guest
agent service on machines cloned from that template. When the
machine is started, the guest agent service is started. Set to
False to disable the guest agent. If set to False, the enhanced
clone workfow will not use the guest agent for guest operating
system tasks, reducing its functionality to
VMwareCloneWorkflow. If not specified or set to anything other
than False, the enhanced clone workflow sends work items to
the guest agent.
Set to True (default) to specify that the machine's disk N is
active. Set to False to specify that the machine's disk N is not
active.
VMware, Inc. 17
Custom Properties Reference
Table 1‑5. Custom Properties for Customizing Cloned Machines with a Guest Agent
(Continued)
Custom PropertyDescription
VirtualMachine.DiskN.Label
VirtualMachine.DiskN.Letter
VirtualMachine.Admin.CustomizeGuestOSDelay
VirtualMachine.Customize.WaitComplete
VirtualMachine.SoftwareN.Name
Specifies the label for a machine’s disk N. The disk label
maximum is 32 characters. Disk numbering must be sequential.
When used with a guest agent, specifies the label of a
machine's disk N inside the guest operating system.
Specifies the drive letter or mount point of a machine’s disk N.
The default is C. For example, to specify the letter D for Disk 1,
define the custom property as VirtualMachine.Disk1.Letter
and enter the value D. Disk numbering must be sequential.
When used in conjunction with a guest agent, this value
specifies the drive letter or mount point under which an
additional disk N is mounted by the guest agent in the guest
operating system.
Specifies the time to wait after customization is complete and
before starting the guest operating system customization. The
value must be in HH:MM:SS format. If the value is not set, the
default value is one minute (00:01:00). If you choose not to
include this custom property, provisioning can fail if the virtual
machine reboots before guest agent work items are completed,
causing provisioning to fail.
Set to True to prevent the provisioning workflow from sending
work items to the guest agent until all customizations are
complete.
Specifies the descriptive name of a software application N or
script to install or run during provisioning. This is an optional and
information-only property. It serves no real function for the
enhanced clone workflow or the guest agent but it is useful for a
custom software selection in a user interface or for software use
reporting.
VirtualMachine.SoftwareN.ScriptPath
VirtualMachine.SoftwareN.ISOName
VirtualMachine.SoftwareN.ISOLocation
VMware, Inc. 18
Specifies the full path to an application's install script. The path
must be a valid absolute path as seen by the guest operating
system and must include the name of the script filename.
You can pass custom property values as parameters to the
script by inserting {CustomPropertyName} in the path string. For
example, if you have a custom property named ActivationKey
whose value is 1234, the script path is D:\InstallApp.bat –
key {ActivationKey}. The guest agent runs the command
D:\InstallApp.bat –key 1234. Your script file can then be
programmed to accept and use this value.
Specifies the path and filename of the ISO file relative to the
datastore root. The format
is /folder_name/subfolder_name/file_name.iso. If a value
is not specified, the ISO is not mounted.
Specifies the storage path that contains the ISO image file to be
used by the application or script. Format the path as it appears
on the host reservation, for example netapp-1:it_nfs_1. If a
value is not specified, the ISO is not mounted.
Custom Properties Reference
Custom Properties for Linked Clone Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for linked
clone blueprints.
Certain vRealize Automation custom properties are required to use with linked clone blueprints.
Table 1‑6. Custom Properties for Linked Clone Blueprints
Custom PropertyDescription
VirtualMachine.DiskN.Storage
VirtualMachine.DiskN.StorageReservationPolicy
VirtualMachine.DiskN.Label
VirtualMachine.DiskN.Letter
Specifies the datastore on which to place the machine disk N,
for example DATASTORE01. This property is also used to add a
single datastore to a linked clone blueprint. N is the index
(starting at 0) of the volume to assign. Enter the name of the
datastore to assign to the volume. This is the datastore name as
it appears in the Storage Path on the Edit Compute Resource
page. Disk numbering must be sequential.
Specifies the storage reservation policy to use to find storage for
disk N. Also assigns the named storage reservation policy to a
volume. To use this property, substitute the volume number for N
in the property name and specify a storage reservation policy
name as the value. This property is equivalent to the storage
reservation policy name specified on the blueprint. Disk
numbering must be sequential. This property is valid for all
Virtual and vCloud reservations. This property is not valid for
Physical, Amazon, or OpenStack reservations.
Specifies the label for a machine’s disk N. The disk label
maximum is 32 characters. Disk numbering must be sequential.
When used with a guest agent, specifies the label of a
machine's disk N inside the guest operating system.
Specifies the drive letter or mount point of a machine’s disk N.
The default is C. For example, to specify the letter D for Disk 1,
define the custom property as VirtualMachine.Disk1.Letter
and enter the value D. Disk numbering must be sequential.
When used in conjunction with a guest agent, this value
specifies the drive letter or mount point under which an
additional disk N is mounted by the guest agent in the guest
operating system.
MaximumProvisionedMachines
Linux.ExternalScript.Name
VMware, Inc. 19
Specifies the maximum number of linked clones for one machine
snapshot. The default is unlimited.
Specifies the name of an optional customization script, for
example config.sh, that the Linux guest agent runs after the
operating system is installed. This property is available for Linux
machines cloned from templates on which the Linux agent is
installed.
If you specify an external script, you must also define its location
by using the Linux.ExternalScript.LocationType and
Linux.ExternalScript.Path properties.
Custom Properties Reference
Table 1‑6. Custom Properties for Linked Clone Blueprints (Continued)
Custom PropertyDescription
Linux.ExternalScript.LocationType
Linux.ExternalScript.Server
Linux.ExternalScript.Path
Specifies the location type of the customization script named in
the Linux.ExternalScript.Name property. This can be either
local or nfs.
You must also specify the script location using the
Linux.ExternalScript.Path property. If the location type is
nfs, also use the Linux.ExternalScript.Server property.
Specifies the name of the NFS server, for example lab-
ad.lab.local, on which the Linux external customization script
named in Linux.ExternalScript.Name is located.
Specifies the local path to the Linux customization script or the
export path to the Linux customization on the NFS server. The
value must begin with a forward slash and not include the file
name, for example /scripts/linux/config.sh.
If you installed the guest agent to customize cloned machines, you use some custom properties more
often than others.
Table 1‑7. Custom Properties for Customizing Cloned Machines with a Guest Agent
Custom PropertyDescription
VirtualMachine.Admin.UseGuestAgent
If the guest agent is installed as a service on a template for
cloning, set to True on the machine blueprint to enable the guest
agent service on machines cloned from that template. When the
machine is started, the guest agent service is started. Set to
False to disable the guest agent. If set to False, the enhanced
clone workfow will not use the guest agent for guest operating
system tasks, reducing its functionality to
VMwareCloneWorkflow. If not specified or set to anything other
than False, the enhanced clone workflow sends work items to
the guest agent.
VirtualMachine.Admin.CustomizeGuestOSDelay
VMware, Inc. 20
Specifies the time to wait after customization is complete and
before starting the guest operating system customization. The
value must be in HH:MM:SS format. If the value is not set, the
default value is one minute (00:01:00). If you choose not to
include this custom property, provisioning can fail if the virtual
machine reboots before guest agent work items are completed,
causing provisioning to fail.
Custom Properties Reference
Table 1‑7. Custom Properties for Customizing Cloned Machines with a Guest Agent
(Continued)
Custom PropertyDescription
VirtualMachine.Customize.WaitComplete
VirtualMachine.SoftwareN.ScriptPath
Set to True to prevent the provisioning workflow from sending
work items to the guest agent until all customizations are
complete.
Specifies the full path to an application's install script. The path
must be a valid absolute path as seen by the guest operating
system and must include the name of the script filename.
You can pass custom property values as parameters to the
script by inserting {CustomPropertyName} in the path string. For
example, if you have a custom property named ActivationKey
whose value is 1234, the script path is D:\InstallApp.bat –
key {ActivationKey}. The guest agent runs the command
D:\InstallApp.bat –key 1234. Your script file can then be
programmed to accept and use this value.
Custom Properties for FlexClone Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for
FlexClone blueprints.
VMware, Inc. 21
Custom Properties Reference
Table 1‑8. Custom Properties for FlexClone Blueprints
Custom PropertyDescription
VirtualMachine.NetworkN.ProfileName and
VirtualMachine.NetworkN.NetworkProfileName
Specifies the name of a network profile from which to assign a
static IP address to network device N or from which to obtain the
range of static IP addresses that can be assigned to network
device N of a cloned machine, where N=0 for the first device, 1
for the second, and so on.
n
Use VirtualMachine.NetworkN.ProfileName to select
any network from the reservation regardless of whether it
has a corresponding network profile.
n
Use VirtualMachine.NetworkN.NetworkProfileName to
only select networks that have a corresponding network
profile with the same name.
The network profile that the property points to is used to allocate
an IP address. However, the provisioned machine is attached to
any network that is selected in the reservation using a round-
robin fashion model.
Changing this property value after the network is assigned has
no effect on the expected IP address values for the designated
machines.
With WIM-based provisioning for virtual machines, you can use
this property to specify a network profile and network interface or
you can use the Network section of the Virtual Reservation
page. You can also assign the network interface to a virtual
network using the VirtualMachine.NetworkN.Name custom
property.
The following attributes of the network profile are available to
enable static IP assignment in a cloning blueprint:
n
VirtualMachine.NetworkN.SubnetMask
n
VirtualMachine.NetworkN.Gateway
n
VirtualMachine.NetworkN.PrimaryDns
n
VirtualMachine.NetworkN.SecondaryDns
n
VirtualMachine.NetworkN.PrimaryWins
n
VirtualMachine.NetworkN.SecondaryWins
n
VirtualMachine.NetworkN.DnsSuffix
n
VirtualMachine.NetworkN.DnsSearchSuffixes
VirtualMachine.NetworkN custom properties are specific to
individual blueprints and machines. When a machine is
requested, network and IP address allocation is performed
before the machine is assigned to a reservation. Because
blueprints are not guaranteed to be allocated to a specific
reservation, do not use this property on a reservation.
Linux.ExternalScript.Name
Specifies the name of an optional customization script, for
example config.sh, that the Linux guest agent runs after the
operating system is installed. This property is available for Linux
machines cloned from templates on which the Linux agent is
installed.
If you specify an external script, you must also define its location
by using the Linux.ExternalScript.LocationType and
Linux.ExternalScript.Path properties.
VMware, Inc. 22
Custom Properties Reference
Table 1‑8. Custom Properties for FlexClone Blueprints (Continued)
Custom PropertyDescription
Linux.ExternalScript.LocationType
Linux.ExternalScript.Server
Linux.ExternalScript.Path
Specifies the location type of the customization script named in
the Linux.ExternalScript.Name property. This can be either
local or nfs.
You must also specify the script location using the
Linux.ExternalScript.Path property. If the location type is
nfs, also use the Linux.ExternalScript.Server property.
Specifies the name of the NFS server, for example lab-
ad.lab.local, on which the Linux external customization script
named in Linux.ExternalScript.Name is located.
Specifies the local path to the Linux customization script or the
export path to the Linux customization on the NFS server. The
value must begin with a forward slash and not include the file
name, for example /scripts/linux/config.sh.
If you installed the guest agent to customize cloned machines, the Custom Properties for Customizing
FlexClone Machines with a Guest Agent table describes the most commonly used custom properties for
your situation.
Table 1‑9. Custom Properties for Customizing FlexClone Machines with a Guest Agent
Custom PropertyDescription
VirtualMachine.Admin.UseGuestAgent
If the guest agent is installed as a service on a template for
cloning, set to True on the machine blueprint to enable the guest
agent service on machines cloned from that template. When the
machine is started, the guest agent service is started. Set to
False to disable the guest agent. If set to False, the enhanced
clone workfow will not use the guest agent for guest operating
system tasks, reducing its functionality to
VMwareCloneWorkflow. If not specified or set to anything other
than False, the enhanced clone workflow sends work items to
the guest agent.
VirtualMachine.DiskN.Label
VirtualMachine.DiskN.Letter
VMware, Inc. 23
Specifies the label for a machine’s disk N. The disk label
maximum is 32 characters. Disk numbering must be sequential.
When used with a guest agent, specifies the label of a
machine's disk N inside the guest operating system.
Specifies the drive letter or mount point of a machine’s disk N.
The default is C. For example, to specify the letter D for Disk 1,
define the custom property as VirtualMachine.Disk1.Letter
and enter the value D. Disk numbering must be sequential.
When used in conjunction with a guest agent, this value
specifies the drive letter or mount point under which an
additional disk N is mounted by the guest agent in the guest
operating system.
Custom Properties Reference
Table 1‑9. Custom Properties for Customizing FlexClone Machines with a Guest Agent
(Continued)
Custom PropertyDescription
VirtualMachine.Admin.CustomizeGuestOSDelay
VirtualMachine.Customize.WaitComplete
VirtualMachine.SoftwareN.ScriptPath
Specifies the time to wait after customization is complete and
before starting the guest operating system customization. The
value must be in HH:MM:SS format. If the value is not set, the
default value is one minute (00:01:00). If you choose not to
include this custom property, provisioning can fail if the virtual
machine reboots before guest agent work items are completed,
causing provisioning to fail.
Set to True to prevent the provisioning workflow from sending
work items to the guest agent until all customizations are
complete.
Specifies the full path to an application's install script. The path
must be a valid absolute path as seen by the guest operating
system and must include the name of the script filename.
You can pass custom property values as parameters to the
script by inserting {CustomPropertyName} in the path string. For
example, if you have a custom property named ActivationKey
whose value is 1234, the script path is D:\InstallApp.bat –
key {ActivationKey}. The guest agent runs the command
D:\InstallApp.bat –key 1234. Your script file can then be
programmed to accept and use this value.
Custom Properties for Basic Workflow Blueprints
vRealize Automation includes custom properties that you can use to provide additional controls for basic
workflow blueprints.
Table 1‑10. Custom Properties for Basic Workflow Blueprints
Custom PropertyDescription
VirtualMachine.CDROM.Attach
VirtualMachine.Admin.ThinProvision
VirtualMachine.DiskN.StorageReservationPolicy
Set to False to provision the machine without a CD-ROM device.
The default is True.
Determines whether thin provisioning is used on ESX compute
resources. Disk provisioning is abstracted from the underlying
storage. Set to True to use thin provisioning. Set to False to use
standard provisioning. This property is for virtual provisioning.
Specifies the storage reservation policy to use to find storage for
disk N. Also assigns the named storage reservation policy to a
volume. To use this property, substitute the volume number for N
in the property name and specify a storage reservation policy
name as the value. This property is equivalent to the storage
reservation policy name specified on the blueprint. Disk
numbering must be sequential. This property is valid for all
Virtual and vCloud reservations. This property is not valid for
Physical, Amazon, or OpenStack reservations.
VMware, Inc. 24
Custom Properties Reference
Table 1‑10. Custom Properties for Basic Workflow Blueprints (Continued)
Custom PropertyDescription
VirtualMachine.Storage.AllocationType
VirtualMachine.Storage.Name
VirtualMachine.Storage.ReserveMemory
Stores collected groups to a single datastore. A distributed
environment stores disks round-robin style. Specify one of the
following values:
n
Collected
Keep all disks together.
n
Distributed
Allow disks to be placed on any datastore or datastore
cluster that is available in the reservation.
For an example of how to use the
VirtualMachine.Storage.AllocationType property to
create datastore clusters, see the Keeping Multiple Disks
Together blog post.
Identifies the storage path on which the machine resides. The
default is the value specified in the reservation that was used to
provision the machine.
Set to True to manage vSwap storage allocation to ensure
availability and set allocation in the reservation. vSwap
allocation is considered when you create or reconfigure a virtual
machine. vSwap allocation checking is only available for