Custom Properties Reference vRealize Automation 6.
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–2016 VMware, Inc. All rights reserved. Copyright and trademark information. VMware, Inc.
Contents Custom Properties Reference Updated Information 5 6 1 Using Custom Properties 8 Custom Property Uses 8 Custom Properties in Machine Provisioning, Blueprints, and Build Profiles Specifying Custom Properties 10 Order of Precedence for Custom Properties 10 Specifying Custom Properties for Multi-Machine Services Custom Property Types 9 12 12 Creating Custom Properties for Application Services Build Profiles and Property Sets Create a Build Profile 15 Create a Property Set 16 13 14 2
Custom Properties Reference Custom Properties I Table 55 Custom Properties L Table 56 Custom Properties M Table 57 Custom Properties O Table 57 Custom Properties P Table 58 Custom Properties R Table 59 Custom Properties S Table 59 Custom Properties V Table 62 Custom Properties X Table 82 4 Using the Property Dictionary 83 Adding Property Definitions 83 Add a Property Definition Adding Property Attributes 84 85 Add a Help Text Attribute 86 Add an Order Index Attribute Add a Relation
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.
Updated Information This Custom Properties Reference is updated with each release of the product or when necessary. This table provides the update history of Custom Properties Reference. Revision Description 001638-05 n Added custom property Scvmm.Generation2 to Custom Properties S Table. 4 n Updated custom property Hyperv.Network.Type in Custom Properties H Table. n Added custom property VMware.Endpoint.Openstack.IdentityProvider.
Custom Properties Reference Revision Description 001638-01 n Updated the VirtualMachine.NetworkN.Name property in Custom Properties for Networking and Custom Properties for vApp Blueprints. n Added the VirtualMachine.DiskN.IsFixed property to Custom Properties V Table and Custom Properties for vApp Blueprints. n Corrected the property names VirtualMachine.SoftwareN.ScriptPath, VirtualMachine.SoftwareN.ISOName , VirtualMachine.Admin.ConnectAddress, and VirtualMachine.SoftwareN.
Using Custom Properties 1 You can use custom properties to add new attributes or override default attributes. A tenant administrator or business group manager can include custom properties when they create or edit blueprints. They can also include a build profile, which contains one or more custom properties. The properties are retrieved when a machine is provisioned by using the blueprint. A fabric administrator can also specify custom properties when they create or edit a reservation.
Custom Properties Reference n Require the host name of the machine. The Windows guest agent records property values on the provisioned machine in the %SystemDrive %\VRMGuestAgent\site\workitem.xml file. The Linux guest agent records property values on the provisioned machine in the /usr/share/gugent/site/workitem.xml file.
Custom Properties Reference Specifying Custom Properties You can use custom properties to control machine provisioning. A fabric administrator can use custom properties when they create or edit reservations. A tenant administrator or business group manager can specify custom properties when they create or edit blueprints. Any property specified in a blueprint overrides the same property specified in the incorporated build profile.
Custom Properties Reference 4 Compute resource 5 Reservations 6 Endpoint 7 Runtime For vApps, the order is similar, as shown in the following list: 1 Build profile, specified on a vApp component blueprint 2 vApp component blueprint 3 Build profile, specified on a vApp blueprint 4 vApp blueprint 5 Business group 6 Compute resources 7 Reservations 8 Endpoint 9 Runtime specified on a vApp 10 Runtime specified on a component machine Any runtime property takes higher precedence and ove
Custom Properties Reference Specifying Custom Properties for Multi-Machine Services Tenant administrators and business group managers can specify custom properties that apply to all component machines in a multi-machine service in the multi-machine blueprint. When the same property exists in more than one source, vRealize Automation follows a specific order of precedence when applying properties to the machine.
Custom Properties Reference The following vRealize Automation custom property types are available. n Internal The specified value is maintained in the database only. For example, the email address of the manager who approved a machine request is recorded in the VirtualMachine.Admin.Approver property but the property has no effect on the machine. n Read-only The specified value is implemented on the machine and cannot be changed. For example, VirtualMachine.Admin.
Custom Properties Reference You can also use the vRealize Automation Property Dictionary when defining custom properties that use the Prompt User option. The following dictionary control types are supported for use with catalog items that are published from Application Services: n DropDownList n CheckBox For related information about using custom properties in conjunction with Application Services, see Using Application Services in vRealize Automation documentation.
Custom Properties Reference Create a Build Profile Fabric administrators can organize commonly used custom properties into build profiles so that tenant administrators and business group managers can include these custom property sets in blueprints. Build profiles are available to tenant administrators and business group managers of all tenants.
Custom Properties Reference c Select the Prompt user check box to require the user to provide a value when they request a machine. If you choose to prompt users for a value, any value you provide for the custom property is presented to them as the default. If you do not provide a default, users cannot continue with the machine request until they provide a value for the custom property. d 7 Click the Save icon ( ). Click OK.
Custom Properties Reference 5 Define the attributes of the custom property to include in the property set. If you do not include the DefaultValue attribute, no default value is stored. If you do not include the Encrypted or PromptUser attributes, they default to false. 6 Repeat Step 5 step for each property to include in the property set.
Custom Properties Grouped by Function 2 You can use custom properties to provide additional vRealize Automation controls. These properties are also grouped by name and described in relevant guides in vRealize Automation product documentation. See Chapter 3 Custom Properties Grouped by Name.
Custom Properties Reference Table 2‑1. 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 2‑2. 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 Table 2‑3. 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 If your administrators installed the guest agent to run scripts that accept custom properties and customize provisioned machines, you can use custom properties to further customize cloned machines that use the guest agent. Table 2‑4. Custom Properties for Customizing Cloned Machines with a Guest Agent Custom Property Description VirtualMachine.Admin.AddOwnerToAdmins Set to True (default) to add the machine’s owner, as specified by the VirtualMachine.Admin.
Custom Properties Reference Table 2‑4. Custom Properties for Customizing Cloned 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 2‑5. Custom Properties for FlexClone Blueprints Custom Property Description VirtualMachine.NetworkN.ProfileName Specifies the name of a network profile from which to assign a static IP address to network device Nor from which to obtain the range of static IP addresses that can be assigned to network device N of a cloned machine, where N=0 for the first device, 1 for the second, and so on.
Custom Properties Reference Table 2‑6. Custom Properties for Customizing FlexClone Machines with a Guest Agent Custom Property Description VirtualMachine.Admin.UseGuestAgent If the guest agent is installed as a service on a template for cloning, set to True on the machine blueprint to enable the guest agent service on machines cloned from that template. When the machine is started, the guest agent service is started. Set to False to disable the guest agent.
Custom Properties Reference Table 2‑6. Custom Properties for Customizing FlexClone Machines with a Guest Agent (Continued) Custom Property Description VirtualMachine.Customize.WaitComplete Set to True to prevent the provisioning workflow from sending work items to the guest agent until all customizations have been completed. VirtualMachine.SoftwareN.ScriptPath Specifies the full path to an application's install script.
Custom Properties Reference Table 2‑7. 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 2‑7. 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 Certain vRealize Automation custom properties are required to use with Linux Kickstart blueprints. Table 2‑9. 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 2‑10. Optional Custom Properties for Linux Kickstart Blueprints Custom 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. Machine.
Custom Properties Reference Table 2‑11. Required Custom Properties for SCCM Blueprints (Continued) Custom Property Description 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.UserName Specifies a user name with administrator-level access to the SCCM server. SCCM.Server.Password Specifies the password associated with the SCCM.
Custom Properties Reference Table 2‑13. Required Custom Properties for WIM Blueprints (Continued) Custom Property Description Image.ISO.UserName Specifies the user name to access the CIFS share in the format username@domain. For Dell iDRAC integrations where the image is located on a CIFS share that requires authentication to access. Image.ISO.Password Specifies the password associated with the Image.ISO.UserName property.
Custom Properties Reference Table 2‑14. 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 vApp Blueprints You can add certain vRealize Automation custom properties to a vApp or vApp component blueprint or property group to allow a vApp machine to join an Active Directory domain. The Active Directory domain is supported for Windows machines. If the vApp machine contains Linux and Windows component machines, use a property group to assign custom properties to the vApp component blueprint associated with the Windows machines. Table 2‑15.
Custom Properties Reference Table 2‑15. Custom Properties for vApp Blueprints (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. By default, a network is assigned from the network paths available on the reservation on which the machine is provisioned.
Custom Properties Reference Table 2‑15. Custom Properties for vApp Blueprints (Continued) Custom Property Description VCloud.Template.MakeIdenticalCopy Set to True to clone an identical copy of the vApp template in vCloud Director and provision the results in vRealize Automation. This ignores all settings specified in the blueprints except the name of the vApp and its virtual machines.
Custom Properties Reference Table 2‑16. Custom Properties for Customizing Provisioned Machines with a Guest Agent (Continued) Custom Property Description VirtualMachine.Admin.UseGuestAgent If the guest agent is installed as a service on a template for cloning, set to True on the machine blueprint to enable the guest agent service on machines cloned from that template. When the machine is started, the guest agent service is started. Set to False to disable the guest agent.
Custom Properties Reference Table 2‑16. Custom Properties for Customizing Provisioned Machines with a Guest Agent (Continued) Custom Property Description VirtualMachine.Customize.WaitComplete Set to True to prevent the provisioning workflow from sending work items to the guest agent until all customizations have been completed. VirtualMachine.SoftwareN.Name Specifies the descriptive name of a software application or script to install or run during provisioning.
Custom Properties Reference Table 2‑16. 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 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 2‑17. 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. By default, a network is assigned from the network paths available on the reservation on which the machine is provisioned.
Custom Properties Reference Table 2‑17. Custom Properties for Networking Configuration (Continued) Custom Property n VirtualMachine.NetworkN.SubnetMask n VirtualMachine.NetworkN.Gateway n VirtualMachine.NetworkN.PrimaryDns n VirtualMachine.NetworkN.SecondaryDns n VirtualMachine.NetworkN.PrimaryWins n VirtualMachine.NetworkN.SecondaryWins n VirtualMachine.NetworkN.DnsSuffix n VirtualMachine.NetworkN.
Custom Properties Reference Table 2‑17. Custom Properties for Networking Configuration (Continued) Custom Property Description VCNS.SecurityGroup.Names.name Specifies the vCloud Networking and Security security group or groups to which the virtual machine is assigned during provisioning. The value is a security group name or a list of names separated by commas. Names are case-sensitive.
Custom Properties Reference Custom Properties For PXE and SCCM Provisioning You can use these properties for PXE and SCCM provisioning. Table 2‑19. 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 lab-sccm.lab.local. SCCM.Server.
Custom Properties Reference Table 2‑20. 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 BMC BladeLogic Configuration Manager Integration vRealize Automation includes custom properties that you can use to provide additional controls for BMC BladeLogic Configuration Manager integration. Table 2‑21. Custom Properties Required for BMC BladeLogic Configuration Manager Integrations Custom Property Description VirtualMachine.EPI.Type Specifies the type of external provisioning infrastructure. BMC.Software.
Custom Properties Reference Custom Properties To Make BMC BladeLogic Configuration Manager Software Jobs Available Configure BMC BladeLogic Configuration Manager jobs for vRealize Automation integrations. Make all software jobs available to machine requesters to select from, or specify a software job to apply to all machines provisioned from the blueprint. Table 2‑22.
Custom Properties Reference Custom Properties for HP Server Automation Integration vRealize Automation includes custom properties that you can use to provide additional controls for HP Server Automation integration. Some custom properties are required for HP Server Automation integration. Other custom properties are optional. Required Custom Properties for HP Server Automation Integration Certain custom properties are required for a blueprint to work with HP Server Automation. Table 2‑24.
Custom Properties Reference Table 2‑24. Required Custom Properties for HP Server Automation Integration (Continued) Property Definition Opsware.OSSequence.Name Specifies the operating system sequence name value as defined in HP Server Automation, for example Windows 2008 WIM. Opsware.Realm.Name Specifies the realm name value as defined in HP Server Automation, for example Production. Opsware.Register.Timeout Specifies the time, in seconds, to wait for creation of a provisioning job to complete.
Custom Properties Reference Custom Properties That Make HP Server Automation Software Jobs Available Depending on how your fabric administrator configures HP Server Automation jobs for vRealize Automation integration, you might have a choice between making all software jobs available to machine requesters to select, or you can specify jobs to apply to all machines provisioned from your blueprint. Table 2‑26.
Custom Properties Grouped by Name 3 You can use custom properties to provide additional vRealize Automation controls. These properties are also grouped functionally and described in relevant guides in vRealize Automation product documentation. See Chapter 2 Custom Properties Grouped by Function.
Custom Properties Reference Table 3‑1. Custom Properties A Table Property Description AD.Lookup.Department Specifies the cost center value that is included in a notification email sent to approvers. This property value must be specified in the blueprint. Amazon.Placement.Tenancy Set to = dedicated to specify that the AWS connection be specific to a dedicated tenant. This property is valid for use with VPC subnets. amazon.AmazonEC2Config.
Custom Properties Reference Table 3‑2. 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.Retry Specifies the number of seconds to wait before retrying if the first attempt to add the machine to BMC BladeLogic Configuration Manager is unsuccessful. The default is 100. BMC.Service.
Custom Properties Reference Table 3‑4. 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.
Custom Properties Reference Table 3‑5. Custom Properties H Table Property Definition Hostname Specifies the host machine name, overriding the generated machine name contained in the VirtualMachine.Admin.Name property. If Hostname is not used, the VirtualMachine.Admin.Name value is used as the machine name. This property is not valid for multi-machine blueprints. Hyperv.Network.Type Specifies the network adapter type of the virtual machine. This property is valid for use with Hyper-V (SCVMM) only.
Custom Properties Reference Table 3‑6. Custom Properties I Table (Continued) Property Definition Image.WIM.Path Specifies the UNC path to the WIM file from which an image is extracted during WIMbased provisioning. The path format is \\server\share$ format, for example \\labad\dfs$. Image.WIM.Name Specifies the name of the WIM file, for example win2k8.wim, as located by the Image.WIM.Path property. Image.WIM.Index Image.Network.
Custom Properties Reference Table 3‑7. Custom Properties L Table (Continued) Property Description Linux.ExternalScript.Path Specifies the local path to the Linux customization script or the export path to the Linux customization on the NFS server. The value must begin with a forward slash and not include the file name, for example /scripts/linux/config.sh. Linux.ExternalScript.Server Specifies the name of the NFS server, for example lab-ad.lab.
Custom Properties Reference Table 3‑9. Custom Properties O Table (Continued) Property Description Opsware.ProvFail.Notify (Optional) Specifies the notification email address for HP Server Automation to use in the event of provisioning failure, for example provisionfail@lab.local. Opsware.ProvFail.Owner (Optional) Specifies the HP Server Automation user to whom ownership is assigned if provisioning fails. Opsware.ProvSuccess.
Custom Properties Reference Table 3‑10. Custom Properties P Table (Continued) Property Description Plugin.AdMachineCleanup.RenamePrefix Renames the accounts of destroyed machines by adding a prefix. The value is the prefix string to prepend, for example destroyed_. Pxe.Clean.ScriptName Specifies the name of an EPI PowerShell script installed in the vRealize Automation Model Manager, to run on the machine after it is provisioned.
Custom Properties Reference Table 3‑12. 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 3‑12. 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 3‑12. 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. Snapshot.Policy.Disable n Depth – Maximum is 31.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VCloud.Lease.Sync.TimeBufferMins Specifies a threshold integer value for a compute resource such that lease synchronization between vCloud Director and vRealize Automation will only occur for vCloud Director or vCloud Air provisioned machines that are set to expire in vCloud Director or vCloud Air in that time period.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VCNS.SecurityGroup.Names.name Specifies the vCloud Networking and Security security group or groups to which the virtual machine is assigned during provisioning. The value is a security group name or a list of names separated by commas. Names are case-sensitive.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. 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.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VirtualMachine.Admin.AgentID Specifies the UUID of the guest agent. The value is recorded by the guest agent when the machine is created, then it becomes read-only. The value in the blueprint or property group has no effect on this property. VirtualMachine.Admin.Owner Specifies the user name of the machine owner.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VirtualMachine.Admin.DiskInterfaceType Indicates the type of disk drivers. The following disk drivers are supported: n IDE (default) n VirtIO This property is for virtual provisioning. VirtualMachine.Admin.ForceHost Specifies the name of the ESX host. The property is only honored if VirtualMachine.Admin.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VirtualMachine.CPU.Count Specifies the number of CPUs, for example 2, allocated to a machine. The default is the value specified by the CPU setting on the blueprint. Note This custom property value is overridden by the CPU value on the blueprint when the machine is first provisioned. VirtualMachine.Customize.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VirtualMachine.DiskN.Label Specifies the label for a machine’s disk. The disk label maximum is 32 characters. Disk numbering must be sequential. When used in conjunction with a guest agent, specifies the label of a machine's disk N inside the guest operating system. VirtualMachine.DiskN.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VirtualMachine.DiskN.VMwareType Specifies the VMware disk mode of the machine’s diskN. This property applies to vSphere.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. 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 designed to be specific to individual blueprints and machines.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. 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. By default, a network is assigned from the network paths available on the reservation on which the machine is provisioned.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VirtualMachine.NetworkN.ProfileName Specifies the name of a network profile from which to assign a static IP address to network device Nor from which to obtain the range of static IP addresses that can be assigned to network device N of a cloned machine, where N=0 for the first device, 1 for the second, and so on.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. 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 designed n VirtualMachine.NetworkN.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. 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 file name.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. 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.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VirtualMachine.SoftwareN.FailsBuild Optionally set to True to specify that a failure when executing the work item causes the virtual machine build to fail. VirtualMachine.SoftwareN.NoQuotes Specifies that expanding the script path does not enclose values that contain spaces in double quotes.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VMware.AttributeN.Value Specifies the value of the attribute used in the VMware.AttributeN.Name property. Replace the letter N with a number, starting with 0 and increasing for each attribute to set. VMware.Endpoint.Openstack.IdentityProvider.Version For 6.2.4 and 6.2.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VMware.SCSI.Type For vApps and vSphere, specifies the SCSI machine type using one of the following case-sensitive values: n buslogic Use BusLogic emulation for the virtual disk. n lsilogic Use LSILogic emulation for the virtual disk (default). n lsilogicsas Use LSILogic SAS 1068 emulation for the virtual disk.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VMware.VirtualCenter.Folder Specifies the name of the inventory folder in the datacenter in which to put the virtual machine. The default is VRM, which is also the vSphere folder in which vRealize Automation places provisioned machines if the property is not used.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. 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.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) This section lists vRealize Automation custom properties that begin with the letter V. Property Description VDI.ActiveDirectory.Delay Specifies an optional delay time value in time span format between successfully adding a machine to Active Directory and initiation of XenDesktop registration. The default value is 00:00:05 (5 seconds). VRM.DataCenter.
Using the Property Dictionary 4 You can use the property dictionary to define new custom properties. You can customize how properties appear in the user interface. n Associate a property name with a user control, such as a check box or drop-down menu. n Specify constraints such as minimum and maximum values or validation against a regular expression. n Provide descriptive display names for properties or add label text.
Custom Properties Reference Property control types are available as you create new properties. After you create a property, you can add attributes, based on its control type. For example, you can assign a DropDown control type to a ValueExpression attribute, which when selected, opens a text box in which the user can type a value. You can also create placement layouts to control where the properties appear when presented to users. Table 4‑1.
Custom Properties Reference Procedure 1 Select Infrastructure > Blueprints > Property Dictionary. 2 Click New Property Definition. 3 Enter the new property name in the Name text box. This name must exactly match the property name that is used in the blueprint or build profile. 4 Enter the name that will appear in the user interface in the Display Name text box. 5 (Optional) Enter a property description in the Description text box.
Custom Properties Reference Table 4‑2.
Custom Properties Reference 6 In the Value text box, type the help text that you want to display when the user pauses on the property display name. 7 Click the Save icon ( 8 (Optional) Add additional attributes. 9 Click OK. ). Add an Order Index Attribute You can use the OrderIndex attribute to control how the property name appears in the user interface. The OrderIndex attribute is available for all property value control types except Link.
Custom Properties Reference For more information, see Example of Creating a Relationship Between Two Properties and Adding Them to a Blueprint. Prerequisites Log in to the vRealize Automation console as a fabric administrator. Procedure 1 Select Infrastructure > Blueprints > Property Dictionary. 2 Click Edit in the Property Attributes column of the property row. 3 Click New Property Attribute. 4 Select Relationship from the Type drop-down menu. 5 Enter an attribute name in the Name text box.
Custom Properties Reference 7 Click the Save icon ( 8 (Optional) Add additional attributes. 9 Click OK. ). Add a Value List Attribute You can use the ValueList attribute to create a list of available values for a drop-down menu. A ValueList attribute is available for the DropDown and DropDownList property value control types. See Example of Creating a Relationship Between Two Properties and Adding Them to a Blueprint.
Custom Properties Reference 3 Click New Property Attribute. 4 Select MinValue from the Type drop-down menu. 5 Enter an attribute name in the Name text box. This name is not visible in the user interface. 6 Type the minimum value of the property in the Value text box.
Custom Properties Reference An Interval attribute is available for the Integer property value control type. Prerequisites Log in to the vRealize Automation console as a fabric administrator. Procedure 1 Select Infrastructure > Blueprints > Property Dictionary. 2 Click Edit in the Property Attributes column of the property row. 3 Click New Property Attribute. 4 Select Interval from the Type drop-down menu. 5 Enter an attribute name in the Name text box.
Custom Properties Reference Workflow Overview You use the following workflow to create the relationship and add the properties to the blueprint. 1 Create the parent and child property definitions. 2 Add a Relationship attribute to the child property whose value is the name of the parent property. 3 Create a value expression that describes which values to display in the child drop-down list for each value of the parent property. 4 Add the value expression as an attribute of the child property.
Custom Properties Reference 4 Define the values for the parent property. a In the VirtualMachine.Network.Environment property name row, click Edit in the Property Attributes column. 5 6 b Click New Property Attribute. c Select ValueList from the Type drop-down menu. d Enter Values in the Name text box. e Enter Development,Test,Production in the Value text box. f Click Save. g Click OK. Create the child property. a Click New Property Definition on the Property Dictionary page.
Custom Properties Reference VirtualMachine.Network.Environment Test Test Network 2 VirtualMachine.Network.Environment Production Production Network VirtualMachine.Network.
Custom Properties Reference When a user uses this blueprint to request a machine, the Environment and Select Network drop-down menus now appear on the Confirm Machine Request page and are initially empty. The user can select an environment, which then narrows the list of networks that they can select for the machine that they are requesting.
Custom Properties Reference A custom layout is now available for a tenant administrator or business group manager to add to a blueprint or build profile. VMware, Inc.
