custom properties reference - vmware...

Custom Properties ReferencevCloud Automation Center 6.1

This document supports the version of each product listed andsupports all subsequent versions until the document isreplaced by a new edition. To check for more recent editionsof this document, see http://www.vmware.com/support/pubs.

EN-001454-00

http://www.vmware.com/support/pubs

Custom Properties Reference

2 VMware, Inc.

You can find the most up-to-date technical documentation on the VMware Web site at:

http://www.vmware.com/support/

The VMware Web site also provides the latest product updates.

If you have comments about this documentation, submit your feedback to:

[email protected]

Copyright © 2008–2014 VMware, Inc. All rights reserved. Copyright and trademark information.

VMware, Inc.3401 Hillview Ave.Palo Alto, CA 94304www.vmware.com

http://www.vmware.com/support/

mailto:[email protected]

http://pubs.vmware.com/copyright-trademark.html

Contents

Custom Properties Reference 5

Updated Information 7

1 Using Custom Properties 9

Specifying Custom Properties 9Custom Property Uses 10Custom Property Types 10Create a Property Set 11

Create a Property Set XML File 11Add a Property Set to vCloud Automation Center 12

2 Custom Properties Grouped by Function 13

Custom Properties for Basic Workflow Blueprints 13Custom Properties for Clone Blueprints 14Custom Properties for FlexClone Blueprints 17Custom Properties for Linked Clone Blueprints 19Custom Properties for Linux Kickstart Blueprints 22Custom Properties for SCCM Blueprints 23Custom Properties for WIM Blueprints 24Custom Properties for vApp Blueprints 26Custom Properties for Networking 27Custom Properties for PXE Provisioning 28Custom Properties for BMC BladeLogic Configuration Manager Integration 30Custom Properties for HP Server Automation Integration 32

3 Custom Properties Grouped by Name 35

Custom Properties A Table 36Custom Properties B Table 36Custom Properties C Table 36Custom Properties E Table 37Custom Properties H Table 38Custom Properties I Table 38Custom Properties L Table 39Custom Properties M Table 40Custom Properties O Table 40Custom Properties P Table 41Custom Properties R Table 42Custom Properties S Table 42Custom Properties V Table 44Custom Properties X Table 60

VMware, Inc. 3

4 Using the Properties Dictionary 61

Adding Property Definitions 62Add a Property Definition 62

Adding Property Attributes 63Add a Help Text Attribute 64Add an Order Index Attribute 64Add a Relationship Attribute 65Add a Value Expression Attribute 66Add a Value List Attribute 66Add a Minimum Value Attribute 67Add a Maximum Value Attribute 67Add an Interval Attribute 68

Example of Creating a Relationship Between Two Properties and Adding Them to a Blueprint 68Creating Property Control Layouts 71

Add a Property Control Layout 71

Index 73


4 VMware, Inc.


Custom Properties Reference provides information about the custom properties, and their use, that areavailable when you use VMware vCloud Automation Center.

This documentation is intended to be used with the vCloud Automation Center product documentation set,including the following guides.

n Installation and Configuration

n IaaS Configuration for Virtual Platforms

n IaaS Configuration for Cloud Platforms

n IaaS Configuration for Physical Machines

n IaaS Integration for Multi-Machine Services

n IaaS Configuration for vCloud Director

n IaaS Integration for BMC BladeLogic

n IaaS Integration for HP Server Automation

n Tenant Administration

n System Administration

n Advanced Service Design

n Advanced Service Designer Configuration

NOTE Not all features and capabilities of vCloud Automation Center are available in all editions. For acomparison of feature sets in each edition, see https://www.vmware.com/products/vcloud-automation-center/.

Intended AudienceThis information is intended for IaaS administrators, fabric administrators, and business group managers ofvCloud Automation Center. This content is written for experienced Windows or Linux systemadministrators who are familiar with virtualization technology and the basic concepts described inFoundations and Concepts.

VMware Technical Publications GlossaryVMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitionsof terms as they are used in VMware technical documentation, go to http://www.vmware.com/support/pubs.

VMware, Inc. 5

https://www.vmware.com/products/vcloud-automation-center/

https://www.vmware.com/products/vcloud-automation-center/

http://www.vmware.com/support/pubs


6 VMware, Inc.

Updated Information

This Custom Properties Reference is updated with each release of the product or when necessary.

This table provides the update history of Custom Properties Reference.

Revision Description

6.1 The following changes were made to Custom Properties Reference in the 6.1 release.n Updated information in the following property descriptions relative to guest agents.

n VirtualMachine.Admin.CustomizeGuestOSDelay

n VirtualMachine.Customize.WaitComplete

n VirtualMachine.DiskN.Letter

n VirtualMachine.DiskN.Label

n VirtualMachine.DiskN.Active

n VirtualMachine.Software0.ScriptPath

n Updated information in the following property descriptions relative to where used constraints.n VirtualMachine.NetworkN.Address

n VirtualMachine.NetworkN.MacAddressType

n VirtualMachine.NetworkN.MacAddress

n VirtualMachine.NetworkN.Name

n VirtualMachine.NetworkN.PortID

n Updated the VirtualMachine.NetworkN.ProfileName property description relative to changing theproperty value after a network is assigned

n Updated the Hostname property description relative to multi-machine blueprintsn Updated the AD.Lookup.Department property description to include information about specifying data

on blueprints.n Added the following previously undocumented properties to the list of documented custom properties.

n VCloud.Lease.Sync.TimeBufferMin

n VirtualMachine.NetworkN.NetworkProfileName

n VirtualMachine.NetworkN.PortID

n VirtualMachine.Request.Layout

n VirtualMachine.SoftwareN.Name

n VirtualMachine.SoftwareNISOName

n VirtualMachine.SoftwareNISOLocation

n VMware.AttributeN.Namen VMware.AttributeN.Valuen VMware.Hardware.Version

n VMware.VCenterOrchestrator.EndpointName

n Removed the VirtualMachine.Admin.OverrideVncConsole deprecated property

6.0 Initial release.

VMware, Inc. 7


8 VMware, Inc.

Using Custom Properties 1You 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 editblueprints. They can also include a build profile, which contains one or more custom properties. Theproperties are retrieved when a machine is provisioned by using the blueprint. A fabric administrator canalso specify custom properties when they create or edit a reservation.

This chapter includes the following topics:

n “Specifying Custom Properties,” on page 9

n “Custom Property Uses,” on page 10

n “Custom Property Types,” on page 10

n “Create a Property Set,” on page 11

Specifying Custom PropertiesYou can use custom properties to control machine provisioning. A fabric administrator can use customproperties when they create or edit reservations. A tenant administrator or business group manager canspecify custom properties when they create or edit blueprints.

Any property specified in a blueprint overrides the same property specified in the incorporated buildprofile. For example, a blueprint that contains a particular build profile might override the US Englishsettings in the profile with UK English settings. This arrangement ensures that the number and complexityof blueprints remain manageable.

A custom property can optionally require that the user specify a property value when they create a machinerequest.

Custom property names are typically case-insensitive. Property values are typically case-sensitive. Customproperties cannot contain leading or trailing spaces.

For related information about using custom properties on blueprints and in build profiles, see IaaSConfiguration in vCloud Automation Center documentation.

VMware, Inc. 9

Custom Property UsesYou 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 propertiesindividually or in build profiles in blueprints and in reservations. Use custom properties to add values oroverride existing or default values for the following information.

n Machine operating system

n Virtualization platform

n Build settings such as disk size

n Integration with an external system

When you add a property to a blueprint or a build profile, you can mark it as a required property. When aproperty is specified as required, the user must provide a value for that property when they request amachine, such as in the following examples.

n Require information about multiple disks sharing the machine’s allocated storage.

n Require information about users or groups to be added to a local group on the machine.

n Require the host name of the machine.

The applications' manager service records property values in the vCloud Automation Center database. Theguest agent also records them on the provisioned machine in the following files.

n %SystemDrive%\VRM\Build\Properties.ini

n %SystemDrive%\VRM\Build\Properties.xml

Custom Property TypesYou can use external and updated property types for cloned machines. You cannot use Internal and read-only property types for cloned machines.

The following vCloud Automation Center custom property types are available.

n Internal

The specified value is maintained in the database only. For example, the email address of the managerwho approved a machine request is recorded in the VirtualMachine.Admin.Approver property but theproperty 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.UUID specifies the UUID of the machine, which cannot be changed.

n External

A machine’s external properties are determined when the virtualization platform creates the machine orduring the WinPE phase of the build process. To set these properties, their values must be provided tothe proxy agent, which passes them on to the virtualization platform, or to the guest agent , whichimplements them in the WinPE phase.

The specified value is implemented on the machine but is never updated. For example, if the propertyVirtualMachine.Admin.AddOwnerToAdmins is set to true, the owner of the machine is added to its localadministrators group. If the owner is later removed from this group, the property is not updated tofalse.

n Updated


10 VMware, Inc.

The specified value is implemented on the machine and is updated through data collection. Forexample, if the compute resource of a machine is changed, a proxy agent updates the value of themachine’s VirtualMachine.Admin.Hostname property.

Internal and read-only property types set attributes that the template determines.

You can use the applicable machine menu to change all reserved custom properties in the database, exceptthe read-only properties VirtualMachine.Admin.AgentID, VirtualMachine.Admin.UUID, and Virtual-Machine.Admin.Name.

Create a Property SetFabric administrators can create their own groupings of related custom properties and add them tovCloud Automation Center for use in build profiles.

Property sets are available to fabric administrators of all tenants.

Create a Property Set XML FileA fabric administrator defines property sets in an XML file and uploads them tovCloud Automation Center.

If you edit a property set that is already in use in a build profile, vCloud Automation Center does notautomatically update the build profile. A fabric administrator must reload the property set to the buildprofile.

Procedure

1 Create an XML file.

2 Insert the following version and encoding values into the schema declaration.version="1.0" encoding="UTF-16".

3 Insert a <Doc> element.

<Doc>

</Doc>

4 Insert a <CustomProperties> element in the <Doc> element.

<Doc>

<CustomProperties>

</CustomProperties>

</Doc>

5 Define the attributes of the custom property to include in the property set.

<Doc>

<CustomProperties>

<Property Name=”property_name" DefaultValue=”property_value" Encrypted=”true_or_false"

PromptUser="true_or_false"/>

</CustomProperties>

</Doc>

If you do not include the DefaultValue attribute, no default value is stored. If you do not include theEncrypted or PromptUser attributes, they default to false.

6 Repeat Step 5 step for each property to include in the property set.

7 Save and close the file.

A fabric administrator can now upload your property set XML file to vCloud Automation Center.

Chapter 1 Using Custom Properties

VMware, Inc. 11

Add a Property Set to vCloud Automation CenterAfter you create a property set XML file, a fabric administrator can upload the property set tovCloud Automation Center.

Prerequisites

n Log in to the vCloud Automation Center console as a fabric administrator.

n Create a property set XML file.

Procedure

1 Select Infrastructure > Blueprints > Build Profiles.

2 Click Manage Property Sets.

3 Click Browse to select the Property set XML file name.

4 Enter a name and, optionally, a description.

5 Click OK.

You can now include your property set in build profiles.


12 VMware, Inc.

Custom Properties Grouped byFunction 2

You can use custom properties to provide additional vCloud Automation Center controls.

These properties are also grouped by name and described in relevant guides in vCloud Automation Centerproduct documentation. See Chapter 3, “Custom Properties Grouped by Name,” on page 35.


n “Custom Properties for Basic Workflow Blueprints,” on page 13

n “Custom Properties for Clone Blueprints,” on page 14

n “Custom Properties for FlexClone Blueprints,” on page 17

n “Custom Properties for Linked Clone Blueprints,” on page 19

n “Custom Properties for Linux Kickstart Blueprints,” on page 22

n “Custom Properties for SCCM Blueprints,” on page 23

n “Custom Properties for WIM Blueprints,” on page 24

n “Custom Properties for vApp Blueprints,” on page 26

n “Custom Properties for Networking,” on page 27

n “Custom Properties for PXE Provisioning,” on page 28

n “Custom Properties for BMC BladeLogic Configuration Manager Integration,” on page 30

n “Custom Properties for HP Server Automation Integration,” on page 32

Custom Properties for Basic Workflow BlueprintsvCloud Automation Center includes custom properties that you can use to provide additional controls forbasic workflow blueprints.

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-ROMdevice. The default is True.

VirtualMachine.Admin.ThinProvision Determines whether thin provisioning is used on ESXcompute resources using local or iSCSI storage. Set to Trueto use thin provisioning. Set to False to use standardprovisioning. This property is for virtual provisioning.

VMware, Inc. 13

Table 2‑1. Custom Properties for Basic Workflow Blueprints (Continued)


VirtualMachine.DiskN.StorageReservationPolicy Specifies a storage reservation policy to find storage fordisk N. Also assigns a storage reservation policy to avolume. To use this property, substitute the volumenumber for N in the property name and specify a storagereservation policy as the value. This property is equivalentto the Storage Reservation Policy drop-down menu in theVolumes list on the Build Information tab of the blueprintpage. Disk numbering must be sequential. This property isvalid for all virtual reservations and vCloud Director. Thisproperty is not valid for physical reservations and cloudreservations other than vCloud Director, such as Amazonor Open Stack.

VMware.Hardware.Version Specifies the VM hardware version to be used for vSpheresettings. Supported values are currently vmx-04, vmx-07,vmx-08, vmx-09 and vmx-10. This property is applicablefor VM Create and VM Update workflows and is availableonly for basic workflow blueprints.

Custom Properties for Clone BlueprintsvCloud Automation Center includes custom properties that you can use to provide additional controls forclone blueprints.

Table 2‑2. Custom Properties for Clone Blueprints



VirtualMachine.NetworkN.ProfileName Specifies the name of a network profile from which toassign a static IP address to network device Nor fromwhich to obtain the range of static IP addresses that can beassigned to network device N of a cloned machine, whereN=0 for the first device, 1 for the second, and so on.If a network profile is specified in the network path in thereservation on which the machine is provisioned, a static IPaddress is assigned from that network profile. You canensure that a static IP address is assigned from a specificprofile by setting the value of this property to the name of anetwork profile.With WIM-based provisioning for virtual machines, youcan use this property to specify a network profile andnetwork interface or you can use the Network section ofthe Virtual Reservation page. You can also assign thenetwork interface to a virtual network using theVirtualMachine.NetworkN.Name custom property.


14 VMware, Inc.

Table 2‑2. Custom Properties for Clone Blueprints (Continued)


Linux.ExternalScript.Name Specifies the name of a customization script that the Linuxagent runs after the operating system is installed. Thisproperty is available for Linux machines cloned fromtemplates on which the Linux agent is installed.If you specify an external script, you must also define itslocation by using theLinux.ExternalScript.LocationType andLinux.ExternalScript.Path properties.

Linux.ExternalScript.LocationType Specifies the location type of the customization scriptnamed in the Linux.ExternalScript.Name property.This can be either local or nfs.You must also specify the script location using theLinux.ExternalScript.Path property. If the locationtype is nfs, also use the Linux.ExternalScript.Serverproperty.

Linux.ExternalScript.Server Specifies the name of the NFS server on which the Linuxexternal customization script named inLinux.ExternalScript.Name is located.

Linux.ExternalScript.Path Specifies the local path to the Linux customization script orthe export path to the Linux customization on the NFSserver. The value must begin with a forward slash and notinclude the file name.

If you installed the guest agent to customize cloned machines, you use some custom properties more oftenthan others.

Table 2‑3. Custom Properties for Customizing Cloned Machines with a Guest Agent


VirtualMachine.Admin.AddOwnerToAdmins Set to True to add the machine’s owner, as specified by theVirtualMachine.Admin.Owner property, to the localadministrators group on the machine.

VirtualMachine.Admin.AllowLogin Set to True (default) to add to the local remote desktopusers group the machine’s owner, as specified by theVirtualMachine.Admin.Owner property.

VirtualMachine.Admin.UseGuestAgent If the guest agent is installed as a service on a template forcloning, set to True on the machine blueprint to enable theguest agent service on machines cloned from that template.Set to False to disable the guest agent. If set to False, theenhanced clone workfow will not use the guest agent forguest operating system tasks, reducing its functionality toVMwareCloneWorkflow. If not specified or set to anythingother than False, the enhanced clone workflow will sendwork items to the guest agent.

VirtualMachine.DiskN.Active Set to True (default) to specify that the machine's disk N isactive. Set to False to specify that the machine's disk N isnot active.

Chapter 2 Custom Properties Grouped by Function

VMware, Inc. 15

Table 2‑3. Custom Properties for Customizing Cloned Machines with a Guest Agent (Continued)


VirtualMachine.DiskN.Size Defines the size in GB of disk N. For example, to give a sizeof 150 GB to a disk G, define the custom propertyVirtualMachine.Disk0.Size and enter a value of 150.Disk numbering must be sequential. By default a machinehas one disk referred to by VirtualMachine.Disk0.Size,where size is specified by the Storage option on the BuildInformation tab of the blueprint from which the machine isprovisioned. The value in the Storage option on the BuildInformation tab overwrites the value in theVirtualMachine.Disk0.Size property. TheVirtualMachine.Disk0.Size property is not available asa custom property because of its relationship with theStorage option on the Build Information tab. More diskscan be added by specifyingVirtualMachine.Disk1.Size,VirtualMachine.Disk2.Size and so on.VirtualMachine.Admin.TotalDiskUsage alwaysrepresents the total of the .DiskN.Size properties plus theVMware.Memory.Reservation size allocation.

VirtualMachine.DiskN.Label Specifies the label for a machine’s disk. The disk labelmaximum is 32 characters. Disk numbering must besequential. When used in conjunction with a guest agent,specifies the label of a machine's disk N inside the guestoperating system.

VirtualMachine.DiskN.Letter Specifies the drive letter or mount point of a machine’s diskN. The default is C. For example, to specify the letter D forDisk 1, define the custom property asVirtualMachine.Disk1.Letter and enter the value D.Disk numbering must be sequential. When used inconjunction with a guest agent, this value specifies thedrive letter or mount point under which an additional diskN is mounted by the guest agent in the guest operatingsystem.

VirtualMachine.Admin.CustomizeGuestOSDelay Specifies the time to wait after customization is completeand before starting the guest operating systemcustomization. The value must be in HH:MM:SS format. Ifthe value is not set, the default value is one minute(00:01:00). If the property does not exist, there is no delay.

VirtualMachine.Customize.WaitComplete Set to True to prevent the provisioning workflow fromsending work items to the guest agent until allcustomizations have been completed.

VirtualMachine.SoftwareN.Name Specifies the descriptive name of a software application orscript to install or run during provisioning. This is anoptional and information-only property. It serves no realfunction for the enhanced clone workflow or the guestagent but it is useful when for a custom software selectionin a user interface or for software usage reporting.


16 VMware, Inc.



VirtualMachine.Software0.ScriptPath Specifies the path to an application's install script. The pathmust be a valid absolute path as seen by the guestoperating system and must include the name of the scriptfile name.You can pass custom property values as parameters to thescript by inserting {CustomPropertyName} in the path string.For example, if you have a custom property namedActivationKey whose value is 1234, the script path isD:\InstallApp.bat –key {ActivationKey}. The guestagent runs the command D:\InstallApp.bat –key1234. Your script file can then be programmed to acceptand use this value.

VirtualMachine.SoftwareNISOName Specifies the path and file name of the ISO file relative tothe data store root. The formatis /folder_name/subfolder_name/file_name.iso. If avalue is not specified, the ISO is not mounted.

VirtualMachine.SoftwareNISOLocation Specifies the storage path that contains the ISO image fileto be used by the application or script. Format the path as itappears on the host reservation, for examplenetapp-1:it_nfs_1. If a value is not specified, the ISO isnot mounted.

Custom Properties for FlexClone BlueprintsvCloud Automation Center includes custom properties that you can use to provide additional controls forFlexClone blueprints.

Table 2‑4. Custom Properties for FlexClone Blueprints


VirtualMachine.NetworkN.ProfileName Specifies the name of a network profile from which toassign a static IP address to network device Nor fromwhich to obtain the range of static IP addresses that can beassigned to network device N of a cloned machine, whereN=0 for the first device, 1 for the second, and so on.If a network profile is specified in the network path in thereservation on which the machine is provisioned, a static IPaddress is assigned from that network profile. You canensure that a static IP address is assigned from a specificprofile by setting the value of this property to the name of anetwork profile.With WIM-based provisioning for virtual machines, youcan use this property to specify a network profile andnetwork interface or you can use the Network section ofthe Virtual Reservation page. You can also assign thenetwork interface to a virtual network using theVirtualMachine.NetworkN.Name custom property.



VMware, Inc. 17

Table 2‑4. Custom Properties for FlexClone Blueprints (Continued)





If you installed the guest agent to customize cloned machines, the Custom Properties for CustomizingFlexClone Machines with a Guest Agent table describes the most commonly used custom properties foryour situation.

Table 2‑5. Custom Properties for Customizing FlexClone Machines with a Guest Agent






18 VMware, Inc.

Table 2‑5. Custom Properties for Customizing FlexClone Machines with a Guest Agent (Continued)






Custom Properties for Linked Clone BlueprintsvCloud Automation Center includes custom properties that you can use to provide additional controls forlinked clone blueprints.

CertainvCloud Automation Center custom properties are required to use with linked clone blueprints.


VMware, Inc. 19

Table 2‑6. Custom Properties for Linked Clone Blueprints


VirtualMachine.DiskN.Storage Specifies that datastore on which to place the machine diskN. This property is also used to add a single datastore to alinked clone blueprint. N is the index (starting at 0) of thevolume to assign. Type the name of the datastore to assignto the volume in the Value text box. This is the datastorename as it appears in the Storage Path column on the EditCompute Resource page. Disk numbering must besequential.





MaximumProvisionedMachines Specifies the maximum number of linked clones for onemachine snapshot. The default is 20.


20 VMware, Inc.

Table 2‑6. Custom Properties for Linked Clone Blueprints (Continued)






If you installed the guest agent to customize cloned machines, you use some custom properties more oftenthan others.

Table 2‑7. Custom Properties for Customizing Cloned Machines with a Guest Agent





VMware, Inc. 21





Custom Properties for Linux Kickstart BlueprintsvCloud Automation Center includes custom properties that you can use to provide additional controls forLinux Kickstart blueprints.

CertainvCloud Automation Center custom properties are required to use with Linux Kickstart blueprints.

Table 2‑8. Required Custom Properties for Linux Kickstart Blueprints


VMware.VirtualCenter.OperatingSystem Specifies the vCenter Server guest operating systemversion (VirtualMachineGuestOsIdentifier) withwhich vCenter Server creates the machine. This operatingsystem version must match the operating system version tobe installed on the provisioned machine. Administratorscan create build profiles using one of several property sets,for example, VMware[OS_Version]Properties, that arepredefined to include the correctVMware.VirtualCenter.OperatingSystem values. Thisproperty is for virtual provisioning.For a list of currently accepted values, see theVMware vCenter Server documentation.

Image.ISO.Location Specifies the location of the ISO image to boot from. Theformat of this value depends on your platform. For details,see the documentation provided by your platform. Thisproperty is required for WIM-based provisioning, Linuxkickstart and autoYaST provisioning, and SCCM-basedprovisioning.

Image.ISO.Name Specifies the name of the ISO image from which to boot.The format of this value depends on your platform. Fordetails, see the documentation provided by your platform.This property is required for WIM-based provisioning,Linux kickstart and autoYaST provisioning, and SCCM-based provisioning.


22 VMware, Inc.

Table 2‑8. Required Custom Properties for Linux Kickstart Blueprints (Continued)


Image.ISO.UserName Specifies the user name to access the CIFS share in theformat username@domain. For Dell iDRAC integrationswhere the image is located on a CIFS share that requiresauthentication to access.

Image.ISO.Password Specifies the password associated with theImage.ISO.UserName property. For Dell iDRACintegrations where the image is located on a CIFS sharethat requires authentication to access.

You use some custom properties more often than others.

Table 2‑9. Common Custom Properties for Linux Kickstart Blueprints



Machine.SSH Set to True to enable the Connect Using SSH option forLinux machines provisioned from this blueprint. If set toTrue and the Connect using RDP or SSH machineoperation is enabled in the blueprint, all Linux machinesthat are provisioned from the blueprint display theConnect Using SSH option to entitled users.

Custom Properties for SCCM BlueprintsvCloud Automation Center includes custom properties that you can use to provide additional controls forSCCM blueprints.

Certain custom properties are required to use with SCCM blueprints.

Table 2‑10. Required Custom Properties for SCCM Blueprints







VMware, Inc. 23

Table 2‑10. Required Custom Properties for SCCM Blueprints (Continued)


SCCM.Collection.Name Specifies the name of the SCCM collection that contains theoperating system deployment task sequence.

SCCM.Server.Name Specifies the fully qualified domain name of the SCCMserver on which the collection resides.

SCCM.Server.SiteCode Specifies the site code of the SCCM server.

SCCM.Server.UserName Specifies a user name with administrator-level access to theSCCM server.

SCCM.Server.Password Specifies the password associated with theSCCM.Server.UserName property.

Certain custom properties are used most often with SCCM blueprints.

Table 2‑11. Common Custom Properties for SCCM Blueprints


SCCM.CustomVariable. Specifies the value of a custom variable, where Name is thename of any custom variable to be made available to theSCCM task sequence after the provisioned machine isregistered with the SCCM collection. The value isdetermined by your choice of custom variable.

For a full list of custom properties, see Custom Properties Reference.

Custom Properties for WIM BlueprintsvCloud Automation Center includes custom properties that you can use to provide additional controls forWIM blueprints.

CertainvCloud Automation Center custom properties are required to use with WIM blueprints.

Table 2‑12. Required Custom Properties for WIM Blueprints





24 VMware, Inc.

Table 2‑12. Required Custom Properties for WIM Blueprints (Continued)





Image.Network.Letter Specifies the drive letter to which the WIM image path ismapped on the provisioned machine. The default value isK.

Image.WIM.Path Specifies the UNC path to the WIM file from which animage is extracted during WIM-based provisioning, forexample \\server\share$.

Image.WIM.Name Specifies the name of the WIM file located by theImage.WIM.Path property.

Image.WIM.Index Specifies the index used to extract the desired image fromthe WIM file.

Image.Network.User Specifies the user name with which to map the WIM imagepath (Image.WIM.Path) to a network drive on theprovisioned machine. This is typically a domain accountwith access to the network share.

Image.Network.Password Specifies the password associated with theImage.Network.User property.

Custom properties are available for WIM Blueprints.

Table 2‑13. Common Custom Properties for WIM Blueprints


SysPrep. Specifies information to be added to the SysPrep answerfile on machines during the WinPE stage of provisioning.Information that already exists in the SysPrep answer file isoverwritten by these custom properties. Section representsthe name of the section of the SysPrep answer file, forexample GuiUnattended or UserData. Key represents akey name in the section. For example, to set the time zoneof a provisioned machine to West Pacific Standard Time,define the custom propertyGuiUnattended.UserData.TimeZone and set the value to275.For a full list of sections, keys, and accepted values, see theSystem Preparation Utility for Windows documentation.



VMware, Inc. 25

Custom Properties for vApp BlueprintsYou can add certain custom properties to a vApp or vApp component blueprint or build profile to allow avApp machine to join an Active Directory domain.

The Active Directory domain is supported for Windows machines. If the vApp machine contains Linux andWindows component machines, use a build profile to assign custom properties to the vApp componentblueprint associated with the Windows machines.

Table 2‑14. Custom Properties for vApp Blueprints


Sysprep.Identification.DomainAdmin Specifies a user name with administrator-level access to thetarget domain in Active Directory. Do not include the userdomain in the credentials that you send tovCloud Director.

Sysprep.Identification.DomainAdminPassword Specifies the password to associate with theSysprep.Identification.DomainAdmin property.

Sysprep.Identification.JoinDomain Specifies the name of the domain to join in ActiveDirectory.


VCloud.Lease.Sync.TimeBufferMins Specifies a threshold integer value for a compute resourcesuch that lease synchronization between vCloud DirectorandvCloud Automation Center will only occur forvCloud Director or VMware vCloud Air-provisionedmachines that are set to expire in vCloud Director orVMware vCloud Air in that time period. If a conflict isfound, the lease value is synchronized to match the leaselength defined invCloud Automation Center. The defaultVCloud.Lease.Sync.TimeBufferMins value is 720minutes, which is 12 hours. IfVCloud.Lease.Sync.TimeBufferMins is not present, thedefault value is used. For example, if the default values areused, vCloud Automation Center will run the leasesynchronization check workflow every 45 minutes, whichis the workflow default, and only the leases of machinesthat are set to expire within 12 hours are changed to matchthe lease length defined in vCloud Automation Center.


26 VMware, Inc.

Table 2‑14. Custom Properties for vApp Blueprints (Continued)


VCloud.Template.MakeIdenticalCopy Set to True to clone an identical copy of the vApp templatein vCloud Director and provision the results invCloud Automation Center. This ignores all settingsspecified in the blueprints except the name of the vAppand its virtual machines. The storage path specified in thevApp template during cloning is used, even if a differentstorage path is specified in a vApp component blueprint orwhen requesting a vApp machine.Set to False to clone a copy of the vApp template withsettings specified by the vApp and vApp componentblueprints. The storage path specified in a vAppcomponent blueprint, operating system or when requestinga vApp machine, is used if the Make Identical Copyoption in the vApp template properties was selected.

VMware.SCSI.Type For vApps, specifies the SCSI machine type using one ofthe 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.n VirtualSCSI Use para-virtualization emulation for the

virtual disk.n none Use if a SCSI controller does not exist for this

machine.

Custom Properties for NetworkingThe custom properties for networking specify configuration for a specific network device on a machine.

NOTE This information does not apply to Amazon Web Services.

By default a virtual machine has one network device configured with custom properties namedVirtualMachine.Network0.*. For example, the name of the network for the default network device isspecified in the VirtualMachine.Network0.Name property. Additional network devices can be configured onmachines by specifying properties named VirtualMachine.Network1.*, and so on.

The numbering of network properties must be sequential, starting with 0. For example, if you specifycustom properties for only VirtualMachine.Network0 and VirtualMachine.Network2, the properties forVirtualMachine.Network2 are ignored, because the preceding network, VirtualMachine.Network1 was notspecified.

Table 2‑15. Custom Properties for Networking Configuration


VirtualMachine.NetworkN.Address Specifies the IP address of a network device N in a machineprovisioned with a static IP address.

VirtualMachine.NetworkN.MacAddressType Indicates whether the MAC address of network device N isauto-generated or user-defined. This property is availablefor cloning.The default value is generated. If the value is static, youmust also use VirtualMachine.NetworkN.MacAddressto specify the MAC address.


VMware, Inc. 27

Table 2‑15. Custom Properties for Networking Configuration (Continued)


VirtualMachine.NetworkN.MacAddress Specifies the MAC address of a network device N. Thisproperty is available for cloning.If the value ofVirtualMachine.NetworkN.MacAddressType isgenerated, this property contains the generated address.If the value ofVirtualMachine.Network.N.MacAddressType isstatic, this property specifies the MAC address. Forvirtual machines provisioned on ESX server hosts, theaddress must be in the range specified by VMware. Fordetails, see vSphere documentation.

VirtualMachine.NetworkN.Name Specifies the network to which a network device N in avirtual machine is attached.By default, a network is assigned from the network pathsavailable on the reservation on which the machine isprovisioned.You can ensure that a network device is connected to aspecific network by setting the value of this property to thename of a network on an available reservation.

VirtualMachine.NetworkN.PortID Specifies the port ID to use for network device N whenusing a dvPort group with a vSphere distributed switch.

VirtualMachine.NetworkN.ProfileName Specifies the name of a network profile from which toassign a static IP address to network device Nor fromwhich to obtain the range of static IP addresses that can beassigned to network device N of a cloned machine, whereN=0 for the first device, 1 for the second, and so on.If a network profile is specified in the network path in thereservation on which the machine is provisioned, a static IPaddress is assigned from that network profile. You canensure that a static IP address is assigned from a specificprofile by setting the value of this property to the name of anetwork profile.

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.DnsSearchSuffixes

Configures attributes of the network profile specified inVirtualMachine.NetworkN.ProfileName.

Custom Properties for PXE ProvisioningPXE is the only provisioning method supported for Cisco UCS Manager. You can use the network bootstrapprogram, and, Optionally, custom properties to initiate WIM, SCCM, or Linux Kickstart provisioning. Youcan also use custom properties to call your own PowerShell scripts. Linux Kickstart provisioning does notrequire custom properties.

Custom Properties for Provisioning With PowerShell ScriptsYou can use these properties for calling custom PowerShell scripts.


28 VMware, Inc.

Table 2‑16. Custom Properties for Calling Custom PowerShell Scripts


Pxe.Setup.ScriptName Specifies a custom EPI PowerShell script to run on themachine before it is booted using the PXE network bootprogram. The value is the name assigned to the script whenit is uploaded to the model manager.

Pxe.Clean.ScriptName Specifies the name of an EPI PowerShell script installed inthe vCloud Automation Center Model Manager, to run onthe machine after it is provisioned. The value is the nameassigned to the script when it is uploaded to the ModelManager.

Custom Properties For PXE and SCCM ProvisioningYou can use these properties for PXE and SCCM provisioning.

Table 2‑17. Custom Properties for PXE and SCCM Provisioning


SCCM.Collection.Name Specifies the name of the SCCM collection that contains theoperating system deployment task sequence.

SCCM.Server.Name Specifies the fully qualified domain name of the SCCMserver on which the collection resides.


SCCM.Server.UserName Specifies a user name with administrator-level access to theSCCM server.


SCCM.CustomVariable. Specifies the value of a custom variable, where Name is thename of any custom variable to be made available to theSCCM task sequence after the provisioned machine isregistered with the SCCM collection. The value isdetermined by your choice of custom variable.

Custom Properties For PXE and WIM ProvisioningYou can use these properties for PXE and WIM provisioning.

Table 2‑18. Custom Properties for PXE and WIM Provisioning


Image.Network.Letter Specifies the drive letter to which the WIM image path ismapped on the provisioned machine. The default value isK.

Image.WIM.Path Specifies the UNC path to the WIM file from which animage is extracted during WIM-based provisioning, forexample \\server\share$.

Image.WIM.Name Specifies the name of the WIM file located by theImage.WIM.Path property.

Image.WIM.Index Specifies the index used to extract the desired image fromthe WIM file.

Image.Network.User Specifies the user name with which to map the WIM imagepath (Image.WIM.Path) to a network drive on theprovisioned machine. This is typically a domain accountwith access to the network share.


VMware, Inc. 29

Table 2‑18. Custom Properties for PXE and WIM Provisioning (Continued)


Image.Network.Password Specifies the password associated with theImage.Network.User property.

SysPrep. Specifies information to be added to the SysPrep answerfile on machines during the WinPE stage of provisioning.Information that already exists in the SysPrep answer file isoverwritten by these custom properties. Section representsthe name of the section of the SysPrep answer file, forexample GuiUnattended or UserData. Key represents akey name in the section. For example, to set the time zoneof a provisioned machine to West Pacific Standard Time,define the custom propertyGuiUnattended.UserData.TimeZone and set the value to275.For a full list of sections, keys, and accepted values, see theSystem Preparation Utility for Windows documentation.

Custom Properties for BMC BladeLogic Configuration ManagerIntegration

vCloud Automation Center includes custom properties that you can use to provide additional controls forBMC BladeLogic Configuration Manager integration.

Table 2‑19. Custom Properties Required for BMC BladeLogic Configuration Manager Integrations


VirtualMachine.EPI.Type Specifies the type of external provisioning infrastructure.

BMC.Software.Install Set to True to enable BMC BladeLogic integration.

EPI.Server.Name Specifies the name of the external provisioninginfrastructure server, for example, the name of the serverhosting BMC BladeLogic. If at least one general BMC EPIagent was installed without specifying a BMC BladeLogicConfiguration Manager host, this value directs the requestto the desired server.If only dedicated BMC EPI agents for specific BMCBladeLogic Configuration Manager hosts were installed,this value must exactly match the server name configuredfor one of these agents.

BMC.Service.Profile Specifies the name of the default authentication profile onthe BMC BladeLogic server.


30 VMware, Inc.

Table 2‑19. Custom Properties Required for BMC BladeLogic Configuration Manager Integrations(Continued)


BMC.Software.BatchLocation Specifies the location in BMC BladeLogic of software jobsto be deployed. This value must match either theappropriate field in Website\Software.txt or theappropriate value of VRM.Software.IdNNNN, dependingon the method used to prepare software jobs forintegration.


Custom Properties To Make BMC BladeLogic Configuration Manager SoftwareJobs Available

Configure BMC BladeLogic Configuration Manager jobs for vCloud Automation Center integrations. Makeall software jobs available to machine requesters to select from, or specify a software job to apply to allmachines provisioned from the blueprint.

Table 2‑20. Custom Properties to Make Software Jobs Available


LoadSoftware Set to True to make the software jobs listed inWebsite\Software.txt available to the user requestingthe machine.

VRM.Software.IdNNNN Specifies a software job or policy to be applied to allmachines provisioned from the blueprint. Set the value tojob_type=job_path, where job_type is the numeral thatrepresents the BMC BladeLogic job type and job_path isthe location of the job in BMC BladeLogic, for example4=/Utility/putty. NNNN is a number from 1000 to 1999.

1 — AuditJob2 — BatchJob3 — ComplianceJob4 — DeployJob5 — FileDeployJob6 — NSHScriptJob7 — PatchAnalysisJob8 — SnapshotJob

Optional Custom Properties for BMC BladeLogic Configuration ManagerIntegrations

You can also use optional custom properties that are commonly used with BMC BladeLogic ConfigurationManager blueprints.


VMware, Inc. 31

Table 2‑21. Optional Custom Properties for BMC BladeLogic Configuration Manager Integrations

Property Definition

BMC.AddServer.Delay Specifies the number of seconds to wait before adding themachine to BMC BladeLogic Configuration Manager. Thedefault is 30.

BMC.AddServer.Retry Specifies the number of seconds to wait before retrying ifthe first attempt to add the machine to BMC BladeLogicConfiguration Manager is unsuccessful. The default is 100.

Custom Properties for HP Server Automation IntegrationvCloud Automation Center includes custom properties that you can use to provide additional controls forHP Server Automation integration. Some custom properties are required for HP Server Automationintegration. Other custom properties are optional.

Required Custom Properties for HP Server Automation IntegrationCertain custom properties are required for a blueprint to work with HP Server Automation.

Table 2‑22. Required Custom Properties for HP Server Automation Integration

Property Definition

VMware.VirtualCenter.OperatingSystem Specifies the vCenter Server guest operating systemversion (VirtualMachineGuestOsIdentifier) withwhich vCenter Server creates the machine. This operatingsystem version must match the operating system version tobe installed on the provisioned machine. Administratorscan create build profiles using one of several property sets,for example, VMware[OS_Version]Properties, that arepredefined to include the correctVMware.VirtualCenter.OperatingSystem values. Thisproperty is for virtual provisioning.

VirtualMachine.EPI.Type Specifies the type of external provisioning infrastructure.

EPI.Server.Name Specifies the name of the external provisioninginfrastructure server, for example, the name of the serverhosting BMC BladeLogic. If at least one general BMC EPIagent was installed without specifying a BMC BladeLogicConfiguration Manager host, this value directs the requestto the desired server.

Opsware.Software.Install Set to True to allow HP Server Automation to installsoftware.

Opsware.Server.Name Specifies the fully qualified name of the HP ServerAutomation server.

Opsware.Server.Username Specifies the user name provided when a password file inthe agent directory was created. This user name requiresadministrative access to the HP Server Automationinstance, for example opswareadmin.

Opsware.BootImage.Name Specifies the boot image value as defined in HP ServerAutomation, for example winpe32 for the 32-bit WinPEimage. The property is not required when provisioning bycloning.

Opsware.Customer.Name Specifies a customer name value as defined in HP ServerAutomation, for example MyCompanyName.

Opsware.Facility.Name Specifies a facility name value as defined in HP ServerAutomation, for example Cambridge.


32 VMware, Inc.

Table 2‑22. Required Custom Properties for HP Server Automation Integration (Continued)

Property Definition

Opsware.Machine.Password Specifies the default local administrator password for anoperating system sequence WIM image such asOpsware.OSSequence.Name as defined in HP ServerAutomation, for example P@ssword1.

Opsware.OSSequence.Name Specifies the operating system sequence name value asdefined in HP Server Automation, for exampleWindows 2003 WIM.

Opsware.Realm.Name Specifies the realm name value as defined in HP ServerAutomation, for example Production.

Opsware.Register.Timeout Specifies the time, in seconds, to wait for creation of aprovisioning job to complete.

Opsware.WOL.Enabled Set to False for virtual provisioning.

Opsware.WOL.Delay Specifies the time, in seconds, to wait before runningWake-On-LAN. This setting is ignored ifOpsware.WOL.Enabled is set to False.

VirtualMachine.CDROM.Attach Set to False to provision the machine without a CD-ROMdevice. The default is True.

Linux.ExternalScript.Name Specifies the name of a customization script that the Linuxagent runs after the operating system is installed. Thisproperty is available for Linux machines cloned fromtemplates on which the Linux agent is installed.

Linux.ExternalScript.LocationType Specifies the location type of the customization scriptnamed in the Linux.ExternalScript.Name property.This can be either local or nfs.


Optional Custom Properties for HP Server Automation IntegrationCertain custom properties are optional for a blueprint to work with HP Server Automation.

Table 2‑23. Optional Custom Properties for HP Server Automation Integration

Property Definition

Opsware.ProvFail.Notify (Optional) Specifies the notification email address for HPServer Automation to use in the event of provisioningfailure.

Opsware.ProvFail.Notify (Optional) Specifies the HP Server Automation user toassign ownership to if provisioning fails, for exampleopswareadmin.

Opsware.ProvSuccess.Notify (Optional) Specifies the notification email address for HPServer Automation to use if provisioning is successful.

Opsware.ProvSuccess.Owner (Optional) Specifies the HP Server Automation user towhich to assign ownership if provisioning is successful, forexample opswareadmin.


VMware, Inc. 33

Custom Properties That Make HP Server Automation Software Jobs AvailableDepending on how your fabric administrator configures HP Server Automation jobs forvCloud Automation Center integration, you might have a choice between making all software jobs availableto machine requesters to select, or you can specify jobs to apply to all machines provisioned from yourblueprint.

Table 2‑24. Custom Properties to Make Software Jobs Available

Property Definition

LoadSoftware Set to True to make the software jobs listed inWebsite\Software.txt available to the user requestingthe machine.

VRM.Software.Id Optionally specify an HP Server Automation policy to beapplied to all machines provisioned from the blueprint.NNNN is a number from 1000 to 1999.


34 VMware, Inc.

Custom Properties Grouped by Name 3You can use custom properties to provide additional vCloud Automation Center controls.

These properties are also grouped functionally and described in relevant guides invCloud Automation Center product documentation. See Chapter 2, “Custom Properties Grouped byFunction,” on page 13.


n “Custom Properties A Table,” on page 36

n “Custom Properties B Table,” on page 36

n “Custom Properties C Table,” on page 36

n “Custom Properties E Table,” on page 37

n “Custom Properties H Table,” on page 38

n “Custom Properties I Table,” on page 38

n “Custom Properties L Table,” on page 39

n “Custom Properties M Table,” on page 40

n “Custom Properties O Table,” on page 40

n “Custom Properties P Table,” on page 41

n “Custom Properties R Table,” on page 42

n “Custom Properties S Table,” on page 42

n “Custom Properties V Table,” on page 44

n “Custom Properties X Table,” on page 60

VMware, Inc. 35

Custom Properties A TableThis section lists custom properties that begin with the letter A.

Table 3‑1. Custom Properties A Table

Property Description

AD.Lookup.Department Specifies the cost center value that is included in email sent to approvers tonotify them of pending approvals. The property value must be specified onthe blueprint form; it is not automatically populated on the blueprint.

Amazon.ElasticLoadBalancer.Names Assigns machines that are provisioned by a blueprint to the elastic loadbalancers that match the specified values.

Amazon.Instance.Id Specifies the Amazon instance ID of a machine provisioned on an AmaxonEC2 endpoint.

Custom Properties B TableThis section lists custom properties that begin with the letter B.

Table 3‑2. Custom Properties B Table

Property Definition

BMC.Service.Profile Specifies the name of the default authentication profile on the BMCBladeLogic server.

BMC.AddServer.Delay Specifies the number of seconds to wait before adding the machineto BMC BladeLogic Configuration Manager. The default is 30.

BMC.AddServer.Retry Specifies the number of seconds to wait before retrying if the firstattempt to add the machine to BMC BladeLogic ConfigurationManager is unsuccessful. The default is 100.

BMC.Software.Install Set to True to enable BMC BladeLogic integration.

BMC.Software.BatchLocation Specifies the location in BMC BladeLogic of software jobs to bedeployed. This value must match either the appropriate field inWebsite\Software.txt or the appropriate value ofVRM.Software.IdNNNN, depending on the method used to preparesoftware jobs for integration.

Custom Properties C TableThis section lists custom properties that begin with the letter C.

Table 3‑3. Custom Properties C Table

Property Definition

Cisco.Organization.DN The distinguished name of the Cisco UCS Manager organization inwhich Cisco USC machines provisioned by the business group areplaced, for example org-root/org-Engineering. If the specifiedorganization does not exist in the Cisco UCS Manager instancemanaging the machine, provisioning fails. This property is availablefor business groups only.

CloneFrom Specifies the name of an existing machine or virtualization platformobject to clone from, for example a template in vCenter Server. Thedefault is the value specified by the Clone from setting on theblueprint’s Build Information tab.


36 VMware, Inc.

Table 3‑3. Custom Properties C Table (Continued)

Property Definition

CloneSpec Specifies a cloned machine, for example a predefined SysPrep objectin vCenter Server. The default is the value specified by thecustomization setting on the blueprint’s Build Information tab.

Command.DiskPart.Options When you use WIM-based virtual provisioning on ESX server hosts,set to Align=64 to use the recommended alignment parameterswhen you format and partition the machine’s disk. This property isnot available for physical provisioning.

Command.FormatDisk.Options When you use WIM-based virtual provisioning on ESX server hosts,set to /A:32K to use the recommended alignment parameters whenyou format and partition the machine’s disk. This property is notavailable for physical provisioning.

Custom Properties E TableThis section lists custom properties that begin with the letter E.

Table 3‑4. Custom Properties E Table

Property Definition

EPI.Server.Name Specifies the name of the external provisioning infrastructure server, forexample, the name of the server hosting BMC BladeLogic. If at least onegeneral BMC EPI agent was installed without specifying a BMC BladeLogicConfiguration Manager host, this value directs the request to the desiredserver.If only dedicated BMC EPI agents for specific BMC BladeLogic ConfigurationManager hosts were installed, this value must exactly match the server nameconfigured for one of these agents.Specifies the name of the server hosting HP Server Automation. If at least onegeneral Opsware EPI agent was installed without specifying a serverautomation server, this value directs the request to the desired server.If only dedicated EPI agents for specific HP server automation servers wereinstalled, this value must exactly match the server name configured for one ofthese agents.If at least one general EPI agent of the appropriate type(VirtualMachine.EPI.Type) was installed without specifying a server, thisvalue directs the request to the desired server. If only dedicated EPI agentsfor specific servers of the appropriate type were installed, this value mustexactly match the server name configured for one of these agents.

EPI.Server.Port Specifies the port on which to contact the provisioning server. If you areusing a Citrix provisioning server, omit to specify the default port value of54321.

EPI.Server.VDiskName Specifies the name of the Citrix provisioning vDisk to provision from.

EPI.Server.Store Specifies the name of the Citrix provisioning store that contains the vDiskidentified by the EPI.Server.VDiskName property.

EPI.Server.Collection Specifies the name of the Citrix provisioning collection to which the machinewill be registered.

EPI.Server.Site Specifies the name of the Citrix provisioning site that contains the collectionand store identified by the EPI.Server.Collection andEPI.Server.Store properties.

Chapter 3 Custom Properties Grouped by Name

VMware, Inc. 37

Custom Properties H TableThis section lists custom properties that begin with the letter H.

Table 3‑5. Custom Properties H Table

Property Definition

Hyperv.Network.Type Specifies the network adapter type of the virtual machine. This property isvalid for use with Hyper-V only. The following values are available:n Synthetic (default)n This value is not available with Windows XP or Windows Server 2003 64-

bit guest operating systems.

Hostname Specifies the machine name, overriding the generated machine namecontained in the VirtualMachine.Admin.Name property. If Hostname is notused, the VirtualMachine.Admin.Name value is used as the machine name.This property is not valid for multi-machine blueprints.

Custom Properties I TableThis section lists custom properties that begin with the letter I.

Table 3‑6. Custom Properties I Table

Property Definition

Image.ISO.Location Specifies the location of the ISO image to boot from. The format of this valuedepends on your platform. For details, see the documentation provided byyour platform. This property is required for WIM-based provisioning, Linuxkickstart and autoYaST provisioning, and SCCM-based provisioning.For virtual provisioning with vCenter Server, this specifies the name of adatastore in the instance that will be accessible to the provisioning computeresource. For virtual provisioning with XenServer, this specifies the name of astorage repository.For physical provisioning, this specifies the HTTP URL of the web-accessiblelocation of the image.

Image.ISO.Name Specifies the name of the ISO image from which to boot. The format of thisvalue depends on your platform. For details, see the documentation providedby your platform. This property is required for WIM-based provisioning, Linuxkickstart and autoYaST provisioning, and SCCM-based provisioning.For virtual provisioning with vCenter Server, this svalue specifies the path tothe image in the datastore specified by Image.ISO.Location, forexample /MyISOs/Microsoft/MSDN/win2003.iso. The value must useforward slashes and begin with a forward slash. For virtual provisioning withXenServer, this value specifies the name of the image in the storage repositoryspecified by Image.ISO.Location. In virtual provisioning with Hyper-V, thisvalue specifies the full local path to the image.For physical provisioning, this value specifies the file name of the image.

Image.ISO.UserName Specifies the user name to access the CIFS share in the format [email protected] Dell iDRAC integrations where the image is located on a CIFS share thatrequires authentication to access.

Image.ISO.Password Specifies the password associated with the Image.ISO.UserName property. ForDell iDRAC integrations where the image is located on a CIFS share thatrequires authentication to access.

Image.WIM.Path Specifies the UNC path to the WIM file from which an image is extractedduring WIM-based provisioning, for example \\server\share$.

Image.WIM.Name Specifies the name of the WIM file located by the Image.WIM.Path property.

Image.WIM.Index Specifies the index used to extract the desired image from the WIM file.


38 VMware, Inc.

Table 3‑6. Custom Properties I Table (Continued)

Property Definition

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. This istypically a domain account with access to the network share.

Image.Network.Password Specifies the password associated with the Image.Network.User property.

Image.Network.Letter Specifies the drive letter to which the WIM image path is mapped on theprovisioned machine. The default value is K.

Infrastructure.Admin.MachineObjectOU

Specifies the organizational unit (OU) of the machine. When machines areplaced in the required OU by the business group OU setting, this property isnot required.

Infrastructure.ResourcePool.Name

Specifies the resource pool to which the machine belongs, if any. The default isthe value specified in the reservation from which the machine was provisioned.

Infrastructure.Admin.DefaultDomain

Specifies the default domain on the machine.

Infrastructure.Admin.ADUser Specifies the user name that the machine uses to query Active Directory usersand groups when an anonymous bind cannot be used.

Infrastructure.Admin.ADPassword Specifies the password associated with the Infrastructure.Admin.ADUseruser name.

Custom Properties L TableThis section lists custom properties that begin with the letter L.

Table 3‑7. Custom Properties L Table


Linux.ExternalScript.Name Specifies the name of a customization script that the Linux agentruns after the operating system is installed. This property isavailable for Linux machines cloned from templates on whichthe Linux agent is installed.If you specify an external script, you must also define its locationby using the Linux.ExternalScript.LocationType andLinux.ExternalScript.Path properties.

Linux.ExternalScript.LocationType Specifies the location type of the customization script named inthe Linux.ExternalScript.Name property. This can be eitherlocal or nfs.You must also specify the script location using theLinux.ExternalScript.Path property. If the location type isnfs, also use the Linux.ExternalScript.Server property.

Linux.ExternalScript.Server Specifies the name of the NFS server on which the Linux externalcustomization script named in Linux.ExternalScript.Name islocated.

Linux.ExternalScript.Path Specifies the local path to the Linux customization script or theexport path to the Linux customization on the NFS server. Thevalue must begin with a forward slash and not include the filename.

LoadSoftware Set to True to make the software jobs listed inWebsite\Software.txt available to the user requesting themachine.


VMware, Inc. 39

Custom Properties M TableThis section lists custom properties that begin with the letter M.

Table 3‑8. Custom Properties M Table


MaximumProvisionedMachines Specifies the maximum number of linked clones for one machinesnapshot. The default is 20.

Machine.SSH Set to True to enable the Connect Using SSH option for Linuxmachines provisioned from this blueprint. If set to True and theConnect using RDP or SSH machine operation is enabled in theblueprint, all Linux machines that are provisioned from the blueprintdisplay the Connect Using SSH option to entitled users.

MaximumProvisionedMachines Specifies the number of machines that you can provision across allusers based on a given blueprint. Most blueprint types are unlimitedby default. Linked clone blueprints have a default maximum of 20machines.

Custom Properties O TableThis section lists custom properties that begin with the letter O.

Table 3‑9. Custom Properties O Table


Opsware.Software.Install Set to True to allow HP Server Automation to install software.

Opsware.Server.Name Specifies the fully qualified name of the HP Server Automationserver.

Opsware.Server.Username Specifies the user name provided when a password file in the agentdirectory was created. This user name requires administrativeaccess to the HP Server Automation instance, for exampleopswareadmin.

Opsware.BootImage.Name Specifies the boot image value as defined in HP Server Automation,for example winpe32 for the 32-bit WinPE image. The property isnot required when provisioning by cloning.

Opsware.Customer.Name Specifies a customer name value as defined in HP ServerAutomation, for example MyCompanyName.

Opsware.Facility.Name Specifies a facility name value as defined in HP Server Automation,for example Cambridge.

Opsware.Machine.Password Specifies the default local administrator password for an operatingsystem sequence WIM image such as Opsware.OSSequence.Nameas defined in HP Server Automation, for example P@ssword1.

Opsware.OSSequence.Name Specifies the operating system sequence name value as defined inHP Server Automation, for example Windows 2003 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 provisioningjob to complete.

Opsware.WOL.Enabled Set to False for virtual provisioning.

Opsware.WOL.Delay Specifies the time, in seconds, to wait before running Wake-On-LAN. This setting is ignored if Opsware.WOL.Enabled is set toFalse.


40 VMware, Inc.

Table 3‑9. Custom Properties O Table (Continued)


Opsware.ProvFail.Notify (Optional) Specifies the notification email address for HP ServerAutomation to use in the event of provisioning failure.

Opsware.ProvFail.Owner (Optional) Specifies the HP Server Automation user to assignownership to if provisioning fails, for example opswareadmin.

Opsware.ProvSuccess.Notify (Optional) Specifies the notification email address for HP ServerAutomation to use if provisioning is successful.

Opsware.ProvSuccess.Owner (Optional) Specifies the HP Server Automation user to which toassign ownership if provisioning is successful, for exampleopswareadmin.

Custom Properties P TableThis section lists custom properties that begin with the letter P.

Table 3‑10. Custom Properties P Table


Plugin.AdMachineCleanup.Execute Set to True to enable the Active Directory cleanup plug-in. By default,each machine’s account is disabled when it is destroyed.

Plugin.AdMachineCleanup.UserName Specifies an Active Directory account user name with sufficientprivileges to delete, disable, rename, or move Active Directory accounts.The value must be in domain\username format. This property is requiredif the vCloud Automation Center manager service does not have theserights in a domain, which can occur when you provision machines inmore than one domain.

Plugin.AdMachineCleanup.Password Specifies the password associated to thePlugin.AdMachineCleanup.UserName property. For security, select theEncrypt check box in the user interface.

Plugin.AdMachineCleanup.Delete Set to True to delete the accounts of destroyed machines, instead ofdisabling them.

Plugin.AdMachineCleanup.Domain Specifies the Active Directory domain name that contains the machineaccount to be destroyed.

Plugin.AdMachineCleanup.MoveToOu Moves the account of destroyed machines to a new Active Directoryorganizational unit. The value is the organization unit to which you aremoving the account. This value must be in ou=OU, dc=dc format .

Plugin.AdMachineCleanup.RenamePrefix Renames the accounts of destroyed machines by adding a prefix. Thevalue is the prefix string to prepend, for example destroyed_.

Pxe.Setup.ScriptName Specifies a custom EPI PowerShell script to run on the machine before itis booted using the PXE network boot program. The value is the nameassigned to the script when it is uploaded to the model manager.

Pxe.Clean.ScriptName Specifies the name of an EPI PowerShell script installed in thevCloud Automation Center Model Manager, to run on the machine afterit is provisioned. The value is the name assigned to the script when it isuploaded to the Model Manager.


VMware, Inc. 41

Custom Properties R TableThis section lists custom properties that begin with the letter R.

Table 3‑11. Custom Properties R Table


RDP.File.Name Specifies an RDP file from which to obtain settings, for exampleMy_RDP_Settings.rdp. The file must reside in the Website\Rdpsubdirectory of the vCloud Automation Center installation directory.

Custom Properties S TableThis section lists custom properties that begin with the letter S.

Table 3‑12. Custom Properties S Table


Sysprep.Identification.DomainAdmin Specifies a user name with administrator-levelaccess to the target domain in Active Directory. Donot include the user domain in the credentials thatyou send to vCloud Director.

Sysprep.Identification.DomainAdminPassword Specifies the password to associate with theSysprep.Identification.DomainAdminproperty.

Sysprep.Identification.JoinDomain Specifies the name of the domain to join in ActiveDirectory.


42 VMware, Inc.

Table 3‑12. Custom Properties S Table (Continued)


SysPrep.Section.Key Specifies information to be added to the SysPrepanswer file on machines during the WinPE stage ofprovisioning. Information that already exists in theSysPrep answer file is overwritten by these customproperties. Section represents the name of thesection of the SysPrep answer file, for exampleGuiUnattended or UserData. Key represents a keyname in the section. For example, to set the timezone of a provisioned machine to West PacificStandard Time, define the custom propertyGuiUnattended.UserData.TimeZone and set thevalue to 275.For a full list of sections, keys, and accepted values,see the System Preparation Utility for Windowsdocumentation.The following Section.Key combinations can bespecified for WIM-based provisioning:n GuiUnattended

n AdminPasswordn EncryptedAdminPasswordn TimeZone

n UserDatan ProductKeyn FullNamen ComputerNamen OrgName

n Identificationn DomainAdminn DomainAdminPasswordn JoinDomainn JoinWorkgroup

SCCM.Collection.Name Specifies the name of the SCCM collection thatcontains the operating system deployment tasksequence.

SCCM.Server.Name Specifies the fully qualified domain name of theSCCM server on which the collection resides.


SCCM.Server.UserName Specifies a user name with administrator-levelaccess to the SCCM server.


SCCM.CustomVariable.Name Specifies the value of a custom variable, whereName is the name of any custom variable to bemade available to the SCCM task sequence after theprovisioned machine is registered with the SCCMcollection. The value is determined by your choiceof custom variable.


VMware, Inc. 43

Table 3‑12. Custom Properties S Table (Continued)


Snapshot.Policy.AgeLimit Sets the age limit, in days, for snapshots that can beapplied to machines.When a snapshot exceeds the age limit, the Applyoption is no longer available.

Snapshot.Policy.Limit Sets the number of snapshots allowed per machine.The default setting is one snapshot per machine.Snapshots are shown in a hierarchical structure.n Depth – Maximum is 31n Width – There is no limit

Custom Properties V TableThis section lists custom properties that begin with the letter V.

Table 3‑13. Custom Properties V Table


VirtualMachine.Admin.UseGuestAgent If the guest agent is installed as a service ona template for cloning, set to True on themachine blueprint to enable the guest agentservice on machines cloned from thattemplate. Set to False to disable the guestagent. If set to False, the enhanced cloneworkfow will not use the guest agent forguest operating system tasks, reducing itsfunctionality to VMwareCloneWorkflow. Ifnot specified or set to anything other thanFalse, the enhanced clone workflow willsend work items to the guest agent.

VirtualMachine.Admin.NameCompletion Specifies the domain name to include in thefully qualified domain name of the machinethat the RDP files generate for the ConnectUsing RDP option. For example, set thevalue to myCompany.com to generate thefully qualified domain name my-machine-name.myCompany.com in the RDP file.

VirtualMachine.Admin.ConnectionAddress Specifies the RDP connection address of themachine to which an RDP file isdownloaded when the Connect Using RDPoption is used or attached to automaticemails. Do not use in a blueprint or buildprofile unless Prompt User is enabled andno default value is supplied.

VirtualMachine.Admin.ThinProvision Determines whether thin provisioning isused on ESX compute resources using localor iSCSI storage. Set to True to use thinprovisioning. Set to False to use standardprovisioning. This property is for virtualprovisioning.

VirtualMachine.Admin.CustomizeGuestOSDelay Specifies the time to wait after customizationis complete and before starting the guestoperating system customization. The valuemust be in HH:MM:SS format. If the value isnot set, the default value is one minute(00:01:00). If the property does not exist,there is no delay.


44 VMware, Inc.

Table 3‑13. Custom Properties V Table (Continued)


VirtualMachine.Admin.NetworkInterfaceType Indicates the network interface type. Use tomodify the network settings of a newlyprovisioned virtual machine. The followingoptions are available:n E1000 (default)n VirtIOn RTL8139n RTL8139 VirtIOThis property is for virtual provisioning.

VirtualMachine.Admin.Name Specifies the generated machine name. Youcan use this property can be used whencreating custom workflows or plug-ins. Thevalue in the blueprint or build profile has noeffect on this property.

VirtualMachine.Admin.UUID Specifies the UUID of the machine. Thevalue is recorded by the guest agent whenthe machine is created, then it becomes read-only. The value in the blueprint or buildprofile has no effect on this property.

VirtualMachine.Admin.AgentID Specifies the UUID of the guest agent. Thevalue is recorded by the guest agent whenthe machine is created, then it becomes read-only. The value in the blueprint or buildprofile has no effect on this property.

VirtualMachine.Admin.Owner Specifies the user name of the machineowner.

VirtualMachine.Admin.Approver Specifies the user name of the groupmanager who approved the machinerequest.

VirtualMachine.Admin.Description Specifies the description of the machine asentered or modified by its owner or anadministrator.

VirtualMachine.Admin.AdministratorEmail Specifies the manager email addresses orActive Directory accounts for the businessgroup of the provisioning blueprint.Multiple email addresses are separated by acomma, for example [email protected],[email protected].

VirtualMachine.Admin.TotalDiskUsage Specifies the total disk space that themachine uses, including all disks asspecified by theVirtualMachine.DiskN.Size propertiesand the swap file as specified by theVMware.Memory. Reservation property.

VirtualMachine.Admin.Hostname Specifies the name of the compute resourceon which the machine resides.

VirtualMachine.Admin.ClusterName Specifies the name of the cluster thatcontains the compute resource on which themachine resides.

VirtualMachine.Admin.ApplicationID List the application IDs that can be assignedto a machine.


VMware, Inc. 45



VirtualMachine.Admin.AddOwnerToAdmins Set to True to add the machine’s owner, asspecified by theVirtualMachine.Admin.Owner property,to the local administrators group on themachine.This property is not available forprovisioning by cloning.

VirtualMachine.Admin.AllowLogin Set to True (default) to add to the localremote desktop users group the machine’sowner, as specified by theVirtualMachine.Admin.Owner property.

VirtualMachine.Admin.DiskInterfaceType Indicates the type of disk drivers. Thefollowing disk drivers are supported:n IDE (default)n VirtIO

This property is for virtual provisioning.

VirtualMachine.Agent.CopyToDisk Set to True (default) to copy the guest agentexecutable file to %SystemDrive%\VRM\Build\Bin on the machine’s disk.

VirtualMachine.Agent.GuiRunOnce Set to False for the Linux agent to stop theprovisioning workflow. This property is forkickstart provisioning with Linux orAutoYaST.

VirtualMachine.Agent.Reboot Set to True (default) to specify that the guestagent restarts the machine followinginstallation of the guest operating system.

VirtualMachine.CDROM.Attach Set to False to provision the machinewithout a CD-ROM device. The default isTrue.

VirtualMachine.CPU.Count Specifies the number of CPUs allocated to amachine. The default is the value specifiedby the # CPUs setting on the blueprint’sBuild Information tab.

VirtualMachine.Customize.WaitComplete Set to True to prevent the provisioningworkflow from sending work items to theguest agent until all customizations havebeen completed.

VirtualMachine.DiskN.Letter Specifies the drive letter or mount point of amachine’s disk N. The default is C. Forexample, to specify the letter D for Disk 1,define the custom property asVirtualMachine.Disk1.Letter and enterthe value D. Disk numbering must besequential. When used in conjunction with aguest agent, this value specifies the driveletter or mount point under which anadditional disk N is mounted by the guestagent in the guest operating system.


46 VMware, Inc.



VirtualMachine.DiskN.Size Defines the size in GB of disk N. Forexample, to give a size of 150 GB to a disk G,define the custom propertyVirtualMachine.Disk0.Size and enter avalue of 150. Disk numbering must besequential. By default a machine has onedisk referred to byVirtualMachine.Disk0.Size, where sizeis specified by the Storage option on theBuild Information tab of the blueprint fromwhich the machine is provisioned. The valuein the Storage option on the BuildInformation tab overwrites the value in theVirtualMachine.Disk0.Size property.The VirtualMachine.Disk0.Sizeproperty is not available as a customproperty because of its relationship with theStorage option on the Build Informationtab. More disks can be added by specifyingVirtualMachine.Disk1.Size,VirtualMachine.Disk2.Size and so on.VirtualMachine.Admin.TotalDiskUsagealways represents the total ofthe .DiskN.Size properties plus theVMware.Memory.Reservation sizeallocation.

VirtualMachine.DiskN.Label Specifies the label for a machine’s disk. Thedisk label maximum is 32 characters. Disknumbering must be sequential. When usedin conjunction with a guest agent, specifiesthe label of a machine's disk N inside theguest operating system.

VirtualMachine.DiskN.Active Set to True (default) to specify that themachine's disk N is active. Set to False tospecify that the machine's disk N is notactive.

VirtualMachine.DiskN.FS Specifies the file system of the machine’sdisk N. The options are NTFS (default), FATand FAT32.

VirtualMachine.DiskN.Percent Specifies the percentage of the disk N to beformatted by a guest agent for the machine’suse. That machine cannot use the remainingportion of the disk.

VirtualMachine.DiskN.StorageReservationPolicy Specifies a storage reservation policy to findstorage for disk N. Also assigns a storagereservation policy to a volume. To use thisproperty, substitute the volume number forN in the property name and specify astorage reservation policy as the value. Thisproperty is equivalent to the StorageReservation Policy drop-down menu in theVolumes list on the Build Information tabof the blueprint page. Disk numbering mustbe sequential. This property is valid for allvirtual reservations and vCloud Director.This property is not valid for physicalreservations and cloud reservations otherthan vCloud Director, such as Amazon orOpen Stack.


VMware, Inc. 47



VirtualMachine.DiskN.StorageReservationPolicyMode Allocates disk N to the best available storagereservation policy.

VirtualMachine.DiskN.Storage Specifies that datastore on which to place themachine disk N. This property is also usedto add a single datastore to a linked cloneblueprint. N is the index (starting at 0) of thevolume to assign. Type the name of thedatastore to assign to the volume in theValue text box. This is the datastore name asit appears in the Storage Path column on theEdit Compute Resource page. Disknumbering must be sequential.

VirtualMachine.DiskN.VMwareType Specifies the VMware disk mode of themachine’s diskN. The following options areavailable:n persistentn independent_persistentn independent_nonpersistentFor details, seeVirtualDeviceDeviceBackingOptiondata object help.

VirtualMachine.Host.TpmEnabled Limits virtual machine placement to hoststhat have a Trust Protection Module (TPM)device installed and recognized by ESX andvSphere. The default value is False.All hosts in a cluster must have a TrustProtection Module device installed. If noacceptable hosts or clusters are found, themachine cannot be provisioned until thisproperty is removed.

VirtualMachine.Rdp.File Specifies the RDP file that contains settingsto be used when opening an RDP link to themachine. Can be used together with, or as analternative to,VirtualMachine.Rdp.SettingN. The filemust be located invCAC_installation_dir\Website\Rdpwhere vCAC_install_dir is the server installdirectory, for example %SystemDrive%\Program Filesx86\VMware\vCAC\Server\Rdp\console.rdp.You must create the Rdp directory.

VirtualMachine.Memory.Size Specifies the size of the machine's memoryin MB. The default is the value specified bythe Memory option on the blueprint’s BuildInformation tab.

VirtualMachine.EPI.Type Specifies the type of external provisioninginfrastructure.Set to BMC for BMC BladeLogic integration.Set to CitrixProvisioning for Citrixprovisioning server integration.


48 VMware, Inc.



VirtualMachine.NetworkN.Address Specifies the IP address of a network deviceN in a machine provisioned with a static IPaddress.VirtualMachine.NetworkN customproperties are designed to be specific toindividual blueprints and machines. When amachine is requested, network and IPaddress allocation is performed before themachine is assigned to a reservation.Because blueprints are not guaranteed to beallocated to a specific reservation, do not usethis property on a reservation.

VirtualMachine.NetworkN.MacAddressType Indicates whether the MAC address ofnetwork device N is auto-generated or user-defined. This property is available forcloning.The default value is generated. If the valueis static, you must also useVirtualMachine.NetworkN.MacAddressto specify the MAC address.VirtualMachine.NetworkN customproperties are designed to be specific toindividual blueprints and machines. When amachine is requested, network and IPaddress allocation is performed before themachine is assigned to a reservation.Because blueprints are not guaranteed to beallocated to a specific reservation, do not usethis property on a reservation.

VirtualMachine.NetworkN.MacAddress Specifies the MAC address of a networkdevice N. This property is available forcloning.If the value ofVirtualMachine.NetworkN.MacAddressType is generated, this property contains thegenerated address.If the value ofVirtualMachine.Network.N.MacAddressType is static, this property specifies theMAC address. For virtual machinesprovisioned on ESX server hosts, the addressmust be in the range specified by VMware.For details, see vSphere documentation.VirtualMachine.NetworkN customproperties are designed to be specific toindividual blueprints and machines. When amachine is requested, network and IPaddress allocation is performed before themachine is assigned to a reservation.Because blueprints are not guaranteed to beallocated to a specific reservation, do not usethis property on a reservation.


VMware, Inc. 49



VirtualMachine.NetworkN.Name Specifies the network to which a networkdevice N in a virtual machine is attached.By default, a network is assigned from thenetwork paths available on the reservationon which the machine is provisioned.You can ensure that a network device isconnected to a specific network by settingthe value of this property to the name of anetwork on an available reservation.VirtualMachine.NetworkN customproperties are designed to be specific toindividual blueprints and machines. When amachine is requested, network and IPaddress allocation is performed before themachine is assigned to a reservation.Because blueprints are not guaranteed to beallocated to a specific reservation, do not usethis property on a reservation.

VirtualMachine.NetworkN.PortID Specifies the port ID to use for networkdevice N when using a dvPort group with avSphere distributed switch.VirtualMachine.NetworkN customproperties are designed to be specific toindividual blueprints and machines. When amachine is requested, network and IPaddress allocation is performed before themachine is assigned to a reservation.Because blueprints are not guaranteed to beallocated to a specific reservation, do not usethis property on a reservation.

VirtualMachine.NetworkN.NetworkProfileName

orVirtualMachine.Network{N}.NetworkProfileName

Specifies a network profile in which to getan IP address and directly connect to thecorresponding attached network of a givencompute resource.


50 VMware, Inc.



VirtualMachine.NetworkN.ProfileName Specifies the name of a network profile fromwhich to assign a static IP address tonetwork device Nor from which to obtainthe range of static IP addresses that can beassigned to network device N of a clonedmachine, where N=0 for the first device, 1 forthe second, and so on.If a network profile is specified in thenetwork path in the reservation on whichthe machine is provisioned, a static IPaddress is assigned from that networkprofile. You can ensure that a static IPaddress is assigned from a specific profile bysetting the value of this property to thename of a network profile.Note that changing this property value afterthe network is assigned has no effect on theexpected IP address values for thedesignated machines.With WIM-based provisioning for virtualmachines, you can use this property tospecify a network profile and networkinterface or you can use the Network sectionof the Virtual Reservation page. You can alsoassign the network interface to a virtualnetwork using theVirtualMachine.NetworkN.Name customproperty.With WIM-based provisioning for physicalmachines, you must specify the networkprofile with theVirtualMachine.NetworkN.ProfileNamecustom property. You must also specify avalue with theVirtualMachine.NetworkN.Name customproperty, althoughvCloud Automation Center does not use thevalue.The following attributes of the networkprofile are available to enable static IPassignment in a cloning blueprint:n VirtualMachine.NetworkN.SubnetMa

sk








VirtualMachine.NetworkN customproperties are designed to be specific toindividual blueprints and machines. When amachine is requested, network and IP


VMware, Inc. 51



address allocation is performed before themachine is assigned to a reservation.Because blueprints are not guaranteed to beallocated to a specific reservation, do not usethis property on a reservation.

n VirtualMachine.NetworkN.SubnetMask








Configures attributes of the network profilespecified inVirtualMachine.NetworkN.ProfileName.VirtualMachine.NetworkN customproperties are designed to be specific toindividual blueprints and machines. When amachine is requested, network and IPaddress allocation is performed before themachine is assigned to a reservation.Because blueprints are not guaranteed to beallocated to a specific reservation, do not usethis property on a reservation.

VirtualMachine.Rdp.SettingN Configures specific RDP settings. N is aunique number used to distinguish one RDPsetting from another. For example, to specifythe Authentication Level so that noauthentication requirement is specified,define the custom propertyVirtualMachine.Rdp.Setting1 and setthe value authentication level:i:3.For a list of available settings and correctsyntax, see the Microsoft Windows RDPdocumentation.

VirtualMachine.Request.Layout Specifies the property layout to be used inthe virtual machine request page. The valuemust match the name of the layout to beused.

VirtualMachine.SoftwareN.Name Specifies the descriptive name of a softwareapplication or script to install or run duringprovisioning. This is an optional andinformation-only property. It serves no realfunction for the enhanced clone workflow orthe guest agent but it is useful when for acustom software selection in a user interfaceor for software usage reporting.

VirtualMachine.Software0.ScriptPath Specifies the path to an application's installscript. The path must be a valid absolutepath as seen by the guest operating systemand must include the name of the script filename.You can pass custom property values asparameters to the script by inserting{CustomPropertyName} in the path string. Forexample, if you have a custom propertynamed ActivationKey whose value is1234, the script path is D:\InstallApp.bat–key {ActivationKey}. The guest agentruns the command D:\InstallApp.bat –key 1234. Your script file can then beprogrammed to accept and use this value.Insert {Owner} to pass the machine ownername to the script.


52 VMware, Inc.



VirtualMachine.SoftwareNISOName Specifies the path and file name of the ISOfile relative to the data store root. The formatis /folder_name/subfolder_name/file_name.iso. If a value is not specified, the ISOis not mounted.

VirtualMachine.SoftwareNISOLocation Specifies the storage path that contains theISO image file to be used by the applicationor script. Format the path as it appears onthe host reservation, for examplenetapp-1:it_nfs_1. If a value is notspecified, the ISO is not mounted.

VirtualMachine.Storage.Name Identifies the storage path on which themachine resides. The default is the valuespecified in the reservation that was used toprovision the machine.

VirtualMachine.VDI.Type Specifies the type of virtual desktopinfrastructure.For XenDesktop provisioning, set toXenDesktop.

VbScript.PreProvisioning.Name Specifies the full path of a Visual Basic scriptto be run before a machine is provisioned.For example, %System-Drive%\ProgramFiles(x86)\VMware\vCACAgents\EPI_Agent\Scripts\SendEmail.vbs. The script file must reside on thesystem on which the Visual Basic script EPIagent is installed.

VbScript.PostProvisioning.Name Specifies the full path of a Visual Basic scriptto be run after a machine is provisioned. Forexample, %System-Drive%\ProgramFiles(x86)\VMware\vCACAgents\EPI_Agent\Scripts\SendEmail.vbs. The script file must reside on thesystem on which the Visual Basic script EPIagent is installed.

VbScript.UnProvisioning.Name Specifies the full path of a Visual Basic scriptto be run when a machine is destroyed. Forexample, %System-Drive%\Program Files(x86)\VMware\vCACAgents\EPI_Agent\Scripts\SendEmail.vb. The script file must reside on the systemon which the Visual Basic script EPI agent isinstalled.


VMware, Inc. 53



VCloud.Lease.Sync.TimeBufferMins Specifies a threshold integer value for acompute resource such that leasesynchronization between vCloud DirectorandvCloud Automation Center will onlyoccur for vCloud Director orVMware vCloud Air-provisioned machinesthat are set to expire in vCloud Director orVMware vCloud Air in that time period. If aconflict is found, the lease value issynchronized to match the lease lengthdefined invCloud Automation Center. ThedefaultVCloud.Lease.Sync.TimeBufferMinsvalue is 720 minutes, which is 12 hours. IfVCloud.Lease.Sync.TimeBufferMins isnot present, the default value is used. Forexample, if the default values are used,vCloud Automation Center will run thelease synchronization check workflow every45 minutes, which is the workflow default,and only the leases of machines that are setto expire within 12 hours are changed tomatch the lease length defined invCloud Automation Center.

VCloud.Template.MakeIdenticalCopy Set to True to clone an identical copy of thevApp template in vCloud Director andprovision the results invCloud Automation Center. This ignores allsettings specified in the blueprints except thename of the vApp and its virtual machines.The storage path specified in the vApptemplate during cloning is used, even if adifferent storage path is specified in a vAppcomponent blueprint or when requesting avApp machine.Set to False to clone a copy of the vApptemplate with settings specified by the vAppand vApp component blueprints. Thestorage path specified in a vApp componentblueprint, operating system or whenrequesting a vApp machine, is used if theMake Identical Copy option in the vApptemplate properties was selected.

VCloud.Lease.Sync.TimeBufferMin Specifies a threshold integer for a computeresource such that lease synchronizationonly occurs for machines that are set toexpire in that time period. The default valueis 720 minutes.


54 VMware, Inc.



VCNS.SecurityGroup.Names.name Specifies thevCloud Networking and Security securitygroup or groups to which the virtualmachine is assigned during provisioning.The value is a security group name or a listof names separated by commas. Names arecase-sensitive.Appending a name allows you to createmultiple versions of the property, which canbe used separately or in combination. Forexample, the following properties might listsecurity groups intended for general use, forthe sales force, and for support:n VCNS.SecurityGroup.Names

n VCNS.SecurityGroup.Names.sales

n VCNS.SecurityGroup.Names.support

VCNS.LoadBalancerEdgePool.Names.name Specifies thevCloud Networking and Security loadbalancing pools to which the virtualmachine is assigned during provisioning.The virtual machine is assigned to all serviceports of all specified pools. The value is anedge/pool name or a list of edge/pool namesseparated by commas. Names are case-sensitive.Appending a name allows you to createmultiple versions of a custom property. Forexample, the following properties might listload balancing pools set up for general useand machines with high, moderate, and lowperformance requirements:n VCNS.LoadBalancerEdgePool.Names

n VCNS.LoadBalancerEdgePool.Names.moderate

n VCNS.LoadBalancerEdgePool.Names.high

n VCNS.LoadBalancerEdgePool.Names.low

VMware.AttributeN.Name Specifies the name of an attribute invCenter Orchestrator. Replace the letter Nwith a number, starting with 0 andincreasing for each attribute to set.

VMware.AttributeN.Value Specifies the value of the attribute used inthe VMware.AttributeN.Name property.Replace the letter N with a number, startingwith 0 and increasing for each attribute toset.

VMware.Hardware.Version Specifies the VM hardware version to beused for vSphere settings. Supported valuesare currently vmx-04, vmx-07, vmx-08,vmx-09 and vmx-10. This property isapplicable for VM Create and VM Updateworkflows and is available only for basicworkflow blueprints.


VMware, Inc. 55



VMware.VirtualCenter.OperatingSystem Specifies the vCenter Server guest operatingsystem version(VirtualMachineGuestOsIdentifier)with which vCenter Server creates themachine. This operating system versionmust match the operating system version tobe installed on the provisioned machine.Administrators can create build profilesusing one of several property sets, forexample,VMware[OS_Version]Properties, that arepredefined to include the correctVMware.VirtualCenter.OperatingSystem values. This property is for virtualprovisioning.When this property has a non-Windowsvalue, the Connect Using RDP option isdisabled. The property can be used in avirtual, cloud or physical blueprint.For a list of currently accepted values, seethe VMware vCenter Server documentation.

VMware.SCSI.Type For vApps, specifies the SCSI machine typeusing one of the following case-sensitivevalues: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.n VirtualSCSI Use para-virtualization

emulation for the virtual disk.n none Use if a SCSI controller does not

exist for this machine.

VMware.SCSI.Type For vSphere only, specifies the SCSI machinetype 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.n pvscsi. Use para-virtualization

emulation for the virtual disk.n none. Use if a SCSI controller does not

exist for this machine.

VMware.SCSI.Sharing Specifies the sharing mode of the machine’sVMware SCSI bus. Possible values are basedon the VirtualSCSISharing ENUM value.

VMware.Memory.Reservation Specifies the size of the machine’s swap file.


56 VMware, Inc.



VMware.Network.Type Specifies a network adapter type.The following adapter type values areavailable:n Flexible (default )n VirtualPcNet32. This type is not

compatible with vSpheren E1000 or VirtualE1000n VMXNET or VirtualVMXNETn VMXNET2

n VMXNET3

Set to E1000 when provisioning Windows32-bit virtual machines on ESX server hoststo ensure that machines are created with thecorrect network adapter. This property is notused in physical provisioning.

VMware.VCenterOrchestrator.EndpointName Overrides a specified endpoint setting orspecifies that a particular endpoint be usedduring the vCloud Automation Center IaaSprovisioning process. The value of thisproperty can be set to an applicablevCenter Orchestrator endpoint available inthe environment.

VMware.VirtualCenter.Folder Name of the inventory folder in thedatacenter in which the machine is created.The default is VRM. This can be a path withmultiple folders, for exampleproduction\email servers. A proxyagent creates the folder in vCenter Server ifit does not exist.

VRM.Software.IdNNNNThis row is specific to BMC BladeLogic.

Specifies a software job or policy to beapplied to all machines provisioned from theblueprint. Set the value tojob_type=job_path, where job_type isthe numeral that represents the BMCBladeLogic job type and job_path is thelocation of the job in BMC BladeLogic, forexample 4=/Utility/putty. NNNN is anumber from 1000 to 1999.

1 — AuditJob2 — BatchJob3 — ComplianceJob4 — DeployJob5 — FileDeployJob6 — NSHScriptJob7 — PatchAnalysisJob8 — SnapshotJob

VRM.Software.IdNNNNThis row is specific to HP Server Automation.

Optionally specify an HP Server Automationpolicy to be applied to all machinesprovisioned from the blueprint. NNNN is anumber from 1000 to 1999.


VMware, Inc. 57



VRM.DataCenter.Policy Specifies whether provisioning must use acompute resource associated with aparticular location, or if any location issuitable. To enable this feature you mustadd data center to a location file. Associateeach compute resource with a location.Set to Exact to provision a requestedmachine on a compute resource associatedwith the location specified on the blueprint.If a compute resource with sufficientcapacity and associated with that location isnot available, then provisioning fails.Set to NonExact (default) to provision arequested machine on a compute resourcewith sufficient capacity and associated withthe location specified on the blueprint. If thatcompute resource is not available, then usethe next available compute resource withsufficient capacity without regard tolocation.

VDI.Server.Website Specifies the server name of the Citrix Webinterface site to use in connecting to themachine. If the value of VDI.Server.Nameis a XenDesktop farm, this property musthave an appropriate value or the machineowner cannot connect to the machine usingXenDesktop. If this property is not specified,the VDI.Server.Name property determinesthe desktop delivery controller to connect to,which must be the name of a server thathosts a desktop delivery controller.


58 VMware, Inc.



VDI.Server.Name Specifies the server name, which hosts thedesktop delivery controller, to register with,or the name of a XenDesktop farm thatcontains desktop delivery controllers withwhich to register.If the value is a XenDesktop farm name, theVDI.Server.Website property value mustbe the URL of an appropriate Citrix webinterface site to use in connecting to themachine.If the value is a server name, and at least onegeneral XenDesktop VDI agent was installedwithout specifying a desktop deliverycontroller server, this value directs therequest to the desired server. If the value is aserver name, and only dedicatedXenDesktop VDI agents for specific DDCservers were installed, this value mustexactly match the server name configuredfor a dedicated agent.NOTE Changes in the Citrix web interfaceprotocol have impacted how theVDI.Server.Name default value isrecognized. The value of theVDI.Server.Name property is used as thedefault connection string to open the Citrixweb interface when users click Connect toVirtual Desktop. It is always the DNS/IP ofthe XD server. If that value does not connectto the Citrix interface, you is unable to accessyour VMs. However, you can use theVDI.Server.Website custom propertywhen the Citrix web interface is hosted on aserver other than the XenDesktop server.When this property is present on the VM, itis used instead of VDI.Server.Name.

VDI.Server.Group For XenDesktop 5, specifies the name of theXenDesktop group to add machines to andthe name of the catalog to which the groupbelongs, in the group_name;catalog_nameformat.For XenDesktop 4, specifies the name of theXenDesktop group to which machines are tobe added. XenDesktop 4 preassigned groupsare supported.

VDI.ActiveDirectory.Interval Specifies an optional interval value in timespan format for virtual desktopinfrastructure machine Active Directoryregistration check. The default value is00:00:15 (15 seconds).


VMware, Inc. 59



VDI.ActiveDirectory.Interval Specifies an optional timeout value in timespan format for virtual desktopinfrastructure machine Active Directoryregistration check. The default value is00:30:00 (30 minutes.)

VDI.ActiveDirectory.Delay Specifies an optional delay time value intime span format between successfullyadding a machine to Active Directory andinitiation of XenDesktop registration. Thedefault value is 00:00:05 (5 seconds).

Custom Properties X TableThis section lists custom properties that begin with the letter X.

Table 3‑14. Custom Properties X Table


Xen.Platform.Viridian For virtual provisioning, set to False when you provisionWindows virtual machines on a XenServer host or pool. Thedefault is True. The property is not used in physicalprovisioning.


60 VMware, Inc.

Using the Properties Dictionary 4You 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.

n Group sets of property controls together and specify the order in which they appear.

Use the following workflow when you define and use a custom property definition.1 Add a new property and associate it with a property control type.

2 Add relevant property attributes to the property.

Attributes contain additional information such as minimum and maximum values or help text todisplay with the property. Available attribute types vary depending on the control type.

3 Add the properties to a blueprint on the Properties tab on the blueprint form. Alternatively, add theproperties to a build profile.

A tenant administrator or business group manager can create or edit blueprints. For information aboutadding properties to blueprints and build profiles, see the applicable IaaS Configuration guide invCloud Automation Center 6.1 documentation.

4 (Optional) Add a control layout to specify where the properties appear on the machine confirmationpage.

New custom properties are typically used by custom workflows to specify how to run a command based.You can use vCloud Automation Center Designer to define these custom workflows. For more informationabout working with custom workflows, see Extension Development.


n “Adding Property Definitions,” on page 62

n “Adding Property Attributes,” on page 63

n “Example of Creating a Relationship Between Two Properties and Adding Them to a Blueprint,” onpage 68

n “Creating Property Control Layouts,” on page 71

VMware, Inc. 61

Adding Property DefinitionsA property definition contains an associated property control type, and optionally a property attribute,which define its behavior.

Property control types are available as you create new properties. After you create a property, you can addattributes, based on its control type. For example, you can assign a DropDown control type to aValueExpression attribute, which when selected, opens a text box in which the user can type a value. Youcan also create placement layouts to control where the properties appear when presented to users.

Table 4‑1. Property Definition Control Types and Attributes

Control Type Available Attributes Description

CheckBox HelpTextOrderIndex

Specifies a check box for specifying true or falsevalues.

DateTimeEdit HelpTextOrderIndexMinValue

Specifies a calendar and time control that enablesusers to specify a date and time.

DropDown HelpTextOrderIndexRelationshipValueExpressionValueList

Specifies a drop-down text box. A user can enterany text or select from the list of options.

DropDownList HelpTextOrderIndexRelationshipValueExpressionValueList

Specifies a drop list of options. A user must select avalue from the list.

Integer HelpTextOrderIndexIntervalMinValueMaxValue

Specifies a numeric box. If attributesare alsoassigned, a user can enter an integer value betweena defined minimum and maximum value or stepup and down by a defined interval value.

Label HelpTextOrderIndex

Displays a read-only text label.

Link OrderIndex Displays a link with the property display name asthe link text and the property value as the URL.

Add a Property DefinitionYou can define new property definitions to allow for additional customization.

After you add a property definition and select a definition control type for that property, you can addattributes to configure property controls. A tenant administrator or business group manager can addproperties to blueprints or build profiles. You can also create a property control layout to organize displayof the new properties.

Prerequisites

Log in to the vCloud Automation Center console as a fabric administrator.

Procedure

1 Select Infrastructure > Blueprints > Property Dictionary.


62 VMware, Inc.

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.

This text is visible to the property dictionary administrator but is not visible to users.

6 Select a definition control type to associate with this property from the Control Type drop-down menu.

Option Description

CheckBox Associate a check box with the new property.

DateTimeEdit Adds a date and time control type that adheres to a YYYY-MM-DD orMM/DD/YYYY format and a time in HH:MM format, 24-hour clock orfollowed by AM or PM. You can further refine the allowed value byadding property attributes such as MinValue and HelpText.

DropDown Allows the user to type a value in a text box. You can further refine thisproperty type by adding attributes such as ValueList and Relationship.

DropDownList Requires the user to select from values in a drop-down menu. You canfurther refine this property type by adding attributes such as ValueListand Relationship.

Integer Allows for an integer value. You can further refine the allowed value byadding attributes such as MinValue and MaxValue or Integer.

Label Adds a read-only text label. You can further refine the allowed value byadding attributes such as MinValue and HelpText.

Link Displays a link with the property display name as the link text and theproperty value as the URL. You can control the position of the newproperty by adding the OrderIndex attribute.

7 Click Required if the machine owner must specify a value for this property.

8 Click Save.

The property is created and is visible on the Property Dictionary page.

Adding Property AttributesCertain attribute values are available for each of the property definition control types.

Table 4‑2. Property Attributes for Property Definition Control Types

Property Definition Control Type Available Property Attribute Types

CheckBox n HelpTextn OrderIndex

DateTimeEdit n HelpTextn MinValuen OrderIndex

DropDown n HelpTextn OrderIndexn Relationshipn ValueExpressionn ValueList

Chapter 4 Using the Properties Dictionary

VMware, Inc. 63

Table 4‑2. Property Attributes for Property Definition Control Types (Continued)

Property Definition Control Type Available Property Attribute Types

DropDownList n HelpTextn OrderIndexn Relationshipn ValueExpressionn ValueList

Integer n HelpTextn Intervaln MaxValuen MinValuen OrderIndex

Label n HelpTextn OrderIndex

Link OrderIndex

Add a Help Text AttributeYou can use the HelpText attribute to add text that appears when the user points to the property name.

The HelpText attribute is available for all property value control types except Link.

Prerequisites


Procedure


2 Click Edit in the Property Attributes column of the property row.

3 Click New Property Attribute.

4 Select HelpText 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 In the Value text box, type the help text that you want to display when the user pauses on the propertydisplay name.

7 Click the Save icon ( ).

8 (Optional) Add additional attributes.

9 Click OK.

Add an Order Index AttributeYou 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.

Prerequisites



64 VMware, Inc.

Procedure




4 Select OrderIndex from the Type drop-down menu.



6 In the Value text box, type the index number to use when you order the property display name in theuser interface.



9 Click OK.

Add a Relationship AttributeYou can add a Relationship attribute to define a relationship between a drop-down property and anotherproperty, such that the value of the other property determines the possible values of the drop-downproperty.

The Relationship attribute is available for the DropDown and DropDownList property value control types.

In a property relationship, a parent property value determines the behavior of a child drop-down property.The child drop-down values are populated based on the value of the parent. If the value of the parentproperty changes, the child property updates with a list of possible values that are specific to the new parentproperty.

For more information, see “Example of Creating a Relationship Between Two Properties and Adding Themto a Blueprint,” on page 68.

Prerequisites


Procedure




4 Select Relationship from the Type drop-down menu.



6 Type the property value or value expression in the Value text box.



9 Click OK.


VMware, Inc. 65

Add a Value Expression AttributeYou can use the ValueExpression attribute to add an XML string to map the values of a parent property anda child property in a property relationship.

A ValueExpression attribute is available for the DropDown and DropDownList property value controltypes. For more information about property relationships, see “Example of Creating a Relationship BetweenTwo Properties and Adding Them to a Blueprint,” on page 68.

Prerequisites


Procedure




4 Select ValueExpression from the Type drop-down menu.



6 Enter the values that you want to use in the Value text box, for example an XML value expression orsnippet that you formatted as a single line string with no line breaks.



9 Click OK.

Add a Value List AttributeYou 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,” onpage 68.

Prerequisites


Procedure




4 Select ValueList from the Type drop-down menu.



6 Enter a comma-separated list of values in the Value text box to appear in the drop-down list.

For example, enter Option 1,Option 2,Option 3.


66 VMware, Inc.



9 Click OK.

Add a Minimum Value AttributeYou can use the MinValue attribute to define a minimum time value or a minimum integer value in a range.

A MinValue attribute is available for the DateTimeEdit and Integer property value control types.

Prerequisites


Procedure




4 Select MinValue from the Type drop-down menu.



6 Type the minimum value of the property in the Value text box.

For example, if you are using this attribute with the DateTimeEdit control, type a minimum earliestpossible date, and optionally a minimum time, value using a YYYY-MM-DD or MM/DD/YYYY formatand a time in HH:MM format followed by AM or PM. If you are using this attribute with the Integercontrol, type a minimum integer value.



9 Click OK.

Add a Maximum Value AttributeUse the MaxValue attribute to define a maximum integer value.

A MaxValue attribute is available for the Integer property value control type.

Prerequisites


Procedure




4 Select MaxValue from the Type drop-down menu.




VMware, Inc. 67

6 Type an integer for the maximum value of the property in the Value text box.



9 Click OK.

Add an Interval AttributeYou can use the Interval attribute to specify an integer increment by which the property value is increasedor decreased.

An Interval attribute is available for the Integer property value control type.

Prerequisites


Procedure




4 Select Interval from the Type drop-down menu.



6 In the Value text box, type the increment integer by which the property value is increased or decreasedwhen a user clicks the up or down arrows.



9 Click OK.

Example of Creating a Relationship Between Two Properties andAdding Them to a Blueprint

Define a relationship so that the value of a parent property determines the child property values that areavailable in a drop-down list.

In this example, a new VirtualMachine.Network.Environment property filters available network optionsbased on the machine environment. The VirtualMachine.Network.Environment property acts as a filter forthe networks that a user can select when confirming a machine request. An associated child property,VirtualMachine.Network0.Name, is also created and a relationship is formed between the two properties. Theuser must first select the environment before selecting from the list of networks that are applicable to theselected environment.


68 VMware, Inc.

Table 4‑3. Relationship Between VirtualMachine.Network.Environment Property andVirtualMachine.Network0.Name Property Menu Options

Values for the VirtualMachine.Network.EnvironmentProperty (parent)

Values for the VirtualMachine.Network0.NameProperty (child)

Development Development Network

Test Test Network 1 Test Network 2

Production Production Network Failover Network

Workflow OverviewYou 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 eachvalue of the parent property.

4 Add the value expression as an attribute of the child property.

5 Add both properties to a blueprint or build profile.

The following example is a logical progression from the following topics.

n “Add a Property Definition,” on page 62

n “Add a Relationship Attribute,” on page 65

n “Add a Value List Attribute,” on page 66

n “Add a Value Expression Attribute,” on page 66

Instead of specifying a ValueList attribute for the child property, you can use an XML string in aValueExpression attribute to specify the mapping between the values of the parent property and thepossible values of the child property.

This example uses the ValueList, ValueExpression, and Relationship property attributes with theDropDownList property definition control type.

Example Procedure1 Log in to vCloud Automation Center as a tenant administrator.


3 Create the parent property.

a Click New Property Definition on the Property Dictionary page.

b Type VirtualMachine.Network.Environment in the Name text box.

c Type Environment in the Display Name text box.

d Select DropDownList from the Control Type drop-down menu.

e Select the Required check box to make the property required at request time.

f Click Save.

4 Define the values for the parent property.

a In the VirtualMachine.Network.Environment property name row, click Edit in the PropertyAttributes column.


VMware, Inc. 69

b Click New Property Attribute.

c Select ValueList from the Type drop-down menu.

d Type Values in the Name text box.

e Type Development,Test,Production in the Value text box.

f Click Save.

g Click OK.

5 Create the child property.a Click New Property Definition on the Property Dictionary page.

b Type VirtualMachine.Network0.Name in the Name text box.

c Type Select Network in the Display Name text box.

d Select DropDownList from the Control Type drop-down menu.

e Click Save.

6 Define the relationship between the child and parent properties.a In the VirtualMachine.Network0.Name property name row, click Edit in the Property Attributes

column.

b Click New Property Attribute.

c Select Relationship from the Type drop-down menu.

d Type Parent in the Name text box.

e Type VirtualMachine.Network.Environment in the Value text box.

f Click Save and click OK.

7 In an XML editor, create the following value expression, which specifies the values of the child propertybased on the values of the parent property, and save it as an XML file:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<ArrayOfPropertyValue xmlns:xsi=

"http://www.w3.org/2001/XMLSchema-instance">

<PropertyValue>

<FilterName>VirtualMachine.Network.Environment</FilterName>

<FilterValue>Development</FilterValue>

<Value>Development Network</Value>

</PropertyValue>

<PropertyValue>


<FilterValue>Test</FilterValue>

<Value>Test Network 1</Value>

</PropertyValue>

<PropertyValue>


<FilterValue>Test</FilterValue>

<Value>Test Network 2</Value>

</PropertyValue>

<PropertyValue>


<FilterValue>Production</FilterValue>

<Value>Production Network</Value>

</PropertyValue>

<PropertyValue>


70 VMware, Inc.


<FilterValue>Production</FilterValue>

<Value>Failover Network</Value>

</PropertyValue>

</ArrayOfPropertyValue>

8 Add the value expression, specifically the XML file content, that you just created to the child property.

a In a text editor, format the value expression so that it is a single line string with no line breaks.

b In the VirtualMachine.Network0.Name property name row, click Edit in the Property Attributescolumn.

c Click New Property Attribute.

d Select ValueExpression from the Type drop-down menu.

e Type Expression in the Name text box.

f Copy the value expression from the text editor and paste it into the Value text box.

g Click Save and click OK.

9 Add both properties to a blueprint.

a Create a new blueprint or edit an existing blueprint.

b Click the Properties tab on the blueprint page.

c Click New Property.

d Type VirtualMachine.Network.Environment in the Name text box. This name must be an exactcharacter match for the property name you created for the parent property in this example.

e Leave the Value text box blank.

10 Select the Prompt User check box.

11 Click OK.

12 Click New Property.

13 Type VirtualMachine.Network0.Name in the Name text box.

14 Click OK.

When a user uses this blueprint to request a machine, the Environment and Select Network drop-downmenus now appear on the Confirm Machine Request page and are initially empty. The user can select anenvironment, which then narrows the list of networks that they can select for the machine that they arerequesting.

Creating Property Control LayoutsA property control layout acts as a named container to which you can add properties and specify the orderin which the properties appear in a blueprint or build profile. The layout defines the order of the propertiesthat display in the form.

With control layouts you can group properties together and specify the order in which they are displayed tousers on the machine confirmation page. Add the control layout and the individual properties that itcontains to the blueprint.

Add a Property Control LayoutYou create a property control layout to define how properties are displayed to users.

After you create the layout, a tenant administrator or business group manager can add it to a blueprint onthe Properties tab.


VMware, Inc. 71

Prerequisites


Create the property definitions to add to the property control layout.

Procedure


2 Click New Property Layout.

3 Enter a property layout name in the Name text box.

This is the name that is added to the blueprint or build profile. For example, type NetworkLayout.


5 Click Edit in the Property Instances column of the property layout name row, for example theNetworkLayout name row.

6 Type 1 in the Order text box.

7 From the Property Definition drop-down menu, select the name of the first property to display, forexample VirtualMachine.Network.Environment.

8 Type 2 in the Order text box.

9 From the Property Definition drop-down menu, select the name of the second property to display, forexample VirtualMachine.Network0.Name.

10 Click OK.

A custom layout is now available for a tenant administrator or business group manager to add to ablueprint or build profile.


72 VMware, Inc.

Index

Bblueprints, custom properties 30build profiles, creating property sets 11, 12

Ccustom properties

creating property sets 11, 12custom property types 10for FlexClone blueprints 17for basic workflow blueprints 13for clone blueprints 14for linked clone blueprints 19Linux Kickstart provisioning 22listed by function 13listed by name 35networking 27o properties 40properties.ini 10properties.xml 10PXE provisioning 28reasons for using 9related guides 5required for integrating HP Server

Automation 32required and optional 30SCCM provisioning 23specifying properties 9tailoring the user interface 61using the property dictionary 61vApp blueprints 26WIM provisioning 24

custom properties, a properties 36custom properties, b properties 36custom properties, c properties 36custom properties, e properties 37custom properties, h properties 38custom properties, i properties 38custom properties, l properties 39custom properties, m properties 40custom properties, p properties 41custom properties, r properties 42custom properties, s properties 42custom properties, v properties 44custom properties, x properties 60

Gguest agents, using custom properties 10

HHP Server Automation, required custom

properties 32

Llease synchronization, ensure machines do not

expire before defined duration 26Linux Kickstart provisioning, custom

properties 22

Pproperty sets

creating 11, 12creating the XML file 11

property dictionaryadding an interval attribute 68adding an order index attribute 64adding help text 64adding property attributes 63adding property definitions 62adding a list of possible menu values 66adding a maximum value attribute 67adding a minimum value attribute 67adding a property control layout 71adding a property definition 62adding a relation attribute 65, 68adding a dropdownlist control type 68adding a valuelist attribute 68adding a valuexpression attribute 68adding properties to blueprints 68creating a property control layout 71

property dictionary,adding a value expressionattribute 66

PXE provisioning, custom properties 28

SSCCM provisioning, custom properties 23

Uupdated property information, new, changed, or

deprecated properties 7

VMware, Inc. 73

VvApp blueprints, adding custom properties 26VirtualMachine.Network, specifying a network

device 27

WWIM provisioning, custom properties 24


74 VMware, Inc.

custom properties reference - vmware...

Documents