customization

Specifies the customization parameters for the guest operating system of the virtual machine.

The following table describes the child elements of customization:

Child elements customization

Element

Definition

Required

<identity>

Specifies the network identity and settings, similar to Microsoft's Sysprep tool

This element is a Sysprep, LinuxPrep, or SysprepText object.

<identity> contains the type attribute.

Valid values: CustomizationLinuxPrep, CustomizationSysPrep (default)

No

<gui-unattended>

Contains the following elements for preparing the graphical user interface (GUI) for unattended setup

  • <password>
  • <time-zone>
  • <auto-logon>
  • <auto-logon-count>

Conditional; required if identity type is set to CustomizationSysprep

<password>

Specifies the new administrator password for the virtual machine

Sample format:

<password>
<value></value>
<plain-text></plain-text>
</password>

The <value> element contains the password string. The password is encrypted if the <plain-text> element is set to false.

The <plain-text> element specifies whether the password is encrypted or plain text.

Valid values for the <plain-text> element are: true, false

You can use the <password> element only if the following conditions are satisfied:

  • the OS password in the template is blank
  • the CustomizationSysprep data object is used
  • the password is used for auto logon purposes

No; valid only if identity type is set to CustomizationSysprep

<time-zone>

Specifies the time zone for the new virtual machine

The numbers correspond to the time zones listed in the sysprep documentation on Microsoft Technet.

Valid value: Any integer

No; valid only if identity type is set to CustomizationSysprep

<auto-logon>

Specifies the flag that determines whether the machine automatically logs on as Administrator

Valid value: Any boolean

No; valid only if identity type is set to CustomizationSysprep

<auto-logon-count>

If the AutoLogon flag is set, the AutoLogonCount property specifies the number of times the machine should automatically log on as Administrator.

This value must be one.

However, if your setup requires a number of reboots, you may need to increase it. This number may be determined by the list of commands executed by the GuiRunOnce command.

Valid value: Any integer

No; valid only if identity type is set to CustomizationSysprep

<full-name>

Specifies the full name of the user

Valid value: Any string

Conditional; valid only if identity type is set to CustomizationSysprep

<computer-name>

Specifies the computer name of the Microsoft Windows virtual machine

Sample format:

<computer-name>
<name></name>
</computer-name>

Conditional; valid only if identity type is set to CustomizationSysprep

<org-name>

Specifies the name of the user's organization

Valid value: Any string

Conditional; valid only if identity type is set to CustomizationSysprep

<product-id>

Specifies the valid serial number that Microsoft Sysprep requires in the answer file when mini-setup runs.

This serial number is ignored if the original guest operating system was installed using a volume-licensed CD.

Valid value: Any string

No; valid only if identity type is set to CustomizationSysprep

<join-workgroup>

Specifies the workgroup that the virtual machine must join

If this value is specified, the domain name and authentication fields must be empty.

Valid value: Any string

No; valid only if identity type is set to CustomizationSysprep

<auto-mode>

Specifies the licensing mode for the server

Valid values: perSeat, perServer

No; valid only if identity type is set to CustomizationSysprep

<auto-users>

Specifies the key that is valid only if the value of the AutoMode element is PerServer. The integer value specifies the number of client licenses purchased for the VMware VirtualCenter server installed.

Valid value: Any integer

No; valid only if identity type is set to CustomizationSysprep

<host-name>

Specifies the computer name of the virtual machine (not running on Windows)
Sample format:

<host-name>
<name></name>
</host-name>

Conditional; valid only if identity type is set to CustomizationSysprep

<domain>

Specifies the fully qualified domain name

Valid value: Any string

Conditional; valid only if identity type is set to CustomizationSysprep

<dns-server-list>

Specifies the list of DNS servers for a virtual network adapter with a static IP address

If this list is empty, the guest operating system uses a DHCP server to get its DNS server settings.

These settings configure the virtual machine to use the specified DNS servers. These DNS server settings are listed in order of preference. If you specify this element, you need to set dnsFromDhcp to false.

Sample format:

<dns-server-list>
<dns-server-list></dns-server-list>
<dns-server-list></dns-server-list>
</dns-server-list>

No

<dns-suffix-list>

Specifies the list of name resolution suffixes for the virtual network adapter

This list applies to both Windows and Linux guest customization. For Linux, this setting is global, whereas for Windows, this setting is listed for each adapter.

Sample format:

<dns-suffix-list>
<dns-suffix-list></dns-suffix-list>
<dns-suffix-list></dns-suffix-list>
</dns-suffix-list>

No

<nic-setting-map>

Contains the <adapter> element which in turn contains the following virtual network adapter elements that must be customized:

  • <ip>
  • <subnet-mask>
  • <gateway>
  • <dns-domain>

    Note: To use multiple <nic-setting-map> elements, enclose them within a <nic-setting-map-list> element.

No

<ip>

Specifies the unique IP address for the virtual network adapter
Valid values: 

  • CustomizationFixedIp

  • CustomizationDhcpIpGenerator
    Sample format:

    <ip type="">
    <ipAddress></ipAddress>
    </ip>

     

    Note: The <ipAddress> element is valid only when the value for <ip type> is CustomizationFixedIp.

No

<subnet-mask>

Specifies the subnet mask for the virtual network adapter

Valid value: Any string

No

<gateway>

Specifies a list of gateways, in the order of preference for a virtual network adapter with a static IP address

No

<dns-domain>

Specifies a DNS domain suffix such as vmware.com

Valid value: Any string

No

The following figure shows the sample for customization.

XML Sample for customization

<customization>
 <identity type="CustomizationSysprep">
   <gui-unattended>
     <password>
       <value>abc123</value>
       <plain-text>true</plain-text>
     </password>
     <time-zone></time-zone>
     <auto-logon></auto-logon>
       <auto-logon-count></auto-logon-count>
   </gui-unattended>
   <user-data>
     <full-name></full-name>
<org-name></org-name>
<computer-name>
 <name>A</name>
</computer-name>
<product-id></product-id>
   </user-data>
   <identification>
     <join-workgroup></join-workgroup>
   </identification>
   <license-file-print-data>
     <auto-mode></auto-mode>
<auto-users></auto-users>
   </license-file-print-data>
   <host-name>
     <name></name>
   </host-name>
   <domain></domain>
 </identity>
 <globalIPSettings>
   <dns-server-list>
     <dns-server-list></dns-server-list>
     <dns-server-list></dns-server-list>
   </dns-server-list>
   <dns-suffix-list>
     <dns-suffix-list></dns-suffix-list>
     <dns-suffix-list></dns-suffix-list>
   </dns-suffix-list>
 </globalIPSettings>
 <nic-setting-map>
   <adapter>
     <ip type="CustomizationDhcpIpGenerator">
       <ipAddress></ipAddress>
     </ip>
     <subnet-mask></subnet-mask>
     <gateway></gateway>
     <dns-domain></dns-domain>
   </adapter>
 </nic-setting-map>
<customization>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*