Attributes
Attribute | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
href | anyURI | No | none | 1.0 | A reference to the section in URL format. | |
type | string | No | none | 1.0 | The MIME type of the section. |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
AdminAutoLogonCount | int | No | always | 5.5 | Number of times administrator can automatically log into this virtual machine. In case AdminAutoLogon is set to True, this value should be between 1 and 100. Otherwise, it should be 0. | |
AdminAutoLogonEnabled | boolean | No | always | 5.5 | True if guest administrator should automatically log into this virtual machine. | |
AdminPassword | string | No | always | 1.0 | True if the administrator password for this virtual machine should be set to this string. (AdminPasswordAuto must be false.) | |
AdminPasswordAuto | boolean | No | always | 1.0 | True if the administrator password for this virtual machine should be automatically generated. | |
AdminPasswordEnabled | boolean | No | always | 1.0 | True if guest customization can modify administrator password settings for this virtual machine. | |
ChangeSid | boolean | No | always | 1.0 | True if customization can change the Windows SID of this virtual machine. | |
ComputerName | string | No | always | 1.0 | Computer name to assign to this virtual machine. | |
CustomizationScript | string | No | always | 1.0 | Script to run on guest customization. The entire script must appear in this element. Use the XML entity to represent a newline. Unicode characters can be represented in the form &#xxxx; where xxxx is the character number. | |
DomainName | string | No | always | 1.0 | The name of the Windows Domain to join. | |
DomainUserName | string | No | always | 1.0 | User name to specify when joining a Windows Domain. | |
DomainUserPassword | string | No | always | 1.0 | Password to use with DomainUserName. | |
Enabled | boolean | No | always | 1.0 | True if guest customization is enabled. | |
JoinDomainEnabled | boolean | No | always | 1.0 | True if this virtual machine can join a Windows Domain. | |
Link | LinkType | No | none | 1.0 | A link to an operation on this section. | |
MachineObjectOU | string | No | always | 5.1 | The name of the Windows Domain Organizational Unit (OU) in which the computer account for this virtual machine will be created. | |
ResetPasswordRequired | boolean | No | always | 1.0 | True if the administrator password for this virtual machine must be reset after first use. | |
UseOrgSettings | boolean | No | always | 1.0 | True if customization should use organization settings (OrgGuestPersonalizationSettings) when joining a Windows Domain. | |
VirtualMachineId | string | No | none | 1.0 | Virtual machine ID to apply. |
Operations
CRUD | Operation | Description | Since | Deprecated |
---|---|---|---|---|
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 | Updates the guest customization section of a VM. | 1.0 | |
update | PUT /vAppTemplate/{id}/guestCustomizationSection | Updates the guest customization section of a VM. | 1.0 |