This section lists vRealize Automation custom properties that begin with the letter V.

Table 1. Custom Properties V Table

This section lists vRealize Automation custom properties that begin with the letter V.

Property

Description

VbScript.PreProvisioning.Name

Specifies the full path of a Visual Basic script to be run before a machine is provisioned. For example, %System-Drive%\Program Files(x86)\VMware\vCAC Agents\EPI_Agent\Scripts\SendEmail.vbs. The script file must reside on the system on which the Visual Basic script EPI agent is installed.

VbScript.PostProvisioning.Name

Specifies the full path of a Visual Basic script to be run after a machine is provisioned. For example, %System-Drive%\Program Files(x86)\VMware\vCAC Agents\EPI_Agent\Scripts\SendEmail.vbs. The script file must reside on the system on which the Visual Basic script EPI agent is installed.

VbScript.UnProvisioning.Name

Specifies the full path of a Visual Basic script to be run when a machine is destroyed. For example, %System-Drive%\Program Files (x86)\VMware\vCAC Agents\EPI_Agent\Scripts\SendEmail.vb. The script file must reside on the system on which the Visual Basic script EPI agent is installed.

VCloud.Lease.Sync.TimeBufferMins

Specifies a threshold integer value for a compute resource such that lease synchronization between vCloud Director and vRealize Automation will only occur for vCloud Director or vCloud Air provisioned machines that are set to expire in vCloud Director or vCloud Air in that time period. If a conflict is found, the lease value is synchronized to match the lease length defined invRealize Automation. The default VCloud.Lease.Sync.TimeBufferMins value is 720 minutes, which is 12 hours. If VCloud.Lease.Sync.TimeBufferMins is not present, the default value is used. For example, if the default values are used, vRealize Automation will run the lease synchronization check workflow every 45 minutes, which is the workflow default, and only the leases of machines that are set to expire within 12 hours are changed to match the lease length defined in vRealize Automation.

VCloud.Template.MakeIdenticalCopy

Set to True to clone an identical copy of the vApp template in vCloud Director and provision the results in vRealize Automation. This ignores all settings specified in the blueprints except the name of the vApp and its virtual machines. The storage path specified in the vApp template during cloning is used, even if a different storage path is specified in a vApp component blueprint or when requesting a vApp machine.

Set to False to clone a copy of the vApp template with settings specified by the vApp and vApp component blueprints.

VCNS.LoadBalancerEdgePool.Names.name

Specifies the vCloud Networking and Security load balancing pools to which the virtual machine is assigned during provisioning. The virtual machine is assigned to all service ports of all specified pools. The value is an edge/pool name or a list of edge/pool names separated by commas. Names are case-sensitive.

Appending a name allows you to create multiple versions of a custom property. For example, the following properties might list load balancing pools set up for general use and machines with high, moderate, and low performance requirements:

  • VCNS.LoadBalancerEdgePool.Names

  • VCNS.LoadBalancerEdgePool.Names.moderate

  • VCNS.LoadBalancerEdgePool.Names.high

  • VCNS.LoadBalancerEdgePool.Names.low

Note:

In a multi-machine service, this custom property is supported only for VM components with Routed Virtual Wire. It is also not supported for pre-defined static IP addresses for VM components in the context of a multi-machine blueprint.

VCNS.SecurityGroup.Names.name

Specifies the vCloud Networking and Security security group or groups to which the virtual machine is assigned during provisioning. The value is a security group name or a list of names separated by commas. Names are case-sensitive.

Appending a name allows you to create multiple versions of the property, which can be used separately or in combination. For example, the following properties can list security groups intended for general use, for the sales force, and for support:

  • VCNS.SecurityGroup.Names

  • VCNS.SecurityGroup.Names.sales

  • VCNS.SecurityGroup.Names.support

VCNS.SecurityGroup.Names.blueprint_name

When using vCloud Networking and Security, specifies the Edge Pool with which to associate the blueprint.

VCNS.SecurityTag.Names.name

Specifies the vCloud Networking and Security security tag or tags to which the virtual machine is associated during provisioning. The value is a security tag name or a list of names separated by commas. Names are case-sensitive.

Appending a name allows you to create multiple versions of the property, which can be used separately or in combination. For example, the following properties can list security tags intended for general use, for the sales force, and for support:

  • VCNS.SecurityTag.Names

  • VCNS.SecurityTag.Names.sales

  • VCNS.SecurityTag.Names.support

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 will send work items to the guest agent.

VirtualMachine.Admin.NameCompletion

Specifies the domain name to include in the fully qualified domain name of the machine that the RDP or SSH files generate for the user interface options Connect Using RDP or Connect Using SSH option. For example, set the value to myCompany.com to generate the fully qualified domain name my-machine-name.myCompany.com in the RDP or SSH file.

VirtualMachine.Admin.ConnectAddress

Specifies the RDP connection address of the machine to which an RDP file is downloaded when the user interface option Connect Using RDP is used or attached to automatic emails. Do not use in a blueprint or property group unless you require the user to be prompted and you have not supplied a default value.

VirtualMachine.Admin.ConnectAddress.Regex

Used by a vRealize Automation administrator to define a regular expression to match an IP address for terminal connections, such as an RDP connection. If matched, the IP address is saved under the VirtualMachine.Admin.ConnectAddress custom property. Otherwise, the first available IP address is designated.

For example, setting the property value to 10.10.0. allows selection of an IP address from a 10.10.0.* subnet that is assigned to the virtual machine. If the subnet has not been assigned, the property is ignored.

This property is available for use with Openstack.

VirtualMachine.Admin.ThinProvision

Determines whether thin provisioning is used on ESX compute resources using local or iSCSI storage. Set to True to use thin provisioning. Set to False to use standard provisioning. This property is for virtual provisioning.

VirtualMachine.Admin.CustomizeGuestOSDelay

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.

VirtualMachine.Admin.NetworkInterfaceType

Indicates the network interface type. Use to modify the network settings of a newly provisioned virtual machine. The following options are available:

  • E1000 (default)

  • VirtIO

  • RTL8139

  • RTL8139 VirtIO

VirtualMachine.Admin.Name

Specifies the generated machine name for vSphere, for example CodyVM01. When creating custom workflows or plug-ins for customizing a virtual machine name, set this property to match the name of the virtual machine. This is an internal input property for the agent to name the virtual machine.

Note:

This property is for vSphere only.

The value specified in the blueprint has no effect on this property. This property is not intended to be used to prompt the user. Use the HostName property to prompt the user. If the property is set at runtime, the container name that is created in the hypervisor might not match the item record name.

VirtualMachine.Admin.UUID

Specifies the UUID of the machine. The value is recorded by the guest agent when the machine is created, then it becomes read-only. The value in the blueprint or property group has no effect on this property.

VirtualMachine.Admin.AgentID

Specifies the UUID of the guest agent. The value is recorded by the guest agent when the machine is created, then it becomes read-only. The value in the blueprint or property group has no effect on this property.

VirtualMachine.Admin.Owner

Specifies the user name of the machine owner.

VirtualMachine.Admin.Approver

Specifies the user name of the group manager who approved the machine request.

VirtualMachine.Admin.Description

Specifies the description of the machine as entered or modified by its owner or an administrator.

VirtualMachine.Admin.EncryptPasswords

If set to True, specifies that the administrator passwords are encrypted.

VirtualMachine.Admin.AdministratorEmail

Specifies the manager email addresses or Active Directory accounts for the business group of the provisioning blueprint. Multiple email addresses are separated by a comma, for example JoeAdmin@VMware.com,WeiLeeMgr@VMware.com.

VirtualMachine.Admin.TotalDiskUsage

Specifies the total disk space that the machine uses, including all disks as specified by the VirtualMachine.DiskN.Size properties and the swap file as specified by the VMware.Memory. Reservation property.

VirtualMachine.Admin.Hostname

Informs the administrator which host is used for provisioning the machine on the endpoint. The specified value is implemented on the machine and is populated during 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.

Note:

This is an internal output property from the agent that is populated during the data collection process and identifies the host on which a machine resides.

VirtualMachine.Admin.ClusterName

Informs the administrator which cluster contains the compute resource for the machine to use.

Note:

This is an internal output property from the agent that is populated during the data collection process and identifies the cluster in which a machine resides.

VirtualMachine.Admin.ApplicationID

List the application IDs that can be assigned to a machine.

VirtualMachine.Admin.AddOwnerToAdmins

Set to True (default) to add the machine’s owner, as specified by the VirtualMachine.Admin.Owner property, to the local administrators group on the machine.

This property is not available for provisioning by cloning.

VirtualMachine.Admin.AllowLogin

Set to True (default) to add the machine owner to the local remote desktop users group, as specified by the VirtualMachine.Admin.Owner property.

VirtualMachine.Admin.DiskInterfaceType

Indicates the type of disk drivers. The following disk drivers are supported:

  • IDE (default)

  • VirtIO

This property is for virtual provisioning.

VirtualMachine.Admin.ForceHost

Specifies the name of the ESX host. The property is only honored if VirtualMachine.Admin.HostSelectionPolicy is set to EXACT_MATCH.

Note:

This property is for vSphere only.

When provisioning against a vSphere cluster, you can use the VirtualMachine.Admin.ForceHost property to specify the host on which a machine is to be provisioned. This property is used only if DRS is not set to automatic for the cluster. If the cluster has DRS enabled and is set to Automatic, vSphere relocates the provisioned machine when the machine is restarted.

VirtualMachine.Admin.HostSelectionPolicy

Optionally set to EXACT_MATCH to require the machine to be placed on the host specified by the VirtualMachine.Admin.ForceHost property. If the host is unavailable, the request results in a failure. If a host is not specified, the next best available host is selected. If set to EXACT_MATCH, an error occurs if the specified host does not have enough memory or is in maintenance mode.

Note:

This property applies to vSphere only.

VirtualMachine.Admin.ExportProperties

Optionally set to True when using an enhanced clone workflow to specify that the guest agent export the virtual machine's custom properties to the following files in the guest OS:

  • C:\VRMGuestAgent\site\workitem.xml

  • C:\VRMGuestAgent\site\workitem.ini

Guest scripts and utilities can then consume these files.

VirtualMachine.Agent.CopyToDisk

Set to True (default) to copy the guest agent executable file to %System-Drive%\VRM\Build\Bin on the machine’s disk.

VirtualMachine.Agent.GuiRunOnce

Set to True to include guest agent execution in the SysPrep.inf runonce section. Set to False for the Linux agent to stop the provisioning workflow.

VirtualMachine.Agent.Reboot

Set to True (default) to specify that the guest agent restarts the machine following installation of the guest operating system.

VirtualMachine.CDROM.Attach

Set to False to provision the machine without a CD-ROM device. The default is True.

VirtualMachine.CPU.Count

Specifies the number of CPUs, for example 2, allocated to a machine. The default is the value specified by the CPU setting on the blueprint.

Note:

This custom property value is overridden by the CPU value on the blueprint when the machine is first provisioned.

VirtualMachine.Customize.WaitComplete

Set to True to prevent the provisioning workflow from sending work items to the guest agent until all customizations have been completed.

VirtualMachine.DiskN.Letter

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.

VirtualMachine.DiskN.Size

Defines the size in GB of disk N. For example, to give a size of 150 GB to a disk G, define the custom property VirtualMachine.Disk0.Size and enter a value of 150. Disk numbering must be sequential. By default a machine has one disk referred to by VirtualMachine.Disk0.Size, where size is specified by the storage value on the blueprint from which the machine is provisioned. The storage value on the blueprint user interface overwrites the value in the VirtualMachine.Disk0.Size property. The VirtualMachine.Disk0.Size property is not available as a custom property because of its relationship with the storage option on the blueprint. More disks can be added by specifying VirtualMachine.Disk1.Size, VirtualMachine.Disk2.Size and so on. VirtualMachine.Admin.TotalDiskUsage always represents the total of the .DiskN.Size properties plus the VMware.Memory.Reservation size allocation.

VirtualMachine.DiskN.IsFixed

Disables the editing of a specific disk when reconfiguring a machine. Set to True to disable display of the edit capacity option for a specific volume. The True value is case-sensitive. The N value is the 0-based index of the disk.

Alternatively, you can set the VirtualMachine.DiskN.IsFixed custom property to True in the VirtualMachineProperties table in the database or use the Repository API to specify a URI value such as .../Repository/Data/ManagementModelEntities.svc/VirtualMachines(guid'60D93A8A-F541-4CE0-A6C6-78973AC0F1D2')/VirtualMachineProperties.

VirtualMachine.DiskN.Label

Specifies the label for a machine’s disk. The disk label maximum is 32 characters. Disk numbering must be sequential. When used in conjunction with a guest agent, specifies the label of a machine's disk N inside the guest operating system.

VirtualMachine.DiskN.Active

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.

VirtualMachine.DiskN.FS

Specifies the file system of the machine’s disk N. The options are NTFS (default), FAT and FAT32.

VirtualMachine.DiskN.Percent

Specifies the percentage of the disk N to be formatted by a guest agent for the machine’s use. That machine cannot use the remaining portion of the disk.

VirtualMachine.DiskN.StorageReservationPolicy

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 or Cloud reservations, other than vCloud reservations.

VirtualMachine.DiskN.StorageReservationPolicyMode

Allocates disk N to the best available storage reservation policy.

VirtualMachine.DiskN.Storage

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.

VirtualMachine.DiskN.VMwareType

Specifies the VMware disk mode of the machine’s diskN. This property applies to vSphere. The following options are available:

  • persistent

  • independent_persistent

  • independent_nonpersistent

If you set this custom property to independent_persistent or independent_nonpersistent, users must power off their machine before using vRealize Automation to take a snapshot.

Note:

This property applies to vSphere only.

For details, see VirtualDeviceDeviceBackingOption data object help in VMware vSphere Web Services SDK Documentation.

VirtualMachine.Host.TpmEnabled

Limits virtual machine placement to hosts that have a Trust Protection Module (TPM) device installed and recognized by ESX and vSphere. The default value is False.

All hosts in a cluster must have a Trust Protection Module device installed. If no acceptable hosts or clusters are found, the machine cannot be provisioned until this property is removed.

VirtualMachine.Rdp.File

Specifies the RDP file that contains settings to be used when opening an RDP link to the machine. Can be used together with, or as an alternative to, VirtualMachine.Rdp.SettingN. The file must be located in the vRealize Automation server installation directory, for example %SystemDrive%\Program Files x86\VMware\vCAC\Server\Rdp\console.rdp.

You must create the Rdp directory.

VirtualMachine.Memory.Size

Specifies the size of the machine's memory in MB, such as 1024. The default is the value specified by the memory setting on the blueprint.

Note:

This custom property setting is overridden by the memory setting on the blueprint when the machine is first provisioned.

VirtualMachine.EPI.Type

Specifies the type of external provisioning infrastructure.

Set to BMC for BMC BladeLogic integration.

Set to CitrixProvisioning for Citrix provisioning server integration.

VirtualMachine.NetworkN.Address

Specifies the IP address of network device N in a machine provisioned with a static IP address.

VirtualMachine.NetworkN custom properties are designed to be 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.

VirtualMachine.NetworkN.AddressM

Defines additional M IP address allocated for an Openstack instance for network N, excluding the IP address set specified by the VirtualMachine.NetworkN.Address. property. Additional addresses are displayed on the Network tab in the Additional Addresses column.

This property is used by Openstack machine state data collection.

While this property is only data-collected by the OpenStack endpoint, it is not specific to OpenStack and can be used for lifecycle extensibility by other endpoint types.

VirtualMachine.NetworkN.MacAddressType

Indicates whether the MAC address of network device N is generated or user-defined (static). This property is available for cloning.

The default value is generated. If the value is static, you must also use VirtualMachine.NetworkN.MacAddress to specify the MAC address.

VirtualMachine.NetworkN custom properties are designed to be 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.

VirtualMachine.NetworkN.MacAddress

Specifies the MAC address of a network device N. This property is available for cloning.

If the value of VirtualMachine.NetworkN.MacAddressType is generated, this property contains the generated address.

If the value of VirtualMachine.Network.N.MacAddressType is static, this property specifies the MAC address. For virtual machines provisioned on ESX server hosts, the address must be in the range specified by VMware. For details, see vSphere documentation.

VirtualMachine.NetworkN custom properties are designed to be 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.

VirtualMachine.NetworkN.Name

Specifies the name of the network to connect to, for example the network device N to which a machine is attached.

By default, a network is assigned from the network paths available on the reservation on which the machine is provisioned.

You can ensure that a network device is connected to a specific network by setting the value of this property to the name of a network on an available reservation.

VirtualMachine.NetworkN custom properties are designed to be 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.

You can add this property to a vApp (vCloud) blueprint or a vApp (vCloud) Component blueprint.

VirtualMachine.NetworkN.PortID

Specifies the port ID to use for network device N when using a dvPort group with a vSphere distributed switch.

VirtualMachine.NetworkN custom properties are designed to be 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.

VirtualMachine.NetworkN.ProfileName

Specifies the name of a network profile from which to assign a static IP address to network device Nor 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.

If a network profile is specified in the network path in the reservation on which the machine is provisioned, a static IP address is assigned from that network profile. You can ensure that a static IP address is assigned from a specific profile by setting the value of this property to the name of a network profile.

Note that 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.

With WIM-based provisioning for physical machines, you must specify the network profile with the VirtualMachine.NetworkN.ProfileName custom property. You must also specify a value with the VirtualMachine.NetworkN.Name custom property, although vRealize Automation does not use the value.

The following attributes of the network profile are available to enable static IP assignment in a cloning blueprint:

  • VirtualMachine.NetworkN.SubnetMask

  • VirtualMachine.NetworkN.Gateway

  • VirtualMachine.NetworkN.PrimaryDns

  • VirtualMachine.NetworkN.SecondaryDns

  • VirtualMachine.NetworkN.PrimaryWins

  • VirtualMachine.NetworkN.SecondaryWins

  • VirtualMachine.NetworkN.DnsSuffix

  • VirtualMachine.NetworkN.DnsSearchSuffixes

VirtualMachine.NetworkN custom properties are designed to be 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.

  • VirtualMachine.NetworkN.SubnetMask

  • VirtualMachine.NetworkN.Gateway

  • VirtualMachine.NetworkN.PrimaryDns

  • VirtualMachine.NetworkN.SecondaryDns

  • VirtualMachine.NetworkN.PrimaryWins

  • VirtualMachine.NetworkN.SecondaryWins

  • VirtualMachine.NetworkN.DnsSuffix

  • VirtualMachine.NetworkN.DnsSearchSuffixes

Configures attributes of the network profile specified in VirtualMachine.NetworkN.ProfileName.

VirtualMachine.NetworkN custom properties are designed to be 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.

VirtualMachine.Rdp.SettingN

Configures specific RDP settings. N is a unique number used to distinguish one RDP setting from another. For example, to specify the Authentication Level so that no authentication requirement is specified, define the custom property VirtualMachine.Rdp.Setting1 and set the value to authentication level:i:3. Use to open an RDP link to specify settings.

For a list of available settings and correct syntax, see the Microsoft Windows RDP documentation.

VirtualMachine.Request.Layout

Specifies the property layout to be used in the virtual machine request page. The value must match the name of the layout to be used.

VirtualMachine.Reconfigure.DisableHotCpu

Set to True to specify that the reconfigure machine action restarts the specified machine. By default, the reconfigure machine action does not restart the machine.

Performing a hot add of CPU, or memory, or storage causes the reconfigure machine action to fail and to not restart the machine unless the Hot Add setting is enabled in vSphere for the machine or template. You can add VirtualMachine.Reconfigure.DisableHotCpu=true to a vRealize Automation blueprint to force the machine to restart regardless of the vSphere Hot Add setting.

VirtualMachine.SoftwareN.Name

Specifies the descriptive name of a software application 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 usage reporting.

VirtualMachine.SoftwareN.ScriptPath

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 file name.

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.

You can also pass custom property values as parameters to the script by inserting {YourCustomProperty} in the path string. For example, entering the value \\vra-scripts.mycompany.com\scripts\changeIP.bat runs the changeIP.bat script from a shared location, but entering the value \\vra-scripts.mycompany.com\scripts\changeIP.bat {VirtualMachine.Network0.Address} runs the changeIP script but also passes the value of the VirtualMachine.Network0.Address property to the script as a parameter.

Insert {Owner} to pass the machine owner name to the script.

VirtualMachine.ScriptPath.Decrypt

Allows vRealize Automation to obtain an encrypted string that is passed as a properly formatted VirtualMachine.SoftwareN.ScriptPath custom property statement to the gugent command line.

You can provide an encrypted string, such as your password, as a custom property in a command line argument. This allows you to store encrypted information that the guest agent can decrypt and understand as a valid command line argument. For example, the VirtualMachine.Software0.ScriptPath = c:\dosomething.bat password custom property string is not secure as it contains an actual password.

To encrypt the password, you can create a vRealize Automation custom property, for example MyPassword = password, and enable encryption by selecting the available checkbox. The guest agent decrypts the [MyPassword] entry to the value in the custom property MyPassword and executes the script as c:\dosomething.bat password.

  • Create custom property MyPassword = password where password is the value of your actual password. Enable encryption by selecting the available checkbox.

  • Set custom property VirtualMachine.ScriptPath.Decrypt as VirtualMachine.ScriptPath.Decrypt = true.

  • Set custom property VirtualMachine.Software0.ScriptPath as VirtualMachine.Software0.ScriptPath = c:\dosomething.bat [MyPassword].

If you set VirtualMachine.ScriptPath.Decrypt to false, or don't create the VirtualMachine.ScriptPath.Decrypt custom property, then the string inside the square brackets ( [ and ]) is not decrypted.

VirtualMachine.SoftwareN.ISOName

Specifies the path and file name of the ISO file relative to the data store root. The format is /folder_name/subfolder_name/file_name.iso. If a value is not specified, the ISO is not mounted.

VirtualMachine.SoftwareN.ISOLocation

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.

VirtualMachine.SoftwareN.PostInstallDelay

Specifies a time delay value, in TimeSpan string format, to wait before sending the next InstallSoftware work item If a value is not specified, there is no time delay between InstallSoftware work items.

VirtualMachine.SoftwareN.FailsBuild

Optionally set to True to specify that a failure when executing the work item causes the virtual machine build to fail.

VirtualMachine.SoftwareN.NoQuotes

Specifies that expanding the script path does not enclose values that contain spaces in double quotes.

Example 1: When using the following statement in a testprop = test param format:

VirtualMachine.Software0.ScriptPath = C:\path0 {testprop}, VirtualMachine.Software0.NoQuotes = false

Vrm.Software.Command expands to C:\path0 "test param".

Example 2: When using the following statement in a testprop = test param format:

VirtualMachine.Software0.ScriptPath = C:\path0 {testprop}, VirtualMachine.Software0.NoQuotes = true

Vrm.Software.Command expands to C:\path0 test param.

VirtualMachine.Storage.Name

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.

VirtualMachine.Storage.AllocationType

Stores collected groups to a single datastore. A distributed environment stores disks round-robin style.

VirtualMachine.Storage.ReserveMemory

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 vCenter Server endpoints. For multi-machine blueprints, add the property to the component blueprints.

Note:

If you do not specify the VirtualMachine.Storage.ReserveMemory custom property when you create or provision the machine from vRealize Automation, swap space availability is not ensured. If you add the property for an already provisioned machine, and the allocated reservation is full, the storage allocated in the reservation might exceed the actual allocated storage.

VirtualMachine.VDI.Type

Specifies the type of virtual desktop infrastructure.

For XenDesktop provisioning, set to XenDesktop.

VMware.AttributeN.Name

Specifies the name of an attribute in vRealize Orchestrator. For example, it specifies the value of the attribute used in the VMware.AttributeN.Name property. Replace the letter N with a number, starting with 0 and increasing for each attribute to set.

VMware.AttributeN.Value

Specifies the value of the attribute used in the VMware.AttributeN.Name property. Replace the letter N with a number, starting with 0 and increasing for each attribute to set.

VMware.Endpoint.Openstack.IdentityProvider.Version

For 6.2.4 and 6.2.5, specifies the version of Openstack Identity provider (Keystone) to use when authenticating an Openstack endpoint. Configure a value of 3 to authenticate with Keystone version 3 OpenStack Identity Provider. If you use any other value, or do not use this custom property, authentication defaults to Keystone version 2.

VMware.Endpoint.Openstack.Release

Specifies the OpenStack release, for example Havana or Icehouse, when creating an OpenStack endpoint. Required for 6.2.1, 6.2.2, and 6.2.3 OpenStack provisioning. Deprecated as of 6.2.4.

VMware.Hardware.Version

Specifies the VM hardware version to be used for vSphere settings. Supported values are currently vmx-04, vmx-07, vmx-08, vmx-09 and vmx-10. This property is applicable for VM Create and VM Update workflows and is available only for basic workflow blueprints.

VMware.VirtualCenter.OperatingSystem

Specifies the vCenter Server guest operating system version (VirtualMachineGuestOsIdentifier) with which vCenter Server creates the machine. This operating system version must match the operating system version to be installed on the provisioned machine. Administrators can create property groups using one of several property sets, for example, VMware[OS_Version]Properties, that are predefined to include the correct VMware.VirtualCenter.OperatingSystem values. This property is for virtual provisioning.

When this property has a non-Windows value, the Connect Using RDP user interface option is disabled. The property can be used in a virtual, cloud or physical blueprint.

For related information, see the enumeration type VirtualMachineGuestOsIdentifier in vSphere API/SDK Documentation. For a list of currently accepted values, see the VMware vCenter Server™ documentation.

VMware.SCSI.Type

For vApps and vSphere, specifies the SCSI machine type using one of the following case-sensitive values:

  • buslogic

    Use BusLogic emulation for the virtual disk.

  • lsilogic

    Use LSILogic emulation for the virtual disk (default).

  • lsilogicsas

    Use LSILogic SAS 1068 emulation for the virtual disk.

  • pvscsi

    Use para-virtualization emulation for the virtual disk.

  • none

    Use if a SCSI controller does not exist for this machine.

VMware.SCSI.Sharing

Specifies the sharing mode of the machine’s VMware SCSI bus. Possible values are based on the VirtualSCSISharing ENUM value and include noSharing, physicalSharing, and virtualSharing.

VMware.Memory.Reservation

Specifies the size of the machine’s swap file, for example 1024.

VMware.Network.Type

Specifies a network adapter type.

The following adapter type values are available:

  • Flexible (default )

  • VirtualPCNet32 (not compatible with vSphere).

  • E1000 or VirtualE1000

  • VMXNET or VirtualVMXNET

  • VMXNET2

  • VMXNET3

Set to E1000 when provisioning Windows 32-bit virtual machines on ESX server hosts to ensure that machines are created with the correct network adapter. This property is not used for physical provisioning.

VMware.VCenterOrchestrator.EndpointName

Overrides a specified endpoint setting or specifies that a particular endpoint be used during the vRealize Automation IaaS provisioning process. The value of this property can be set to an applicable vRealize Orchestrator endpoint, such as external VRO, available in the environment.

VMware.VirtualCenter.Folder

Specifies the name of the inventory folder in the datacenter in which to put the virtual machine. The default is VRM, which is also the vSphere folder in which vRealize Automation places provisioned machines if the property is not used. This value can be a path with multiple folders, for example production\email servers. A proxy agent creates the specified folder in vSphere if the folder does not exist. Folder names area case sensitive. This property is available for virtual provisioning.

VDI.Server.Website

Specifies the server name of the Citrix Web interface site to use in connecting to the machine. If the value of VDI.Server.Name is a XenDesktop farm, this property must have an appropriate value or the machine owner cannot connect to the machine using XenDesktop. If this property is not specified, the VDI.Server.Name property determines the desktop delivery controller to connect to, which must be the name of a server that hosts a desktop delivery controller.

Note:

If the Citrix Web Interface (WI) has been replaced with StoreFront (SF), you can use this property instead of VDI.Server.Name to connect to the XenDesktop server. An example value is VDI.Server.Website=sqa-xddc-7.sqa.local/Citrix/StoreWeb. See VDI.Server.Name for more information.

VDI.Server.Name

Specifies the server name, which hosts the desktop delivery controller, to register with, or the name of a XenDesktop farm that contains desktop delivery controllers with which to register.

If the value is a XenDesktop farm name, the VDI.Server.Website property value must be the URL of an appropriate Citrix web interface site to use in connecting to the machine.

If the value is a server name, and at least one general XenDesktop VDI agent was installed without specifying a desktop delivery controller server, this value directs the request to the desired server. If the value is a server name, and only dedicated XenDesktop VDI agents for specific DDC servers were installed, this value must exactly match the server name configured for a dedicated agent.

Note:

For more information about how to make StoreFront the default page in IIS, see Citrix documentation. See also VDI.Server.Website.

Note:

Changes in the Citrix web interface protocol have impacted how the VDI.Server.Name default value is recognized. The value of the VDI.Server.Name property is used as the default connection string to open the Citrix web interface when users connect to a virtual desktop. It is always the DNS/IP of the XD server. If that value does not connect to the Citrix interface, you is unable to access your VMs. However, you can use the VDI.Server.Website custom property when the Citrix web interface is hosted on a server other than the XenDesktop server. When this property is present on the VM, it is used instead of VDI.Server.Name.

VDI.Server.Group

For XenDesktop 5, specifies the name of the XenDesktop group to add machines to and the name of the catalog to which the group belongs, in the group_name;catalog_name format.

For XenDesktop 4, specifies the name of the XenDesktop group to which machines are to be added. XenDesktop 4 preassigned groups are supported.

VDI.ActiveDirectory.Interval

Specifies an optional interval value in time span format for virtual desktop infrastructure machine Active Directory registration check. The default value is 00:00:15 (15 seconds).

VDI.ActiveDirectory.Timeout

Specifies an optional timeout value to wait before retrying Active Directory registration. The default value is 00:00:15 (30 minutes).

VDI.ActiveDirectory.Delay

Specifies an optional delay time value in time span format between successfully adding a machine to Active Directory and initiation of XenDesktop registration. The default value is 00:00:05 (5 seconds).

VRM.DataCenter.Policy

Specifies whether provisioning must use a compute resource associated with a particular location, or if any location is suitable. To enable this feature you must add data center to a location file. Associate each compute resource with a location.

Set to Exact to provision a requested machine on a compute resource associated with the location specified on the blueprint. If a compute resource with sufficient capacity and associated with that location is not available, then provisioning fails.

Set to NonExact (default) to provision a requested machine on a compute resource with sufficient capacity and associated with the location specified on the blueprint. If that compute resource is not available, then use the next available compute resource with sufficient capacity without regard to location.

VRM.Software.IdNNNN

This row is specific to BMC BladeLogic.

Specifies a software job or policy to be applied to all machines provisioned from the blueprint. Set the value to job_type=job_path, where job_type is the numeral that represents the BMC BladeLogic job type and job_path is the location of the job in BMC BladeLogic, for example 4=/Utility/putty. NNNN is a number from 1000 to 1999.

1 — AuditJob
2 — BatchJob
3 — ComplianceJob
4 — DeployJob
5 — FileDeployJob
6 — NSHScriptJob
7 — PatchAnalysisJob
8 — SnapshotJob

VRM.Software.IdNNNN

This row is specific to HP Server Automation.

(Optional) Specifies an HP Server Automation policy to be applied to all machines provisioned from the blueprint. NNNN is a number from 1000 to 1999.