Custom Properties Reference vRealize Automation 7.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see http://www.vmware.com/support/pubs.
Custom Properties Reference You can find the most up-to-date technical documentation on the VMware Web site at: http://www.vmware.com/support/ The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to: docfeedback@vmware.com Copyright © 2008–2016 VMware, Inc. All rights reserved. Copyright and trademark information. VMware, Inc. 3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com 2 VMware, Inc.
Contents Custom Properties Reference 5 Updated Information 7 1 Using Custom Properties 9 Adding Custom Properties 9 Using Properties in Machine Provisioning 10 Understanding Custom Properties Precedence 10 Custom Property Types 12 2 Custom Properties Grouped by Function 13 Custom Properties for Blueprints and Deployments 15 Custom Properties for Naming and Analyzing Deployments 16 Custom Properties for Openstack Endpoints 17 Custom Properties for Clone Blueprints 18 Custom Properties for Linked Clone B
Custom Properties Reference Custom Properties V Table 63 Custom Properties X Table 83 4 Using the Property Dictionary 85 Using Property Definitions 85 Create and Test Custom Property Definitions 86 Configuration Details for the vRealize Orchestrator Action Custom Property Definitions Using Property Groups 103 Create a Property Group 104 Index 4 98 105 VMware, Inc.
Custom Properties Reference Custom Properties Reference provides information about the custom properties, and their use, that are available when you use VMware vRealize ™ Automation. This documentation is intended to be used with the vRealize Automation product documentation available from the VMware vRealize ™ Automation Documentation page at https://www.vmware.com/support/pubs/vcac-pubs.html. Note Not all features and capabilities of vRealize Automation are available in all editions.
Custom Properties Reference 6 VMware, Inc.
Updated Information This Custom Properties Reference is updated with each release of the product or when necessary. This table provides the update history of the Custom Properties Reference. Revision Description 002102-01 n Updated information about optional settings in “Create a Property Group,” on page 104. n Updated information about the _deploymentName property in “Custom Properties Underscore (_) Table,” on page 50. 002102 VMware, Inc. Initial 7.1 release.
Custom Properties Reference 8 VMware, Inc.
Using Custom Properties 1 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.
Custom Properties Reference A custom property can optionally require that the user specify a property value when they create a machine request. Property values are typically case-sensitive. You can add supplied custom properties and also create and add your own properties and property groups. For information about creating properties and property groups, see Chapter 4, “Using the Property Dictionary,” on page 85.
Chapter 1 Using Custom Properties 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.
Custom Properties Reference 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.
Custom Properties Grouped by Function 2 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 Chapter 3, “Custom Properties Grouped by Name,” on page 49. n Custom Properties for Blueprints and Deployments on page 15 vRealize Automation provides a number of custom properties that are generally applicable to all or most blueprints and deployments.
Custom Properties Reference n Custom Properties for WIM Blueprints on page 30 vRealize Automation includes custom properties that provide additional controls for WIM blueprints. n Custom Properties for vCloud Air and vCloud Director Blueprints on page 32 You can add certain custom properties to a vCloud Air or vCloud Director machine component definition in a blueprint.
Chapter 2 Custom Properties Grouped by Function Custom Properties for Blueprints and Deployments vRealize Automation provides a number of custom properties that are generally applicable to all or most blueprints and deployments. You can set many of these properties in the vRealize Automation user interface without using custom properties. Table 2‑1.
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 2‑2.
Chapter 2 Custom Properties Grouped by Function 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 2‑3. Custom Properties for Openstack Endpoints Custom Property Description 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.
Custom Properties Reference Custom Properties for Clone Blueprints vRealize Automation includes custom properties that you can use to provide additional controls for clone blueprints. Table 2‑4. Custom Properties for Clone Blueprints Custom Property Description 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑4. Custom Properties for Clone Blueprints (Continued) Custom Property Description 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.
Custom Properties Reference Table 2‑5. Custom Properties for Customizing Cloned Machines with a Guest Agent (Continued) 20 Custom Property Description 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑5. Custom Properties for Customizing Cloned Machines with a Guest Agent (Continued) Custom Property Description 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 filename. You can pass custom property values as parameters to the script by inserting {CustomPropertyName} in the path string.
Custom Properties Reference Table 2‑6. Custom Properties for Linked Clone Blueprints (Continued) 22 Custom Property Description 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑6. Custom Properties for Linked Clone Blueprints (Continued) Custom Property Description Linux.ExternalScript.Server Specifies the name of the NFS server, for example labad.lab.local, on which the Linux external customization script named in Linux.ExternalScript.Name is located. Linux.ExternalScript.Path Specifies the local path to the Linux customization script or the export path to the Linux customization on the NFS server.
Custom Properties Reference Custom Properties for FlexClone Blueprints vRealize Automation includes custom properties that you can use to provide additional controls for FlexClone blueprints. Table 2‑8. Custom Properties for FlexClone Blueprints Custom Property Description VirtualMachine.NetworkN.
Chapter 2 Custom Properties Grouped by Function Table 2‑8. Custom Properties for FlexClone Blueprints (Continued) Custom Property Description Linux.ExternalScript.LocationType 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. Linux.ExternalScript.
Custom Properties Reference Table 2‑9. Custom Properties for Customizing FlexClone Machines with a Guest Agent (Continued) Custom Property Description 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑10. Custom Properties for Basic Workflow Blueprints (Continued) Custom Property Description VirtualMachine.Storage.AllocationType Stores collected groups to a single datastore. A distributed environment stores disks round-robin style. 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.
Custom Properties Reference Table 2‑11. Required Custom Properties for Linux Kickstart Blueprints (Continued) Custom Property Description Image.ISO.Name Values for this property are case sensitive. Specifies the name of the ISO image from which to boot, for example /ISO/Microsoft/WinPE.iso. The format of this value depends on your platform. For details, see documentation provided for your platform.
Chapter 2 Custom Properties Grouped by Function Table 2‑13. Required Custom Properties for SCCM Blueprints Custom Property Description Image.ISO.Location Values for this property are case sensitive. Specifies the location of the ISO image from which to boot, for example http://192.168.2.100/site2/winpe.iso. The format of this value depends on your platform. For details, see documentation provided for your platform.
Custom Properties Reference Custom Properties for WIM Blueprints vRealize Automation includes custom properties that provide additional controls for WIM blueprints. Certain vRealize Automation custom properties are required for WIM blueprints. Table 2‑15. Required Custom Properties for WIM Blueprints 30 Custom Property Description Image.ISO.Location Values for this property are case sensitive. Specifies the location of the ISO image from which to boot, for example http://192.168.2.100/site2/winpe.iso.
Chapter 2 Custom Properties Grouped by Function Table 2‑15. Required Custom Properties for WIM Blueprints (Continued) Custom Property Description VirtualMachine.Admin.Owner Specifies the user name of the machine owner. VMware.VirtualCenter.OperatingSystem Specifies the vCenter Server guest operating system version (VirtualMachineGuestOsIdentifier) with which vCenter Server creates the machine.
Custom Properties Reference Table 2‑16. Common Custom Properties for WIM Blueprints (Continued) Custom Property Description Sysprep.Identification.JoinDomain Specifies the name of the domain to join in Active Directory. Sysprep.Identification.JoinWorkgroup Specifies the name of the workgroup to join if not using a domain. SysPrep.UserData.ComputerName Specifies a machine name, for example lab-client005. SysPrep.UserData.FullName Specifies the full name of a user. SysPrep.UserData.
Chapter 2 Custom Properties Grouped by Function Table 2‑17. Custom Properties for vCloud Air and vCloud Director Machine Components in the Blueprint Canvas (Continued) Custom Property Description 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.
Custom Properties Reference Table 2‑17. Custom Properties for vCloud Air and vCloud Director Machine Components in the Blueprint Canvas (Continued) 34 Custom Property Description 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑17. Custom Properties for vCloud Air and vCloud Director Machine Components in the Blueprint Canvas (Continued) Custom Property Description 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. The VMware.SCSI.Sharing property is not available for use with the CloneWorkflow provisioning workflow.
Custom Properties Reference By default, a machine has one network device configured with the VirtualMachine.Network0.Name property. You can configure additional network devices by using the VirtualMachine.NetworkN.Name custom property, where N is the network number. Note Network-specific custom properties that point to on-demand networks not supported. For example, you cannot use network custom properties, such as VirtualMachine.Network0.
Chapter 2 Custom Properties Grouped by Function Table 2‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description VirtualMachine.NetworkN.Name Specifies the name of the network to connect to, for example the network device N to which a machine is attached. This is equivalent to a network interface card (NIC). By default, a network is assigned from the network paths available on the reservation on which the machine is provisioned. Also see VirtualMachine.NetworkN.
Custom Properties Reference Table 2‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description VirtualMachine.NetworkN.ProfileName 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. When you use the VirtualMachine.NetworkN.
Chapter 2 Custom Properties Grouped by Function Table 2‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description 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.
Custom Properties Reference 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑21. Custom Properties for PXE and WIM Provisioning Custom Property Description Image.Network.Letter Specifies the drive letter to which the WIM image path is mapped on the provisioned machine. The default value is K. Image.WIM.Path Specifies the UNC path to the WIM file from which an image is extracted during WIM-based provisioning. The path format is \\server\share$ format, for example \\labad\dfs$. Image.WIM.
Custom Properties Reference Table 2‑21. Custom Properties for PXE and WIM Provisioning (Continued) Custom Property Description Sysprep.Identification.JoinDomain Specifies the name of the domain to join in Active Directory. Sysprep.Identification.JoinWorkgroup Specifies the name of the workgroup to join if not using a domain. SysPrep.UserData.ComputerName Specifies a machine name, for example lab-client005. SysPrep.UserData.FullName Specifies the full name of a user. SysPrep.UserData.
Chapter 2 Custom Properties Grouped by Function Table 2‑22. Custom Properties for Customizing Provisioned Machines with a Guest Agent (Continued) Custom Property Description VirtualMachine.DiskN.Label 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. VirtualMachine.DiskN.
Custom Properties Reference Table 2‑22. Custom Properties for Customizing Provisioned Machines with a Guest Agent (Continued) Custom Property Description 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑23. Custom Properties Required for BMC BladeLogic Configuration Manager Integrations (Continued) Custom Property Description BMC.Software.Install Set to True to enable BMC BladeLogic Configuration Manager integration. EPI.Server.Name Specifies the name of the external provisioning infrastructure server, for example, the name of the server hosting BMC BladeLogic.
Custom Properties Reference Table 2‑24. Custom Properties to Make Software Jobs Available Custom Property Description LoadSoftware Set to True to enable software install options. Vrm.Software.IdNNNN 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑26. Required Custom Properties for HP Server Automation Integration Property Definition 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.
Custom Properties Reference Table 2‑26. Required Custom Properties for HP Server Automation Integration (Continued) Property Definition Linux.ExternalScript.LocationType Specifies the location type of the customization script named in the Linux.ExternalScript.Name property. This can be either local or nfs. Linux.ExternalScript.Path Specifies the local path to the Linux customization script or the export path to the Linux customization on the NFS server.
Custom Properties Grouped by Name 3 You can use custom properties to provide additional vRealize Automation controls. Custom properties have been grouped here by name. To explore custom properties grouped by function, see Chapter 2, “Custom Properties Grouped by Function,” on page 13.
Custom Properties Reference Custom Properties Underscore (_) Table This section lists vRealize Automation custom properties that begin with an underscore (_). Table 3‑1. Custom Properties Underscore (_) Table 50 Property Description _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.
Chapter 3 Custom Properties Grouped by Name Custom Properties A Table This section lists vRealize Automation custom properties that begin with the letter A. Table 3‑2. Custom Properties A Table Property Description AD.Lookup.Department Specifies the cost center value that is included in a notification email sent to approvers. This property value must be specified in the blueprint. amazon.AmazonEC2Config.ServiceURL Specifies the Amazon configuration service URL for Amazon GovCloud, for example amazon.
Custom Properties Reference Custom Properties C Table This section lists vRealize Automation custom properties that begin with the letter C. Table 3‑4. Custom Properties C Table Property Definition Cisco.Organization.Dn Specifies the distinguished name of the Cisco UCS Manager organization in which Cisco UCS machines provisioned by the business group are placed, for example org-root/org-Engineering.
Chapter 3 Custom Properties Grouped by Name Table 3‑5. Custom Properties E Table (Continued) Property Definition EPI.Server.Port Specifies the port on which to contact the provisioning server. If you are using a Citrix provisioning server, omit to specify the default port value of 54321. EPI.Server.Site Specifies the name of the Citrix provisioning site that contains the collection and store identified by the EPI.Server.Collection and EPI.Server.Store properties, for example site1. EPI.Server.
Custom Properties Reference Table 3‑5. Custom Properties E Table (Continued) Property Definition ext.policy.activedirectory.system .machineName System property for the name of the machine in Active Directory. If you modify this property, which is used by the defined policies, you can disable the policy. Use ext.policy.activedirectory.machineName to override the policy value. ext.policy.activedirectory.system .
Chapter 3 Custom Properties Grouped by Name Custom Properties I Table This section lists vRealize Automation custom properties that begin with the letter I. Table 3‑7. Custom Properties I Table Property Definition Image.ISO.Location Values for this property are case sensitive. Specifies the location of the ISO image from which to boot, for example http://192.168.2.100/site2/winpe.iso. The format of this value depends on your platform. For details, see documentation provided for your platform.
Custom Properties Reference Table 3‑7. Custom Properties I Table (Continued) Property Definition Infrastructure.Admin.ADPassword Specifies the password associated with the Infrastructure.Admin.ADUser domain administrator user ID. Infrastructure.Admin.DefaultDom ain Specifies the default domain on the machine. Infrastructure.ResourcePool.Nam e Specifies the resource pool to which the machine belongs, if any. The default is the value specified in the reservation from which the machine was provisioned.
Chapter 3 Custom Properties Grouped by Name Custom Properties M Table This section lists vRealize Automation custom properties that begin with the letter M. Table 3‑9. Custom Properties M Table Property Description MaximumProvisionedMachines Specifies the maximum number of linked clones for one machine snapshot. The default is unlimited. Machine.SSH Set to True to enable the Connect Using SSH option on the vRealize Automation Items page for Linux machines provisioned from this blueprint.
Custom Properties Reference Table 3‑10. Custom Properties O Table (Continued) Property Description Opsware.Server.Name Specifies the fully qualified name of the HP Server Automation server. Opsware.Server.Username Specifies the user name provided when a password file in the agent directory was created, for example opswareadmin. This user name requires administrative access to the HP Server Automation instance. Opsware.Software.Install Set to True to allow HP Server Automation to install software.
Chapter 3 Custom Properties Grouped by Name Custom Properties R Table This section lists vRealize Automation custom properties that begin with the letter R. Table 3‑12. Custom Properties R Table Property Description ReservationPolicyID Specifies the reservation policy name. RDP.File.Name Specifies an RDP file from which to obtain settings, for example My_RDP_Settings.rdp. The file must reside in the Website\Rdp subdirectory of the vRealize Automation installation directory.
Custom Properties Reference Table 3‑13. Custom Properties S Table (Continued) 60 Property Description Sysprep.Identification.JoinDomain Specifies the name of the domain to join in Active Directory. Sysprep.Identification.JoinWorkgroup Specifies the name of the workgroup to join if not using a domain. SysPrep.UserData.ComputerName Specifies a machine name, for example labclient005. SysPrep.UserData.FullName Specifies the full name of a user. SysPrep.UserData.
Chapter 3 Custom Properties Grouped by Name Table 3‑13. Custom Properties S Table (Continued) Property Description Snapshot.Policy.Disable When set to true, the ability to create a snapshot is disabled for all vRealize Automation user roles and the snapshot option is hidden from the Items tab. software.http.proxyHost Specifies the host name, or address, of the proxy server. For software content properties to use the proxy server, you must use both software.http.proxyHost and software.http.proxyPort.
Custom Properties Reference Table 3‑13. Custom Properties S Table (Continued) Property Description software.http.proxyUser Specifies the user name with which to authenticate to the proxy server. Use in combination with software.http.proxyPassword. The software.http.proxyUser setting is optional. The software.http.proxyPassword setting is required if you use the software.http.proxyUser setting. Note You can use the software proxy settings to define a content property type value for a software component.
Chapter 3 Custom Properties Grouped by Name Custom Properties V Table This section lists vRealize Automation custom properties that begin with the letter V. Table 3‑14. Custom Properties V Table 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description VCloud.Template.MakeIdenticalCopy Set to true to clone an identical copy of the vCloud Air or vCloud Director template for machine provisioning. The machine is provisioned as an identical copy of the template. Settings specified in the template, including storage path, supersede settings specified in the blueprint.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description VirtualMachine.Admin.AgentID Specifies the UUID of the guest agent. The guest agent recorsd the value when the machine is created. The value 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) 68 Property Description VirtualMachine.Admin.DiskInterfaceType Indicates the type of disk drivers. The following disk drivers are supported: n IDE (default) n VirtIO This property is for virtual provisioning. VirtualMachine.Admin.EagerZero When set to true, specifies that the machine disks are provisioned using the VMware provisioning format of eager zero.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description VirtualMachine.Customize.WaitComplete Set to True to prevent the provisioning workflow from sending work items to the guest agent until all customizations are complete. VirtualMachine.Core.Count If set to a value greater than zero, specifies the number of cores per socket when provisioning the virtual machine.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description VirtualMachine.DiskN.Label 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. VirtualMachine.DiskN.Active Set to True (default) to specify that the machine's disk N is active.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description VirtualMachine.DiskN.VMwareType Specifies the VMware disk mode of the machine’s diskN. The following options are available: n persistent n independent_persistent n 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description VirtualMachine.NetworkN.AdditionAddressM 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. More addresses are displayed on the Network tab in the Additional Addresses column. This property is used by Openstack machine state data collection.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description 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.NetworkN.MacAddressType is static, this property specifies the MAC address.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description VirtualMachine.NetworkN.ProfileName 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. When you use the VirtualMachine.NetworkN.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property n n n n n n n n 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.Rdp.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) 76 Property Description VirtualMachine.SoftwareN.Name Specifies the descriptive name of a software application N or script to install or run during provisioning. This is an optional and informationonly 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.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description VirtualMachine.Storage.Cluster.Automation.Behavior Specifies an SDRS behavior type when VirtualMachine.Storage.Cluster.Automation. Enabled is set to True. The available behavior type values are automated or manual. The VirtualMachine.Storage.Cluster.Automation. Enabled and VirtualMachine.Storage.Cluster.Automation.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description 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. If you specify the CloneWorkflow provisioning workflow when configuring your machine component in the blueprint design canvas, the VMware.SCSI.Sharing property is not available. The VMware.SCSI.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
Chapter 3 Custom Properties Grouped by Name Custom Properties X Table This section lists vRealize Automation custom properties that begin with the letter X. Table 3‑15. Custom Properties X Table Property Description Xen.Platform.Viridian For virtual provisioning, set to False when you provision Windows virtual machines on a XenServer host or pool. The default is True. This property is not used in physical provisioning. VMware, Inc.
Custom Properties Reference 84 VMware, Inc.
Using the Property Dictionary 4 You can use the property dictionary to define new custom property definitions and property groups. You define a property to support a specific data type and a display control style within that data type. You can also create reusable property groups to simplify adding multiple properties.
Custom Properties Reference 4 As a machine requestor, specify required values as prompted. You can also populate the property value in a drop-down menu by using vRealize Orchestrator script actions. Using vRealize Orchestrator script actions also enables you to populate a drop-down menu value based on the values specified for another property.
Chapter 4 Using the Property Dictionary Create Custom Property Definitions You create custom property definitions that determine how the custom property appears in vRealize Automation. You can validate the custom property in a test blueprint before adding it to your production blueprints. n Create a Property Definition on page 87 You can create property definitions to allow for additional levels of vRealize Automation customization.
Custom Properties Reference 4 Accept the generated value in the Label text box. The Label value is automatically populated with the value that you entered in the Name text box. If you enter a Label value first, the Name text box is populated with the same value. The Label value is displayed in the user interface when requesting properties, for example when adding a property to a blueprint, as the property name. The Label value can contain a wider range of characters than the Name value.
Chapter 4 Using the Property Dictionary 10 If the Minimum value option is available, specify a minimum value. 11 Select a display control type for this property in the Display as drop-down menu. Available options are derived from your Data type selection. Table 4‑2. Property Definition Display as Options 12 Display as Option Description CheckBox Provides a single check box control.
Custom Properties Reference 3 Enter the options. Option Description Name Enter a value using a standard naming convention for the new property name such as my_grouping_prefix.my_property_name. Label The label is populated based on the name. You can change the label to provide a more readable name. Visibility The action custom properties are only available in the current tenant. To make them available in another tenant, you must configure them when you are logged in to that tenant.
Chapter 4 Using the Property Dictionary 3 4 Enter the options. Option Description Name Consult the configuration details. Some of the custom properties require specific names or formats. Where you can, use a standard naming convention for the new property name such as my_grouping_prefix.my_property_name. Label The label is populated based on the name. You can change the label to provide a more readable name. Visibility The action custom properties are only available in the current tenant.
Custom Properties Reference For example, your development team works on production and non-production systems. You also have five data centers. Three of the data centers are your development testing data centers and the other two are where you provide services to your internal clients. To ensure that developers can deploy the same blueprint to either environment, the testing or the internal clients data centers, you create and bind two custom property definition.
Chapter 4 Using the Property Dictionary Procedure 1 Create a custom property definition so that users can select production or non-production environment. a Select Administration > Property Dictionary > Property Definitions. b Configure the custom property options. Option Example Values Name production.ready Label Environment Description Select the production or non-production environment. Display order 1 You select 1 to ensure that this custom property appears first in the blueprint.
Custom Properties Reference 2 Create a vRealize Orchestrator action custom property definition that runs your custom location action. a Select Administration > Property Dictionary > Property Definitions. b Configure the custom property options. Option Example Values Name datacenter Label Target data center Description Select the datacenter base on whether you are deploying a production or non-production blueprint.
Chapter 4 Using the Property Dictionary Add a Custom Property to a Blueprint You can add custom properties to many parts of vRealize Automation, including approval policies, business groups, endpoints, and reservation policies. However, only the machine blueprints support the display options that you configure as property definitions. Adding a custom property to a blueprint as a simple way to verify that the custom property appears in the user interface as you designed it in the property definition.
Custom Properties Reference n 5 Option Description Encrypted When adding custom properties that run vRealize Orchestrator actions, do not encrypt the value. Overridable Select this option to ensure that the requesting user can select a value on the request form. Show in request Select this option to ensure that the requesting user can see the property and select a value on the request form. To add a property group, click Add and select the group. Click OK.
Chapter 4 Using the Property Dictionary 8 9 Select the network custom property and configure the options. Option Description Name You cannot change the property name. Value (Optional) Enter a default value. Encrypted When adding custom properties that run vRealize Orchestrator actions, do not encrypt the value. Overridable Select this option to ensure that the requesting user can select a value on the request form.
Custom Properties Reference Configuration Details for the vRealize Orchestrator Action Custom Property Definitions You create custom property definitions that run vRealize Orchestrator actions to retrieve key value pairs from external files or from vRealize Automation configuration information. You add the custom properties to blueprints so that they appear in the catalog request forms. The service catalog user requesting the item can select a value to include in the deployment.
Chapter 4 Using the Property Dictionary Prerequisites None. Custom Property Configuration Values You use these options to create the custom property. For the general steps, see “Create a vRealize Orchestrator Action Custom Property Definition,” on page 90. Table 4‑3. Network Custom Property Configuration Values Option Value Name You must use VirtualMachine.network0.Name. Data type String Display as Dropdown Values External Action folder com.vmware.vra.
Custom Properties Reference Table 4‑4. Reservation Policy Custom Property Configuration Values Option Value Name You must use ReservationPolicyID. Data type String Display as Dropdown Values External Action folder com.vmware.vra.reservations Script action getApplicableReservationPolicies This script action is an example script. You can create specific actions for your environment. Input parameters No required parameters.
Chapter 4 Using the Property Dictionary Table 4‑5. PowerShell Script Custom Property Configuration Values (Continued) Option Value Script action Select an action based on where the PowerShell script is located. n If the PowerShell script is on a central server, use executeExternalPowerShellScriptOnHostByName. n If the PowerShell script is uploaded into vRealize Orchestrator, use executePowershellScriptFromResourceOnHostByName . These script actions are example scripts.
Custom Properties Reference Prerequisites Verify that the vRealize Orchestrator SQL Plug-In is installed and configured to connect to the target database. Custom Property Configuration Values You use these options to create the custom property. For the general steps, see “Create a vRealize Orchestrator Action Custom Property Definition,” on page 90. Table 4‑6. Database Query Custom Property Configuration Values Option Value Name You can use any string.
Chapter 4 Using the Property Dictionary Table 4‑7. Custom Action Custom Property Configuration Values Option Value Name You can use any string. Data type Decimal, Integer, or String Display as Dropdown Values External Action folder Location of your custom action. Script action Name of your custom action. Input parameters Depends on your custom action. Blueprint Configuration Usually you add the custom property on the blueprint Properties tab.
Custom Properties Reference You can use the vra content list --type property-definition vRealize CloudClient command to list all property definitions in the current vRealize Automation instance tenant. You can also use the vra content list --type property-group vRealize CloudClient command to list all property groups. You can add some or all of the property definitions and property groups to a package and export the package to a zip file.
Index A add, property definition 86, 87 Amazon, available custom properties 51 B binding properties 91 property definitions 91 blueprint add custom property 95, 96 add network custom property 96 test custom property 95, 96 blueprints, custom properties 15, 44 C custom 10 custom properties, a properties 51 custom properties binding 91 blueprints 15 creating property groups 104 custom property types 12 debugging provisioning problems 16 defining new properties 85 for FlexClone blueprints 24 for basic workf
Custom Properties Reference O Openstack, custom properties for endpoints 17 P PowerShell script, property definition 100 properties encrypted 104 overrideable 104 show in request 104 property definition add 86, 87 binding 91 custom vRealize Orchestrator action 102 database query 101 network 98 PowerShell script 100 regular expression 89 reservation policy 99 vRealize Orchestrator action 90 property definitions, test in blueprint 95, 96 property dictionary, creating a property definition 87 property groups
