GuestCustomizationSection

Element:
GuestCustomizationSection
Type:
GuestCustomizationSectionType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents a guest customization settings.
Since:
1.0
Schema:
vApp.xsd
Media type(s):
application/vnd.vmware.vcloud.guestCustomizationSection+xml
Extends:
Section_Type
XML Representation:
<GuestCustomizationSection xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" href="xs:anyURI" type="xs:string">
    <Enabled> xs:boolean </Enabled>
    <ChangeSid> xs:boolean </ChangeSid>
    <VirtualMachineId> xs:string </VirtualMachineId>
    <JoinDomainEnabled> xs:boolean </JoinDomainEnabled>
    <UseOrgSettings> xs:boolean </UseOrgSettings>
    <DomainName> xs:string </DomainName>
    <DomainUserName> xs:string </DomainUserName>
    <DomainUserPassword> xs:string </DomainUserPassword>
    <AdminPasswordEnabled> xs:boolean </AdminPasswordEnabled>
    <AdminPasswordAuto> xs:boolean </AdminPasswordAuto>
    <AdminPassword> xs:string </AdminPassword>
    <ResetPasswordRequired> xs:boolean </ResetPasswordRequired>
    <CustomizationScript> xs:string </CustomizationScript>
    <ComputerName> xs:string </ComputerName>
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
</GuestCustomizationSection>

Attributes

Attribute Type Required Modifiable Since Description
href anyURI No none 1.0 Link to the section.
type string No none 1.0 Type of the section.

Elements

Element Type Occurrence Modifiable Since Description
Enabled boolean 0..1 always 1.0 Flag to enable or disable the guest customization section.
ChangeSid boolean 0..1 always 1.0 Change the sid if applicable. Used only for Windows OS.
VirtualMachineId string 0..1 none 1.0 Virtual machine ID to which this customization is applied.
JoinDomainEnabled boolean 0..1 always 1.0 Flag to enable or disable joining to a domain.
UseOrgSettings boolean 0..1 always 1.0 Flag to use organization settings. Valid only if JoinDomainEnabled is set.
DomainName string 0..1 always 1.0 Domain name to join to. Valid only if JoinDomainEnabled is set.
DomainUserName string 0..1 always 1.0 Domain user name to join to. Valid only if JoinDomainEnabled is set.
DomainUserPassword string 0..1 always 1.0 Domain user password to join to. Valid only if JoinDomainEnabled is set.
AdminPasswordEnabled boolean 0..1 always 1.0 Flag to enable or disable admin password use.
AdminPasswordAuto boolean 0..1 always 1.0 Flag to set admin password to auto generation. Valid only if AdminPasswordEnabled is set.
AdminPassword string 0..1 always 1.0 Set the admin password explicitly. Valid only if AdminPasswordEnabled is set and AdminPasswordAuto is false.
ResetPasswordRequired boolean 0..1 always 1.0 Flag to require reseting of password. Valid only if AdminPasswordEnabled is set.
CustomizationScript string 0..1 always 1.0 Script to run on guest customization. You could use xml escape sequence &#13; to make multiple lines script. The script could contain any UNICODE symbol by specifying its number in format &#xxxx; where xxxx is the number. The predefined symbols in the XML are: * & &amp; * < &lt; * > &gt; * " &quot; * ' &apos;
ComputerName string 0..1 always 1.0 Computer name to use for guest customization.
Link LinkType 0..* none 1.0 Link an operation over the section.

Operations

CRUD Operation Description Since
read GET /vApp/{id}/guestCustomizationSection Retrieves the guest customization section of a VM. 1.0
read GET /vAppTemplate/{id}/guestCustomizationSection Retrieves the guest customization section of a VM. 1.0
update PUT /vApp/{id}/guestCustomizationSection Modifies the guest customization options of a VM. 1.0
update PUT /vAppTemplate/{id}/guestCustomizationSection Modifies the guest customization options of a VM. 1.0