Custom Properties Reference vRealize Automation 7.2 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–2017 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 66 Custom Properties X Table 86 4 Using the Property Dictionary 87 Using Property Definitions 87 Create and Test Custom Property Definitions 88 Configuration Details for the vRealize Orchestrator Action Custom Property Definitions Using Property Groups 106 Create a Property Group 107 Index 4 101 109 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 EN-002291-02 Corrected custom property name Vrm.DataCenter.Location in “Custom Properties V Table,” on page 66. EN-002291-01 Removed VirtualMachine.DiskN.VMwareType custom property from “Custom Properties V Table,” on page 66. EN-002291-00 Initial release. VMware, Inc.
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 87.
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 51. 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 Design 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 Design 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 Design 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 For machine components that do not have a Network or Security tab, you can add network and security custom properties, such as VirtualMachine.Network0.Name, to their Properties tab in the design canvas. NSX network, security, and load balancer properties are only applicable to vSphere machines. Note Network-specific custom properties that point to on-demand networks are 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.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.
Custom Properties Reference Table 2‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description 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 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑18. Custom Properties for Networking Configuration (Continued) Custom 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 VCNS.LoadBalancerEdgePool.Names.
Custom Properties Reference Table 2‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description VCNS.SecurityGroup.Names.name Specifies the NSX 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.
Chapter 2 Custom Properties Grouped by Function Table 2‑20. Custom Properties for PXE and SCCM Provisioning Custom Property Description SCCM.Collection.Name Specifies the name of the SCCM collection that contains the operating system deployment task sequence. SCCM.Server.Name Specifies the fully qualified domain name of the SCCM server on which the collection resides, for example labsccm.lab.local. SCCM.Server.SiteCode Specifies the site code of the SCCM server. SCCM.Server.
Custom Properties Reference Table 2‑21. Custom Properties for PXE and WIM Provisioning (Continued) Custom Property Description SysPrep.Section.Key Specifies information to be added to the SysPrep answer file on machines during the WinPE stage of provisioning. Information that already exists in the SysPrep answer file is overwritten by these custom properties. Section represents the name of the section of the SysPrep answer file, for example GuiUnattended or UserData.
Chapter 2 Custom Properties Grouped by Function 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. Table 2‑22. Custom Properties for Customizing Provisioned Machines with a Guest Agent Custom Property Description VirtualMachine.Admin.
Custom Properties Reference Table 2‑22. Custom Properties for Customizing Provisioned Machines with a Guest Agent (Continued) 44 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‑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.
Custom Properties Reference 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.
Chapter 2 Custom Properties Grouped by Function 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.
Custom Properties Reference Table 2‑26. Required Custom Properties for HP Server Automation Integration 48 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.
Chapter 2 Custom Properties Grouped by Function 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 Reference 50 VMware, Inc.
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 52 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. agent.download.
Custom Properties Reference Custom Properties B Table This section lists vRealize Automation custom properties that begin with the letter B. Table 3‑3. Custom Properties B Table Property Definition BMC.AddServer.Delay Specifies the number of seconds to wait before adding the machine to BMC BladeLogic Configuration Manager. The default is 30. BMC.AddServer.
Chapter 3 Custom Properties Grouped by Name Table 3‑4. Custom Properties C Table (Continued) Property Definition containers.ipam.driver For use with containers only. Specifies the IPAM driver to be used when adding a Containers network component to a blueprint. The supported values depend on the drivers that are installed in the container host environment in which they are used.
Custom Properties Reference Custom Properties E Table This section lists vRealize Automation custom properties that begin with the letter E. Table 3‑5. Custom Properties E Table Property Definition EPI.Server.Collection Specifies the name of the Citrix provisioning collection to which the machine is to be registered. EPI.Server.Name Specifies the name of the external provisioning infrastructure server, for example, the name of the server hosting BMC BladeLogic.
Chapter 3 Custom Properties Grouped by Name Table 3‑5. Custom Properties E Table (Continued) Property Definition ext.policy.activedirectory.id The organizational unit that you want to use rather than the organizational unit in the current Active Directory policy. Overrides ext.policy.activedirectory.system.id value that is specified in the Active Directory policy. ext.policy.activedirectory.
Custom Properties Reference Custom Properties I Table This section lists vRealize Automation custom properties that begin with the letter I. Table 3‑7. Custom Properties I Table 58 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.
Chapter 3 Custom Properties Grouped by Name 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.
Custom Properties Reference 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.
Chapter 3 Custom Properties Grouped by Name 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.
Custom Properties Reference 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 ID, not the reservation policy name. For example, the name that is returned by the vRealize Orchestrator property getApplicableReservationPolicies is the reservation policy name, not the reservation policy ID. RDP.File.
Chapter 3 Custom Properties Grouped by Name Table 3‑13. Custom Properties S Table (Continued) Property Description Sysprep.Identification.DomainAdminPassword Specifies the password to associate with the Sysprep.Identification.DomainAdmin property. 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.
Custom Properties Reference Table 3‑13. Custom Properties S Table (Continued) Property Description Snapshot.Policy.Limit Sets the number of snapshots allowed per machine. The default setting is one snapshot per machine. This property applies to vSphere provisioning. When set to 0, the blueprint option to create a snapshot is hidden for all users except for support and manager roles. Snapshots are shown in a hierarchical structure. n Depth – Maximum is 31. n Width – There is no limit. 64 Snapshot.
Chapter 3 Custom Properties Grouped by Name Table 3‑13. Custom Properties S Table (Continued) Property Description software.http.proxyPassword Specifies the password for the user name with which to authenticate to the proxy server. Use in combination with software.http.proxyUser. 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.
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 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. The script file must reside on the system on which the Visual Basic script EPI agent is installed. VbScript.PostProvisioning.
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.blueprint_name When using NSX, specifies the Edge Pool with which to associate the blueprint. VCNS.SecurityTag.Names.name Specifies the NSX 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) 70 Property Description 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.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) 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. To use this property, substitute the volume number for N in the property name and specify a storage reservation policy name as the value.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) Property Description 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 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.
Custom Properties Reference 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.
Chapter 3 Custom Properties Grouped by Name 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.
Custom Properties Reference 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.File Description Configures attributes of the network profile specified in VirtualMachine.
Chapter 3 Custom Properties Grouped by Name Table 3‑14. Custom Properties V Table (Continued) 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.
Custom Properties Reference 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.
Chapter 3 Custom Properties Grouped by Name 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.
Custom Properties Reference 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.
Chapter 3 Custom Properties Grouped by Name 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) 84 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.
Chapter 3 Custom Properties Grouped by Name 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.
Custom Properties Reference Table 3‑14. Custom Properties V Table (Continued) Property Description 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.
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 General Procedures The following steps describe the general procedure for creating and using new property definitions: 1 Create a new property definition and associate it with a data type that allows for a specific type of content, such as boolean or integer content. Use a standard naming convention for the new property name such as my_grouping_prefix.my_property_name. 2 Associate a property definition with a display type, such as a check box or drop-down menu.
Chapter 4 Using the Property Dictionary 2 Add a Custom Property to a Blueprint on page 98 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.
Custom Properties Reference 3 Enter the new property definition name in the Name text box. Use a standard naming convention for the new property name such as my_grouping_prefix.my_property_name. The Name value is stored internally as the property identifier (ID). 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.
Chapter 4 Using the Property Dictionary Table 4‑1. Property Definition Data Types (Continued) Data type Description Secure String Allows for secure or encrypted content such as a password. The Display as option is Textbox. String Allows for a string value. The Display as options are Dropdown, Email, Hyperlink, Textarea, and Textbox. 9 If the Required option is available, select Yes or No from the drop-down menu to specify if a value must be supplied for this property.
Custom Properties Reference Procedure 1 2 3 Select Administration > Property Dictionary > Property Definitions. Click the New icon ( ). 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.
Chapter 4 Using the Property Dictionary Procedure 1 2 3 4 Select Administration > Property Dictionary > Property Definitions. Click the New icon ( ). 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.
Custom Properties Reference Bind Custom Properties to Create a Parent-Child Relationship To create a parent-child relationship between custom properties, you bind the parent to the child. When you add the parent and child custom properties to a blueprint, the requesting user selects a value for the parent property. The selected parent value determines the possible values for the child property.
Chapter 4 Using the Property Dictionary Prerequisites n For this example, create a vRealize Orchestrator action that provides data center names as location information. Name the action datacenters_prod, add an input parameter named prod as a string type, and use this sample script for the action script. if(prod == null) { return ['Empty1', 'Empty2']; } else if (prod.
Custom Properties Reference 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.
Chapter 4 Using the Property Dictionary 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.
Custom Properties Reference 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.
Chapter 4 Using the Property Dictionary 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.
Custom Properties Reference 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.
Chapter 4 Using the Property Dictionary 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.
Custom Properties Reference Prerequisites If you use an external vRealize Orchestrator server, verity that it is set up correctly. See Configuring vRealize Automation. 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 92. Table 4‑3. Network Custom Property Configuration Values Option Value Name You must use VirtualMachine.Network0.Name.
Chapter 4 Using the Property Dictionary 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 92. 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.
Custom Properties Reference Table 4‑5. PowerShell Script Custom Property Configuration Values (Continued) Option Value Display as Dropdown Values External Action folder com.vmware.vra.powershell 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.
Chapter 4 Using the Property Dictionary 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 92. Table 4‑6. Database Query Custom Property Configuration Values Option Value Name You can use any string. Data type String Display as Dropdown Values External Action folder com.vmware.vra.
Custom Properties Reference 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.
Chapter 4 Using the Property Dictionary 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.
Custom Properties Reference 108 VMware, Inc.
Index A add, property definition 88, 89 Amazon, available custom properties 53 B binding properties 94 property definitions 94 blueprint add custom property 98, 99 add network custom property 99 test custom property 98, 99 blueprints, custom properties 15, 45 C custom 10 custom properties, a properties 53 custom properties, v properties 66 custom properties binding 94 blueprints 15 creating property groups 107 custom property types 12 debugging provisioning problems 16 defining new properties 87 for Flex
Custom Properties Reference O Openstack, custom properties for endpoints 17 P PowerShell script, property definition 103 properties encrypted 107 overrideable 107 show in request 107 property definition add 88, 89 binding 94 custom vRealize Orchestrator action 105 database query 104 network 101 PowerShell script 103 regular expression 91 reservation policy 102 vRealize Orchestrator action 92 property definitions, test in blueprint 98, 99 property dictionary, creating a property definition 89 property grou
