Custom Properties Reference 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 Using Custom Properties 7 Adding Custom Properties 7 Using Properties in Machine Provisioning 8 Understanding Custom Properties Precedence Custom Property Types 9 10 2 Custom Properties Grouped by Function 12 Custom Properties for Basic Workflow Blueprints Custom Properties for Clone Blueprints 13 Custom Properties for FlexClone Blueprints 17 Custom Properties for Linked Clone Blueprints Custom Properties for Linux Kickstart Bluepr
Custom Properties Reference Custom Properties S Table 56 Custom Properties V Table 58 Custom Properties X Table 82 4 Using the Property Dictionary 83 Using Property Definitions 83 Create a Property Definition 84 Use a vRealize Orchestrator Script Action to Populate a Property Value Using Property Groups 87 Create a Property Group VMware, Inc.
Custom Properties Reference Custom Properties Reference provides information about the custom properties, and their use, that are available when you use VMware vRealize ™ Automation. This documentation is intended to be used with the vRealize Automation product documentation available from the VMware vRealize ™ Automation Documentation page at https://www.vmware.com/support/pubs/vcac-pubs.html. Note Not all features and capabilities of vRealize Automation are available in all editions.
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 001840-02 Removed Amazon.Placement.Tenancy from Custom Properties A Table. 001840-01 n Updated the following topics to include a caveat about the VirtualMachine.NetworkN.ProfileName property: n 001840-00 VMware, Inc.
Using Custom Properties 1 You use custom properties to control aspects of the machines that users can provision. Some properties are determined by standard settings that you must specify for all machines. For example, memory and disk size values are required for all blueprints. You can specify additional properties individually or in property groups in blueprints and in reservations. Use custom properties to add values or override existing or default values for the following information.
Custom Properties Reference You can add properties and property groups when you create a blueprint, or later when the blueprint is in the draft or published state. Alternatively you can add custom properties and property groups to individual components in the blueprint. Blueprint-level custom properties take precedence over custom properties that are configured at the component level. You can edit blueprint-level properties by using the blueprint properties page.
Custom Properties Reference You can apply custom properties in reservations and business groups to many machines. Their use is typically limited to purposes related to their sources, such as resource management or line of business accounting. Specifying the characteristics of the machine to be provisioned is generally done by adding properties to blueprints and property groups.
Custom Properties Reference 2 Custom properties and groups at the component level 3 Custom properties for the business group 4 Custom properties for the compute resource 5 Custom properties for the reservation 6 Custom properties for the endpoint 7 Custom properties at the nested blueprint request level 8 Custom properties at the component request level A runtime property takes higher precedence over other properties.
Custom Properties Reference n Updated The specified value is implemented on the machine and is updated through data collection. For example, if the compute resource of a machine is changed, a proxy agent updates the value of the machine’s VirtualMachine.Admin.Hostname property. Internal and read-only property types set attributes that the template determines. You can use the vRealize Automation machine menu to change all reserved custom properties except the read-only properties VirtualMachine.Admin.
Custom Properties Grouped by Function 2 You can use custom properties to provide additional vRealize Automation controls. Custom properties have been grouped here by function. To explore custom properties grouped by name, see Chapter 3 Custom Properties Grouped by Name.
Custom Properties Reference Table 2‑1. Custom Properties for Basic Workflow Blueprints Custom Property Description VirtualMachine.CDROM.Attach Set to False to provision the machine without a CD-ROM device. The default is True. VirtualMachine.Admin.ThinProvision Determines whether thin provisioning is used on ESX compute resources using local or iSCSI storage. Set to True to use thin provisioning. Set to False to use standard provisioning. This property is for virtual provisioning. VirtualMachine.
Custom Properties Reference Table 2‑2. 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 2‑2. 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 2‑3. Custom Properties for Customizing Cloned Machines with a Guest Agent (Continued) Custom Property Description VirtualMachine.DiskN.Active Set to True (default) to specify that the machine's disk N is active. Set to False to specify that the machine's disk N is not active. VirtualMachine.DiskN.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.
Custom Properties Reference Table 2‑3. 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 file name. You can pass custom property values as parameters to the script by inserting {CustomPropertyName} in the path string.
Custom Properties Reference Table 2‑4. 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 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 2‑4. Custom Properties for FlexClone Blueprints (Continued) Custom Property Description Linux.ExternalScript.LocationType Specifies the location type of the customization script named in the Linux.ExternalScript.Name property. This can be either local or nfs. You must also specify the script location using the Linux.ExternalScript.Path property. If the location type is nfs, also use the Linux.ExternalScript.Server property. Linux.ExternalScript.
Custom Properties Reference Table 2‑5. 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 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 2‑6. Custom Properties for Linked Clone Blueprints Custom Property Description VirtualMachine.DiskN.Storage Specifies the datastore on which to place the machine disk N, for example DATASTORE01. This property is also used to add a single datastore to a linked clone blueprint. N is the index (starting at 0) of the volume to assign. Enter the name of the datastore to assign to the volume.
Custom Properties Reference Table 2‑6. Custom Properties for Linked 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.
Custom Properties Reference Table 2‑7. Custom Properties for Customizing Cloned 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‑8. Required Custom Properties for Linux Kickstart Blueprints (Continued) Custom Property Description Image.ISO.Name Values for this property are case sensitive. Specifies the name of the ISO image from which to boot, for example /ISO/Microsoft/WinPE.iso. The format of this value depends on your platform. For details, see documentation provided for your platform.
Custom Properties Reference Table 2‑10. Required Custom Properties for SCCM Blueprints Custom Property Description Image.ISO.Location Values for this property are case sensitive. Specifies the location of the ISO image from which to boot, for example http://192.168.2.100/site2/winpe.iso. The format of this value depends on your platform. For details, see documentation provided for your platform.
Custom Properties Reference Table 2‑11. Common Custom Properties for SCCM Blueprints Custom Property Description 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. The value is determined by your choice of custom variable. If your integration requires it, you can use SCCM.RemoveCustomVariablePrefix to remove the SCCM.
Custom Properties Reference Table 2‑12. Required Custom Properties for WIM Blueprints (Continued) Custom Property Description 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 Specifies the index used to extract the correct image from the WIM file. Image.Network.User Specifies the user name with which to map the WIM image path (Image.WIM.Path) to a network drive on the provisioned machine.
Custom Properties Reference Table 2‑13. 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 blueprint canvas. However, NSX load balancer properties are only applicable to vSphere machines. Table 2‑14.
Custom Properties Reference Table 2‑14. Custom Properties for vCloud Air and vCloud Director Machine Components in the Blueprint 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 2‑14. Custom Properties for vCloud Air and vCloud Director Machine Components in the Blueprint Canvas (Continued) Custom 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 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 2‑14. Custom Properties for vCloud Air and vCloud Director Machine Components in the Blueprint Canvas (Continued) Custom Property Description VMware.SCSI.Sharing Specifies the sharing mode of the machine’s VMware SCSI bus. Possible values are based on the VirtualSCSISharing ENUM value and include noSharing, physicalSharing, and virtualSharing. The VMware.SCSI.Sharing property is not available for use with the CloneWorkflow provisioning workflow.
Custom Properties Reference Table 2‑15. 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‑15. 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 N or script to install or run during provisioning.
Custom Properties Reference Table 2‑16. Custom Properties for Analyzing Deployments Custom Property Description _debug_deployment By default, all resources that are created by a provisioning process are rolled back if provisioning fails. You can override the default behavior by setting the _debug_deployment custom property value to true.
Custom Properties Reference The numbering of network properties must be sequential, starting with 0. For example, if you specify custom properties for only VirtualMachine.Network0 and VirtualMachine.Network2, the properties for VirtualMachine.Network2 are ignored, because the preceding network, VirtualMachine.Network1, was not specified. Table 2‑17. Custom Properties for Networking Configuration Custom Property Description VirtualMachine.NetworkN.
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. 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.
Custom Properties Reference Table 2‑17. Custom Properties for Networking Configuration (Continued) Custom Property Description VirtualMachine.NetworkN.ProfileName Specifies the name of a network profile from which to assign a static IP address to network device N or from which to obtain the range of static IP addresses that can be assigned to network device N of a cloned machine, where N=0 for the first device, 1 for the second, and so on.
Custom Properties Reference Table 2‑17. 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 designed to n VirtualMachine.NetworkN.SecondaryDns n VirtualMachine.NetworkN.PrimaryWins 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. VirtualMachine.Admin.
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. Custom properties have been grouped here by name. To explore custom properties grouped by function, 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.AmazonEC2Config.ServiceURL Specifies the Amazon configuration service URL for Amazon GovCloud, for example amazon.AmazonEC2Config.ServiceURL=https://ec2.usgov-west-1.amazonaws.com. amazon.ElasticLoadBalancingConfig.
Custom Properties Reference Table 3‑3. Custom Properties C Table Property Definition Cisco.Organization.Dn Specifies the distinguished name of the Cisco UCS Manager organization in which Cisco UCS machines provisioned by the business group are placed, for example org-root/org-Engineering. If the specified organization does not exist in the Cisco UCS Manager instance that is managing the machine, provisioning fails. This property is available for business groups only.
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 Custom Properties I Table This section lists vRealize Automation custom properties that begin with the letter I. Table 3‑6. Custom Properties I Table Property Definition Image.ISO.Location Values for this property are case sensitive. Specifies the location of the ISO image from which to boot, for example http://192.168.2.100/site2/winpe.iso. The format of this value depends on your platform. For details, see documentation provided for your platform.
Custom Properties Reference Table 3‑6. Custom Properties I Table (Continued) Property Definition Infrastructure.Admin.MachineObject OU Specifies the organizational unit (OU) of the machine. When machines are placed in the required OU by the business group OU setting, this property is not required. Infrastructure.Admin.ADUser Specifies the domain administrator user ID. This identifier is used to query Active Directory users and groups when an anonymous bind cannot be used. Infrastructure.Admin.
Custom Properties Reference Table 3‑8. Custom Properties M Table Property Description MaximumProvisionedMachines Specifies the maximum number of linked clones for one machine snapshot. The default is unlimited. Machine.SSH Set to True to enable the Connect Using SSH option, on the vRealize Automation Items page, for Linux machines provisioned from this blueprint.
Custom Properties Reference Table 3‑9. Custom Properties O Table (Continued) Property Description Opsware.Server.Username Specifies the user name provided when a password file in the agent directory was created, for example opswareadmin. This user name requires administrative access to the HP Server Automation instance. Opsware.Software.Install Set to True to allow HP Server Automation to install software.
Custom Properties Reference Table 3‑11. Custom Properties R Table Property Description RDP.File.Name Specifies an RDP file from which to obtain settings, for example My_RDP_Settings.rdp. The file must reside in the Website\Rdp subdirectory of the vRealize Automation installation directory. Custom Properties S Table This section lists vRealize Automation custom properties that begin with the letter S. Table 3‑12. Custom Properties S Table Property Description SysPrep.Section.
Custom Properties Reference Table 3‑12. Custom Properties S Table (Continued) Property Description Sysprep.Identification.JoinDomain Specifies the name of the domain to join in Active Directory. Sysprep.Identification.JoinWorkgroup Specifies the name of the workgroup to join if not using a domain. SysPrep.UserData.ComputerName Specifies a machine name, for example lab-client005. SysPrep.UserData.FullName Specifies the full name of a user. SysPrep.UserData.
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) 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 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) Property Description VCNS.LoadBalancerEdgePool.Names.name Specifies the vCloud Networking and Security load balancing pools to which the virtual machine is assigned during provisioning. The virtual machine is assigned to all service ports of all specified pools. The value is an edge/pool name or a list of edge/pool names separated by commas. Names are case-sensitive.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VCNS.SecurityGroup.Names.blueprint_name When using vCloud Networking and Security, specifies the Edge Pool with which to associate the blueprint. VCNS.SecurityTag.Names.name Specifies the vCloud Networking and Security security tag or tags to which the virtual machine is associated during provisioning. The value is a security tag name or a list of names separated by commas. Names are case-sensitive.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.Admin.ThinProvision Determines whether thin provisioning is used on ESX compute resources using local or iSCSI storage. Set to True to use thin provisioning. Set to False to use standard provisioning. This property is for virtual provisioning. VirtualMachine.Admin.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) 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. VirtualMachine.Admin.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.Admin.AddOwnerToAdmins Set to True (default) to add the machine’s owner, as specified by the VirtualMachine.Admin.Owner property, to the local administrators group on the machine. This property is not available for provisioning by cloning. VirtualMachine.Admin.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.Agent.Reboot Set to True (default) to specify that the guest agent restarts the machine following installation of the guest operating system. VirtualMachine.CDROM.Attach Set to False to provision the machine without a CD-ROM device. The default is True. VirtualMachine.CPU.Count Specifies the number of CPUs, for example 2, allocated to a machine.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.DiskN.IsFixed Disables the editing of a specific disk when reconfiguring a machine. Set to True to disable display of the edit capacity option for a specific volume. The True value is case-sensitive. The N value is the 0-based index of the disk. Alternatively, you can set the VirtualMachine.DiskN.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.DiskN.StorageReservationPolicy Specifies the storage reservation policy to use to find storage for disk N. Also assigns the named storage reservation policy to a volume. To use this property, substitute the volume number for N in the property name and specify a storage reservation policy name as the value.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.DiskN.VMwareType Specifies the VMware disk mode of the machine’s diskN. The following options are available: n persistent n independent_persistent n independent_nonpersistent If you set this custom property to independent_persistent or independent_nonpersistent, users must power off their machine before using vRealize Automation to take a snapshot.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.NetworkN.Address Specifies the IP address of network device N in a machine provisioned with a static IP address. VirtualMachine.NetworkN custom properties are designed to be specific to individual blueprints and machines. When a machine is requested, network and IP address allocation is performed before the machine is assigned to a reservation.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.NetworkN.MacAddress Specifies the MAC address of a network device N. This property is available for cloning. If the value of VirtualMachine.NetworkN.MacAddressType is generated, this property contains the generated address. If the value of VirtualMachine.NetworkN.MacAddressType is static, this property specifies the MAC address.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.NetworkN.PortID Specifies the port ID to use for network device N when using a dvPort group with a vSphere distributed switch. VirtualMachine.NetworkN custom properties are designed to be specific to individual blueprints and machines. When a machine is requested, network and IP address allocation is performed before the machine is assigned to a reservation.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.NetworkN.ProfileName Specifies the name of a network profile from which to assign a static IP address to network device N or from which to obtain the range of static IP addresses that can be assigned to network device N of a cloned machine, where N=0 for the first device, 1 for the second, and so on.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description You cannot use this custom property to define an on-demand NAT or on-demand routed network profile name. Because on-demand network profile names are generated at allocation time (during provisioning), their names are unknown when creating or editing the blueprint.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) 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. Performing a hot add of CPU, memory, or storage causes the reconfigure machine action to fail and to not restart the machine unless the Hot Add setting is enabled in vSphere for the machine or template.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.SoftwareN.ISOLocation Specifies the storage path that contains the ISO image file to be used by the application or script. Format the path as it appears on the host reservation, for example netapp-1:it_nfs_1. If a value is not specified, the ISO is not mounted. VirtualMachine.Storage.Name Identifies the storage path on which the machine resides.
Custom Properties Reference Table 3‑13. Custom Properties V Table (Continued) Property Description VirtualMachine.VDI.Type Specifies the type of virtual desktop infrastructure. For XenDesktop provisioning, set to XenDesktop. VMware.AttributeN.Name Specifies the name of an attribute in vRealize Orchestrator. For example, it specifies the value of the attribute used in the VMware.AttributeN.Name property. Replace the letter N with a number, starting with 0 and increasing for each attribute to set.
Custom Properties Reference Table 3‑13. 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 3‑13. 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 3‑13. Custom Properties V Table (Continued) Property Description VDI.Server.Website Specifies the server name of the Citrix Web interface site to use in connecting to the machine. If the value of VDI.Server.Name is a XenDesktop farm, this property must have an appropriate value or the machine owner cannot connect to the machine using XenDesktop. If this property is not specified, the VDI.Server.
Custom Properties Reference Table 3‑13. 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 3‑13. Custom Properties V Table (Continued) Property Description VDI.ActiveDirectory.Timeout Specifies an optional timeout value to wait before retrying Active Directory registration. The default value is 00:00:15 (30 minutes). VDI.ActiveDirectory.Delay Specifies an optional delay time value in time span format between successfully adding a machine to Active Directory and initiation of XenDesktop registration. The default value is 00:00:05 (5 seconds). Vrm.
Custom Properties Reference Table 3‑13. 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 This row is specific to BMC BladeLogic. job_type is the numeral that represents the BMC BladeLogic job type and job_path is the location of the job in BMC BladeLogic, for example 4=/Utility/putty. NNNN is a number from 1000 to 1999.
Using the Property Dictionary 4 You can use the property dictionary to define new custom property definitions and property groups. You define a property to support a specific data type and a display control style within that data type. You can also create reusable property groups to simplify adding multiple properties. This chapter includes the following topics: n Using Property Definitions n Using Property Groups Using Property Definitions Many custom properties are supplied with vRealize Automation.
Custom Properties Reference 3 Add the property to a blueprint either individually or as part of a property group. Add the property to a blueprint and specify if the property value must be encrypted. Add the property to a blueprint and specify if the user should be prompted to specify a property value. 4 As a machine requestor, specify any required value if prompted. You can also populate the property value in a drop-down menu by using vRealize Orchestrator script actions.
Custom Properties Reference 5 In the Visibility section, select All tenants or This tenant to determine where the property is to be available. If you are logged in with only tenant administrator privileges, then only This tenant is available. If you are logged in with only fabric administrator privileges, then only All tenants is available. You cannot change the All tenants or This tenant setting after you create the item. 6 (Optional) Enter a property description in the Description text box.
Custom Properties Reference 10 If the Minimum value option is available, specify a minimum value. 11 Select a display control type for this property in the Display advice drop-down menu. Available options are derived from your Data type selection. Table 4‑2. Property Definition Display Advice Options Display Advice Option Description CheckBox Provides a single check box control.
Custom Properties Reference The following task sequence differs from the Create a Property Definition task sequence only in how you specify the Display Advice value. Procedure 1 Create a new property definition or edit an existing property definition. a Verify that the Name text box contains a value. b Verify that the Label text box contains a value. c Verify that the Data type text box contains either Decimal, Integer, or String.
Custom Properties Reference n Image.Network.User n Image.WIM.Index n Image.WIM.Name n Image.WIM.Path 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 6 Add a property to the group by using the Properties box. a Click New ( b Enter a property name. ). For example, enter VirtualMachine.Storage.ReserveMemory. 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.
