Get VM Guest Customization Section operation


The Get VM Guest Customization Section operation enables you to retrieve the details of the guest customization section of a specified VM.

The following figure shows a sample <items> XML element for the Get VM Guest Customization Section operation:

Sample <items> XML element for the Get VM Guest Customization Section operation

<items>
 <item>
   <parameters>
     <vm-id></vm-id>
   </parameters>
 </item>
</items>

The following table describes the elements for this adapter request:

Adapter request elements for the Get VM Guest Customization Section operation

Element

Definition

Required

<operation-name>

Defines the type of operation: Get_VM_Guest_Customization_Section

Yes

<vcloud-organization>

Specifies the name of the vCloud organization

Conditional:

  • Required if not specified in the configuration
  • If used, requires <user-name> and <password>
<user-name>

Specifies the user name required for basic HTTP authentication on vCloud

Conditional:

  • Required if not specified in the configuration
  • If used, requires <vcloud-organization> and <password>
<password>

Contains the password corresponding to the specified user name

Conditional:

  • Required if not specified in the configuration
  • If used, requires <vcloud-organization> and <user-name>
<parameters>

Contains the <vm-id> element that executes the operation

Yes

<vm-id>

Specifies the ID of the VM whose details you want to retrieve

Valid value: Any string

Yes

The following figure shows the sample adapter request for the Get VM Network Connection operation:

Sample adapter request for the Get VM Guest Customization Section operation

<vmware-vcloud-request>
 <operation-name>Get_VM_Guest_Customization_Section</operation-name>
 <vcloud-organization>TestOrg</vcloud-organization>
 <user-name>TestUser</user-name>
 <password>Password</password>
 <parameters>
   <vm-id>vm-1372893750</vm-id>
 </parameters>
</vmware-vcloud-request>

The following figure shows the response for the sample request:

Sample adapter response for the Get VM Guest Customization Section operation

 <vmware-vcloud-response>
 <metadata>
   <status>success</status>
 </metadata>
 <status-line>
   <code>200</code>
   <reason>OK</reason>
 </status-line>
 <message-body>
   <GuestCustomizationSection type="application/vnd.vmware.vcloud
.guestCustomizationSection+xml"
href="https://10.128.248.112/api/v1.0/
vApp/vm-1372893750/guestCustomizationSection/"
required="false">
     <Info>Specifies Guest OS Customization Settings</Info>
     <Enabled>false</Enabled>
     <ChangeSid>true</ChangeSid>
     <VirtualMachineId>1372893750</VirtualMachineId>
     <JoinDomainEnabled>true</JoinDomainEnabled>
     <UseOrgSettings>false</UseOrgSettings>
     <DomainName>sysnapse</DomainName>
     <DomainUserName>newuser</DomainUserName>
     <DomainUserPassword>test1</DomainUserPassword>
     <AdminPasswordEnabled>true</AdminPasswordEnabled>
     <AdminPasswordAuto>false</AdminPasswordAuto>
     <AdminPassword>abc789</AdminPassword>
     <ResetPasswordRequired>true</ResetPasswordRequired>
     <CustomizationScript>jai</CustomizationScript>
     <ComputerName>KushalVApp</ComputerName>
     <Link rel="edit" type="application/vnd.vmware.vcloud.guest
CustomizationSection+xml"
href="https://10.128.248.112/api/v1.0/
vApp/vm-1372893750/guestCustomizationSection/"
/>
   </GuestCustomizationSection>
 </message-body>
</vmware-vcloud-response>      
             

 

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

BMC Atrium Orchestrator Content 20.14.01