Custom Properties Reference 21 March 2018 vRealize Automation 7.
Custom Properties Reference You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about this documentation, submit your feedback to docfeedback@vmware.com VMware, Inc. 3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com Copyright © 2008–2018 VMware, Inc. All rights reserved. Copyright and trademark information. VMware, Inc.
Contents Custom Properties Reference Updated Information 5 6 1 Custom Properties and the Property Dictionary 7 Using Custom Properties 7 Creating and Adding Custom Properties and Property Groups Using Properties in Machine Provisioning 8 Understanding Custom Properties Precedence Custom Properties Grouped by Function Custom Properties for Deployments 8 9 12 13 Custom Properties for Naming and Analyzing Deployments Custom Properties for OpenStack Endpoints Custom Properties for Clone Blueprints 1
Custom Properties Reference Custom Properties O 70 Custom Properties P 71 Custom Properties R 72 Custom Properties S 72 Custom Properties V 77 Custom Properties X 99 Using the Property Dictionary 99 Using Property Definitions 99 Using Property Groups 120 Defining Component Profile Settings 122 Configure Component Profile Image Settings for Catalog Deployments Configure Component Profile Size Settings for Catalog Deployments VMware, Inc.
Custom Properties Reference Custom Properties Reference provides information about the custom properties, and their use, that are available when you use vRealize Automation. This documentation is intended to be used with the vRealize Automation product documentation available from the vRealize Automation Documentation page at https://www.vmware.com/support/pubs/vcacpubs.html.
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 21 MAR 2018 Minor updates. 04 DEC 2017 Minor updates. 24 AUG 2017 Updated Custom Properties V Table. 002440-01 Updated Custom Properties C. 002440-00 Initial release. VMware, Inc.
Custom Properties and the Property Dictionary 1 You can use supplied vRealize Automation custom properties to control various aspects of machine provisioning. You can also use the property dictionary to create new property definitions and property groups that are tailored to your specific needs. You can use properties to add values or override existing or default values for configuring network, platform, and guest agent settings and many other deployment-related parameters.
Custom Properties Reference Creating and Adding Custom Properties and Property Groups You can use custom properties to control machine provisioning. You can add supplied custom properties and also create and add your own properties and property groups. You can add properties and property groups to overall blueprints, components in a blueprint, reservations and other vRealize Automation items, including some endpoint types. You can also create new custom properties and property groups.
Custom Properties Reference n Customize a virtual machine’s system specifications, such as adding multiple disk drives. n Customize the guest OS for a machine, for instance, by including specified users in selected local groups. n Specify network and security settings. n Add additional control options such as drop-down menus to make input and selection options available to the consumer at request time.
Custom Properties Reference The following list shows the order of precedence for custom properties. Property value specified in a source that appears later in the list override values for the same property specified in sources that appear earlier in the list. Note If a conflict exists between a vRealize Automation-supplied custom property name and a userdefined property name, the vRealize Automation-supplied custom property name takes precedence.
Custom Properties Reference There are exceptions to the precedence rules. For example, you add the VMware.VirtualCenter.Folder custom property to a business group, provide a property value, and do not select the option to show the property in the request. You add the same custom property to a blueprint and specify that the property be shown in the request.
Custom Properties Reference Custom Properties Grouped by Function You can use custom properties to provide additional vRealize Automation controls. Custom properties have been grouped here by function. To explore custom properties grouped by name, see Custom Properties Grouped by Name. n Custom Properties for Deployments vRealize Automation provides several custom properties that are applicable to most deployments.
Custom Properties Reference n Custom Properties for vCloud Air and vCloud Director Blueprints You can add certain custom properties to a vCloud Air or vCloud Director machine component definition in a blueprint. n Custom Properties for Networking The vRealize Automation custom properties for networking specify configuration for a specific network device on a machine.
Custom Properties Reference Table 1‑1. Custom Properties for Blueprints and Deployments Custom 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. You can override the default behavior by setting the _debug_deployment custom property value to true.
Custom Properties Reference Table 1‑2. Custom Properties for Analyzing Deployments Custom 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. You can override the default behavior by setting the _debug_deployment custom property value to true.
Custom Properties Reference Table 1‑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. 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.
Custom Properties Reference Table 1‑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. To use this property, substitute the volume number for N in the property name and specify a storage reservation policy name as the value.
Custom Properties Reference Table 1‑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. If you specify an external script, you must also define its location by using the Linux.ExternalScript.
Custom Properties Reference Table 1‑5. Custom Properties for Customizing Cloned Machines with a Guest Agent (Continued) 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.
Custom Properties Reference Table 1‑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 1‑6. Custom Properties for Linked Clone Blueprints (Continued) 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.
Custom Properties Reference Table 1‑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. VMware, Inc.
Custom Properties Reference Table 1‑8. Custom Properties for FlexClone Blueprints Custom Property Description VirtualMachine.NetworkN.ProfileName and VirtualMachine.NetworkN.NetworkProfileName Specifies the name of a network profile from which to assign a static IP address to network device N or from which to obtain the range of static IP addresses that can be assigned to network device N of a cloned machine, where N=0 for the first device, 1 for the second, and so on. n Use VirtualMachine.NetworkN.
Custom Properties Reference Table 1‑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 1‑9. Custom Properties for Customizing FlexClone 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.Letter Specifies the drive letter or mount point of a machine’s disk N.
Custom Properties Reference Table 1‑10. Custom Properties for Basic Workflow Blueprints (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. To use this property, substitute the volume number for N in the property name and specify a storage reservation policy name as the value.
Custom Properties Reference Certain vRealize Automation custom properties are required to use with Linux Kickstart blueprints. Table 1‑11. Required Custom Properties for Linux Kickstart Blueprints Custom Property Description VMware.VirtualCenter.OperatingSystem Specifies the vCenter Server guest operating system version (VirtualMachineGuestOsIdentifier) with which vCenter Server creates the machine.
Custom Properties Reference Table 1‑12. Optional Custom Properties for Linux Kickstart Blueprints Custom Property Description VirtualMachine.Admin.ThinProvision Determines whether thin provisioning is used on ESX compute resources. Disk provisioning is abstracted from the underlying storage. Set to True to use thin provisioning. Set to False to use standard provisioning. This property is for virtual provisioning. Machine.
Custom Properties Reference Table 1‑13. Required Custom Properties for SCCM Blueprints (Continued) 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 lab-sccm.lab.local. SCCM.Server.SiteCode Specifies the site code of the SCCM server. SCCM.Server.
Custom Properties Reference Table 1‑15. Required Custom Properties for WIM 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 Table 1‑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. This operating system version must match the operating system version to be installed on the provisioned machine.
Custom Properties Reference Table 1‑16. Common Custom Properties for WIM Blueprints 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. Key represents a key name in the section.
Custom Properties Reference Custom Properties for vCloud Air and vCloud Director Blueprints You can add certain custom properties to a vCloud Air or vCloud Director machine component definition in a blueprint. 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.
Custom Properties Reference Table 1‑17. Custom Properties for vCloud Air and vCloud Director Machine Components in the Design Canvas (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.
Custom Properties Reference Table 1‑17. Custom Properties for vCloud Air and vCloud Director Machine Components in the Design Canvas (Continued) 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.
Custom Properties Reference Table 1‑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 Network assignments are performed during machine allocation. vRealize Automation retrieves network information from the blueprint. If you want to assign more than one network, use the VirtualMachine.NetworkN.Name custom property on your machine blueprint. If you do not provide custom properties, allocation only assigns one network which is picked using a round robin method in conjunction with the selected reservation.
Custom Properties Reference Table 1‑18. Custom Properties for Networking Configuration Custom Property Description agent.download.url When using port forwarding, specifies the private IP address of your Amazon AWS tunnel machine and port for your software agent file, for example https://Private_IP:1443/softwareservice/resources/nobel-agent.jar. You can add this property, in combination with software.agent.service.url and software.ebs.url, to a reservation or the compute resource endpoint.
Custom Properties Reference Table 1‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description NSX.Edge.HighAvailability When set to true (NSX.Edge.HighAvailability=true), enables high availability (HA) mode on the NSX edge machine that is deployed from the blueprint. When used with NSX.Edge.HighAvailability.PortGroup=port_group_name, this property allows you to configure an NSX edge during blueprint authoring.
Custom Properties Reference Table 1‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description NSX.Validation.Disable.Single.Edge.Uplink When set to true, the NSX validation that checks for the following conditions is disabled: n All on-demand NAT networks on the blueprint source the same external network. n All on-demand routed networks on the blueprint that use the load balancer VIP source the same external network.
Custom Properties Reference Table 1‑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 1‑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 1‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description VirtualMachine.NetworkN.ProfileName and VirtualMachine.NetworkN.NetworkProfileName Specifies the name of a network profile from which to assign a static IP address to network device N or from which to obtain the range of static IP addresses that can be assigned to network device N of a cloned machine, where N=0 for the first device, 1 for the second, and so on.
Custom Properties Reference Table 1‑18. Custom Properties for Networking Configuration (Continued) Custom Property Description n VirtualMachine.NetworkN.SubnetMask n VirtualMachine.NetworkN.Gateway Configures attributes of the network profile specified in VirtualMachine.NetworkN.ProfileName. n VirtualMachine.NetworkN.PrimaryDns VirtualMachine.NetworkN custom properties are specific to n VirtualMachine.NetworkN.SecondaryDns n VirtualMachine.NetworkN.PrimaryWins n VirtualMachine.NetworkN.
Custom Properties Reference Table 1‑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.
Custom Properties Reference Table 1‑19. Containers Custom Properties Property Description 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 installed in the container host environment in which they are used. For example, a supported value might be infoblox or calico depending on the IPAM plug-ins that are installed on the container host. containers.network.
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.
Custom Properties Reference Custom Properties For PXE and WIM Provisioning You can use these properties for PXE and WIM provisioning. Table 1‑22. 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\s
Custom Properties Reference Table 1‑22. 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.
Custom Properties Reference 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 1‑23. Custom Properties for Customizing Provisioned Machines with a Guest Agent Custom Property Description VirtualMachine.Admin.
Custom Properties Reference Table 1‑23. Custom Properties for Customizing Provisioned 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.
Custom Properties Reference Table 1‑23. Custom Properties for Customizing Provisioned 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 1‑23. 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 1‑24. Custom Properties Required for BMC BladeLogic Configuration Manager Integrations Custom Property Description VirtualMachine.EPI.Type Specifies the type of external provisioning infrastructure. VirtualMachine.Admin.Owner Specifies the user name of the machine owner. BMC.Software.Install Set to True to enable BMC BladeLogic Configuration Manager integration. EPI.Server.
Custom Properties Reference Table 1‑25. 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.
Custom Properties Reference Table 1‑27. 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 1‑27. Required Custom Properties for HP Server Automation Integration (Continued) Property Definition 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. Linux.ExternalScript.
Custom Properties Reference Custom Properties Grouped by Name 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 Custom Properties Grouped by Function. Custom Properties Underscore (_) A list of vRealize Automation custom properties that begin with an underscore (_). Table 1‑30.
Custom Properties Reference Custom Properties A A list of vRealize Automation custom properties that begin with the letter A. Table 1‑31. 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 Table 1‑31. Custom Properties A Table (Continued) Property Description Azure.Linux.ScriptPath Specifies the path to the downloaded script that configures tunneling for Linux-based systems. Update the path as appropriate for your deployment. agent.download.url Specifies the URL for the VPN agent on your deployment. The URL format is https:// Private_IP:1443/softwareservice//resources/noble-agent.
Custom Properties Reference Table 1‑33. Custom Properties C Table (Continued) Property Definition Command.DiskPart.Options When you use WIM-based virtual provisioning on ESX server hosts, set to Align=64 to use the recommended alignment parameters when you format and partition the machine’s disk. This property is not available for physical provisioning. Command.FormatDisk.
Custom Properties Reference Table 1‑33. Custom Properties C Table (Continued) Property Definition Container.Connection.Port For use with containers only. Specifies the Containers connection port. The default is 2376. Extensibility.Lifecycle.Properties.VMPSMast erWorkflow32.MachineActivated For use with containers only. Specifies the event broker property to expose all Containers properties and is used for registering a provisioned host. The default value is Container* and is required.
Custom Properties Reference Table 1‑34. Custom Properties E Table (Continued) Property Definition EPI.Server.VDiskName Specifies the name of the Citrix provisioning vDisk from which to provision, for example disk1. ext.policy.activedirectory.customiz ationWorkflowTag The tag that you added to a custom vRealize Orchestrator workflow. The Active Directory policy searches for custom workflows with the specified tag and, if found, uses the tagged workflow when an Active Directory record is created. ext.
Custom Properties Reference Table 1‑34. Custom Properties E Table (Continued) Property Definition ext.policy.activedirectory.system.m achineName 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.
Custom Properties Reference Table 1‑36. 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. This property is required for WIM-based provisioning, Linux Kickstart and autoYaST provisioning, and SCCM-based provisioning.
Custom Properties Reference Table 1‑36. Custom Properties I Table (Continued) Property Infrastructure.Admin.ADPassword Definition Specifies the password associated with the Infrastructure.Admin.ADUser domain administrator user ID. Infrastructure.Admin.DefaultDomain Specifies the default domain on the machine. Infrastructure.ResourcePool.Name 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.
Custom Properties Reference Table 1‑38. 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 1‑39. Custom Properties N Table Property Description NSX.Edge.ApplianceSize Specifies the allowed NSX edge appliance size types for the provisioned machine or deployment. The options are: n compact For small deployments, POCs, and single service use. n n CPU = 1 n RAM = 512 MB n Disk = 512 MB large For small to medium or multi-tenant deployments.
Custom Properties Reference Table 1‑39. Custom Properties N Table (Continued) Property Description NSX.Edge.HighAvailability.PortGroup Creates an internal interface or internal vNIC attached to the specified port group name, for example NSX.Edge.HighAvailability.PortGroup=VM Network where VM Network is an HA (high availability) distributed (vLANbacked) or NSX logical switch port group. NSX HA mode requires at least one internal network interface, or vNIC. When used with NSX.Edge.
Custom Properties Reference Table 1‑40. Custom Properties O Table Property Description Opsware.BootImage.Name Specifies the boot image value as defined in HP Server Automation for the 32-bit WinPE image, for example winpe32. The property is not required when provisioning by cloning. Opsware.Customer.Name Specifies a customer name value as defined in HP Server Automation, for example MyCompanyName. Opsware.Facility.
Custom Properties Reference Table 1‑41. Custom Properties P Table (Continued) Property Description Plugin.AdMachineCleanup.MoveToOu Moves the account of destroyed machines to a new Active Directory organizational unit. The value is the organization unit to which you are moving the account. This value must be in ou=OU, dc=dc format, for example ou=trash,cn=computers,dc=lab,dc=local. Plugin.AdMachineCleanup.
Custom Properties Reference Table 1‑43. Custom Properties S Table 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. Key represents a key name in the section.
Custom Properties Reference Table 1‑43. Custom Properties S Table (Continued) Property Description SCCM.Collection.Name Specifies the name of the SCCM collection that contains the operating system deployment task sequence. SCCM.CustomVariable.Name Specifies the value of a custom variable, where Name is the name of any custom variable to be made available to the SCCM task sequence after the provisioned machine is registered with the SCCM collection.
Custom Properties Reference Table 1‑43. 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.agent.service.
Custom Properties Reference Table 1‑43. 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 1‑43. 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.
Custom Properties Reference Although general support for vCloud Networking and Security 5.5.x (vCNS) has ended, the VCNS custom properties continue to be valid for NSX purposes. See the VMware Knowledge Base article End of Availability and End of General Support for VMware vCloud Networking and Security 5.5.x (2144733) at http://kb.vmware.com/kb/2144733 for more information. Table 1‑44. Custom Properties V Table Property Description VbScript.PreProvisioning.
Custom Properties Reference Table 1‑44. 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.
Custom Properties Reference Table 1‑44. 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 1‑44. Custom Properties V Table (Continued) Property Description VirtualMachine.Admin.ThinProvision Determines whether thin provisioning is used on ESX compute resources. Disk provisioning is abstracted from the underlying storage. Set to True to use thin provisioning. Set to False to use standard provisioning. This property is for virtual provisioning. VirtualMachine.Admin.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VirtualMachine.Admin.EncryptPasswords If set to True, specifies that the administrator passwords are encrypted. VirtualMachine.Admin.AdministratorEmail Specifies the manager email addresses or Active Directory accounts for the business group of the provisioning blueprint. Multiple email addresses are separated by a comma, for example JoeAdmin@VMware.com,WeiLeeMgr@VMware.com. VirtualMachine.Admin.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VirtualMachine.Admin.EagerZero When set to true, specifies that the machine disks are provisioned using the VMware provisioning format of eager zero. Thick provision eager zero is a type of thick virtual disk that supports clustering features such as fault tolerance. Space required for the virtual disk is allocated at creation time.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VirtualMachine.Core.Count If set to a value greater than zero, specifies the number of cores per socket when provisioning the virtual machine. You can use this property on a blueprint to specify cores per virtual socket or total number of sockets.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VirtualMachine.DiskN.Percent Specifies the percentage of the disk N to be formatted by a guest agent for the machine’s use. That machine cannot use the remaining portion of the disk. VirtualMachine.DiskN.FS For use with Windows guest agent (gugent). Specifies the file system of the machine’s disk N. The options are NTFS (default), FAT and FAT32. For example usage, see the 10_setupdisks.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VirtualMachine.Memory.Size Specifies the size of the machine's memory in MB, such as 1024. The default is the value specified by the memory setting on the blueprint. Note This custom property setting is overridden by the memory setting on the blueprint when the machine is first provisioned. VirtualMachine.NetworkN.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) 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.NetworkN custom properties are specific to individual blueprints and machines.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) 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.AddressType and VirtualMachine.NetworkN.ProfileName.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VirtualMachine.NetworkN.ProfileName and VirtualMachine.NetworkN.NetworkProfileName Specifies the name of a network profile from which to assign a static IP address to network device N or from which to obtain the range of static IP addresses that can be assigned to network device N of a cloned machine, where N=0 for the first device, 1 for the second, and so on. n Use VirtualMachine.NetworkN.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description n VirtualMachine.NetworkN.SubnetMask n VirtualMachine.NetworkN.Gateway Configures attributes of the network profile specified in VirtualMachine.NetworkN.ProfileName. n VirtualMachine.NetworkN.PrimaryDns VirtualMachine.NetworkN custom properties are specific to n VirtualMachine.NetworkN.SecondaryDns n VirtualMachine.NetworkN.PrimaryWins n VirtualMachine.NetworkN.SecondaryWins n VirtualMachine.
Custom Properties Reference Table 1‑44. 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 information-only property. It serves no real function for the enhanced clone workflow or the guest agent but it is useful for a custom software selection in a user interface or for software use reporting. VirtualMachine.SoftwareN.
Custom Properties Reference Table 1‑44. 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 1‑44. Custom Properties V Table (Continued) Property Description VirtualMachine.Storage.AllocationType Stores collected groups to a single datastore. A distributed environment stores disks round-robin style. Specify one of the following values: n Collected Keep all disks together. n Distributed Allow disks to be placed on any datastore or datastore cluster that is available in the reservation. For an example of how to use the VirtualMachine.Storage.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VMware.AttributeN.Name Specifies the name of an attribute in vRealize Orchestrator. For example, it specifies the value of the attribute used in the VMware.AttributeN.Name property. Replace the letter N with a number, starting with 0 and increasing for each attribute to set. VMware.AttributeN.Value Specifies the value of the attribute used in the VMware.AttributeN.Name property.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VMware.SCSI.Type For vCloud Air, vCloud Director, or vSphere machine components in blueprints, specifies the SCSI machine type using one of the following case-sensitive values: n buslogic n lsilogic Use BusLogic emulation for the virtual disk. Use LSILogic emulation for the virtual disk (default). n lsilogicsas Use LSILogic SAS 1068 emulation for the virtual disk.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VMware.Network.Type Specifies the network to connect the VM as specified in the reservation. The network adapter on the machine must be connected to a unique network. The following adapter type values are available: n Flexible (default ) n VirtualPCNet32 (not compatible with vSphere).
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description VDI.Server.Name Specifies the server name, which hosts the desktop delivery controller, to register with, or the name of a XenDesktop farm that contains desktop delivery controllers with which to register. If the value is a XenDesktop farm name, the VDI.Server.Website property value must be the URL of an appropriate Citrix web interface site to use in connecting to the machine.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description Vrm.DataCenter.Location Allows you to use a blueprint to provision machines on more than one compute resource. You can add the Vrm.DataCenter.Location property to a blueprint, or enable the Display Location on Request option in the blueprint, to require that the user supply a datacenter location when they request machine provisioning.
Custom Properties Reference Table 1‑44. Custom Properties V Table (Continued) Property Description 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 This row is specific to BMC BladeLogic. 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.
Custom Properties Reference You can specify how a property is rendered, for example if should display as a checkbox or as a dropdown menu with values obtained from a custom vRealize Orchestrator workflow. You can also use properties to control how your custom workflows function. For information about using vRealize Automation Designer to define and work with custom workflows, see Life Cycle Extensibility.
Custom Properties Reference Limitations If you create a property definition where Data type equals String, Display as equals Dropdown, and you use a vRealize Orchestrator action that returns properties that populate the drop-down list, the list is in random order. You cannot specify the order. Create and Test Custom Property Definitions You create a custom properties definition that determines how the custom property appears in vRealize Automation.
Custom Properties Reference 2 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 Prerequisites Log in to the vRealize Automation console as a tenant administrator or fabric administrator. Procedure 1 Select Administration > Property Dictionary > Property Definitions. 2 Click New ( 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).
Custom Properties Reference 8 Select a property definition data type from the Data type drop-down menu. Table 1‑46. Property Definition Data Types Data type Description Boolean Allows for a boolean value. The Display as options are Checkbox and Yes/No. Datetime Allows for a value entered in a date and time format. The Display as option is Date Time Picker. Decimal Allows for an integer or decimal value. The Display as options are Dropdown, Slider, and Textbox. Integer Allows for an integer value.
Custom Properties Reference 13 (Optional) Optionally select the Enable custom value entry check box to allow the user to specify custom values in addition to pre-defined values. 14 Click OK. The property is created and available on the Property Definitions page. Create a Custom Property That Validates Against a Regular Expression You create custom property definition that evaluates a regular expression when you want service catalog users to provide validated data on the catalog request form.
Custom Properties Reference Option Description Required Select No in the drop-down menu. Display as Select Textbox in the drop-down menu. Valid user input Enter the regular expression. 4 Enter a value in the testing text box to verify that the expression works. 5 Click OK. The custom property definition is added to the list and it is available to add to a blueprint. What to do next Add the custom property to a machine blueprint.
Custom Properties Reference 4 Option Description Description Describe the intent of the property definition and any other helpful information about the property. Display order The number that you enter controls where the property name appears on the request form. The following ordering rules apply: n The display order applies only to properties that are configured with Prompt User or Show in Request Form settings. n All properties with a display order appear before properties with no order index.
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.
Custom Properties Reference scale testing']; } else { return ['NorthDC for AMEA clients', 'SouthDC for Asia Pacific clients']; } For information about developing workflows, and about creating and using vRealize Orchestrator script actions, see Developing with VMware vCenter Orchestrator . n Log in to the vRealize Automation console as a tenant administrator or fabric administrator. Procedure 1 Create a custom property definition so that users can select production or non-production environment.
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.
Custom Properties Reference n Add your production-datacenter property group to a blueprint. See Add a Custom Property or Property Group as a Blueprint Machine Property. 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.
Custom Properties Reference 2 Select the blueprint to which you are adding the custom property and click Edit. 3 Click the target machine component. The configuration options for the virtual machine appear on the canvas. 4 Click the Properties tab, and then click the Custom Properties tab or the Property Groups tab. n n 5 To add a custom property, click New and select the property definition in the drop-down menu. Option Description Name Name of the selected custom property definition.
Custom Properties Reference Procedure 1 Select Design > Blueprints. 2 Select the blueprint to which you are adding the network custom property and click Edit. 3 Click the target virtual machine component. The configuration options for the virtual machine appear on the canvas. 4 Click the Network tab. 5 Click New. 6 Select the network profile in the Network drop-down menu and click OK. 7 In the new row, click Edit Custom Properties.
Custom Properties Reference n Verity that the blueprint is entitled to you so that you can test the custom properties in the blueprint. See Configuring vRealize Automation. n Log in to the vRealize Automation as a user with access to the test blueprint. Procedure 1 Select Catalog. 2 Select the test blueprint and click Request. 3 On the request form, click the machine to which you added the custom property. 4 Locate the custom property and click the drop-down arrow.
Custom Properties Reference n Database Query Custom Property Definition You add a custom property to query a database when you want to retrieve values from that database to populate the custom property on the request form. The database custom property uses a vRealize Orchestrator action to run the query and retrieve the values.
Custom Properties Reference Table 1‑48. Network Custom Property Configuration Values (Continued) Option Value Script action getApplicableNetworks This script action is an example script. You can create specific actions for your environment. Input parameters No required parameters. Blueprint Configuration Add the custom property on the blueprint Network tab. See Add a Custom Property as a Network Custom Property.
Custom Properties Reference Table 1‑49. Reservation Policy Custom Property Configuration Values (Continued) Option Value 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. Blueprint Configuration You can add a custom property to the blueprint Properties tab to associate the property with the overall blueprint.
Custom Properties Reference Table 1‑50. PowerShell Script Custom Property Configuration Values (Continued) Option Script action Value 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. Table 1‑51. 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 The action script must accept the input parameter values. You can configure the values as key value pairs. You can present user-readable names for less friendly identifiers using key value pairs. Custom Property Configuration Values You use these options to create the custom property. Table 1‑52. Custom Action Custom Property Configuration Values Option Value Name You can use any string.
Custom Properties Reference You can also create a property group for vCloud Air or vCloud Director machine provisioning that contains the following properties: n VirtualMachine.Network0.Name n VCloud.Template.MakeIdenticalCopy n VMware.SCSI.Type n Sysprep.Identification.DomainAdmin n Sysprep.Identification.DomainAdminPassword n Sysprep.Identification.
Custom Properties Reference c (Optional) Enter a property value. For example, enter True. d (Optional) Select the Encrypted check box to specify that the property value must be encrypted. For example, if the value is to be a password or other secure entry, using the encrypted option hides the value characters. e (Optional) Select the Show in Request check box to display the property on the request form when requesting machine provisioning. f Click OK to add the property to the group.
Custom Properties Reference When you request provisioning from the catalog, you can select from available value set choices for the Size and Image component profiles. When you choose one of the value sets, its corresponding property values are then bound to the request. Configure Component Profile Image Settings for Catalog Deployments You can configure the component profile Image setting to control build information for vSphere machine components in the blueprint.
Custom Properties Reference g If you specified a clone type action, select a template from the Clone from drop-down menu. h (Optional) Enter the path to a guest customization specification. i Select a provisioning workflow from the drop-down menu of available workflows. 5 Click Save. 6 When you are satisfied with your settings, click Finish. What to do next Add one or more value sets to the Image component profile by using the Profiles tab on a vSphere machine component.
Custom Properties Reference d Select Active or Inactive in the Status drop down menu. Select Active to allow the value set to be visible in the catalog provisioning request form. e Enter the number of virtual CPUs on which the deployment can be run. f Enter the amount of RAM to be used by virtual machines in the deployment. g Enter the amount of storage to be used by virtual machines in the deployment. 5 Click Save. 6 When you are satisfied with your settings , click Finish.
