Get VM Virtual Hardware Section operation


The Get VM Virtual Hardware Section operation enables you to retrieve the virtual hardware section details of the specified VM.

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

Sample <items> XML element for the Get VM Virtual Hardware 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 Virtual Hardware Section operation

Element

Definition

Required

<operation-name>

Defines the type of operation: Get_VM_Virtual_Hardware_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 virtual hardware section details you want to retrieve

Valid value: Any string

Yes

The following figure shows the sample adapter request for the Get VM Virtual Hardware Section operation:

Sample adapter request for the Get VM Virtual Hardware Section operation

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

The following figure shows the response for the sample request:

Sample adapter response for the Get VM Virtual Hardware Section operation

<vmware-vcloud-response>
 <metadata>
   <status>success</status>
 </metadata>
 <status-line>
   <code>200</code>
   <reason>OK</reason>
 </status-line>
 <message-body>
   <VirtualHardwareSection href="https://10.128.248.112/api/
v1.0/vApp/vm-690224753/virtualHardwareSection/"
type="application/
vnd.vmware.vcloud.virtualHardwareSection+xml"
>
     <Info>Virtual hardware requirements</Info>
     <System>
       <ElementName>Virtual Hardware Family</ElementName>
       <InstanceID>0</InstanceID>
       <VirtualSystemIdentifier>TestVApp1</VirtualSystemIdentifier>
       <VirtualSystemType>vmx-07</VirtualSystemType>
     </System>
     <Item>
       <Address>00:50:56:91:2a:aa</Address>
       <AddressOnParent>0</AddressOnParent>
       <AutomaticAllocation>true</AutomaticAllocation>
       <Connection ipAddress="10.128.249.121" primaryNetwork
Connection="true" ipAddressingMode="POOL">BMCDevOrgNetwork2</Connection>
       <Description>PCNet32 ethernet adapter</Description>
       <ElementName>Network adapter 0</ElementName>
       <InstanceID>1</InstanceID>
       <ResourceSubType>PCNet32</ResourceSubType>
       <ResourceType>10</ResourceType>
     </Item>
     <Item>
       <Address>0</Address>
       <Description>SCSI Controller</Description>
       <ElementName>SCSI Controller 0</ElementName>
       <InstanceID>2</InstanceID>
       <ResourceSubType>lsilogic</ResourceSubType>
       <ResourceType>6</ResourceType>
     </Item>
     <Item>
       <AddressOnParent>0</AddressOnParent>
       <Description>Hard disk</Description>
       <ElementName>Hard disk 1</ElementName>
       <HostResource capacity="4096" busType="6"
busSubType="lsilogic" />
       <InstanceID>2000</InstanceID>
       <Parent>2</Parent>
       <ResourceType>17</ResourceType>
     </Item>
     <Item>
       <Address>0</Address>
       <Description>IDE Controller</Description>
       <ElementName>IDE Controller 0</ElementName>
       <InstanceID>3</InstanceID>
       <ResourceType>5</ResourceType>
     </Item>
     <Item>
       <AddressOnParent>0</AddressOnParent>
       <AutomaticAllocation>true</AutomaticAllocation>
       <Description>CD/DVD Drive</Description>
       <ElementName>CD/DVD Drive 1</ElementName>
       <HostResource />
       <InstanceID>3002</InstanceID>
       <Parent>3</Parent>
       <ResourceType>15</ResourceType>
     </Item>
     <Item>
       <AddressOnParent>0</AddressOnParent>
       <AutomaticAllocation>false</AutomaticAllocation>
       <Description>Floppy Drive</Description>
       <ElementName>Floppy Drive 1</ElementName>
       <HostResource />
       <InstanceID>8000</InstanceID>
       <ResourceType>14</ResourceType>
     </Item>
     <Item href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/cpu"
type="application/
vnd.vmware.vcloud.rasdItem+xml"
>
       <AllocationUnits>hertz * 10^6</AllocationUnits>
       <Description>Number of Virtual CPUs</Description>
       <ElementName>1 virtual CPU(s)</ElementName>
       <InstanceID>4</InstanceID>
       <Reservation>0</Reservation>
       <ResourceType>3</ResourceType>
       <VirtualQuantity>1</VirtualQuantity>
       <Weight>0</Weight>
       <Link rel="edit" type="application/vnd.vmware.vcloud
.rasdItem+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/cpu"
/>
     </Item>
     <Item href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/memory"
type="application/
vnd.vmware.vcloud.rasdItem+xml"
>
       <AllocationUnits>byte * 2^20</AllocationUnits>
       <Description>Memory Size</Description>
       <ElementName>256 MB of memory</ElementName>
       <InstanceID>5</InstanceID>
       <Reservation>0</Reservation>
       <ResourceType>4</ResourceType>
       <VirtualQuantity>256</VirtualQuantity>
       <Weight>0</Weight>
       <Link rel="edit" type="application/vnd.vmware.vcloud.
rasdItem+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/memory"
/>
     </Item>
     <Link rel="edit" type="application/vnd.vmware.vcloud.
virtualHardwareSection+xml"
href="https://10.128.248.112/api/
v1.0/vApp/vm-690224753/virtualHardwareSection/"
/>
     <Link rel="down" type="application/vnd.vmware.vcloud.
rasdItem+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/cpu"
/>
     <Link rel="edit" type="application/vnd.vmware.vcloud.
rasdItem+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/cpu"
/>
     <Link rel="down" type="application/vnd.vmware.vcloud.
rasdItem+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/memory"
/>
     <Link rel="edit" type="application/vnd.vmware.vcloud.
rasdItem+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/memory"
/>
     <Link rel="down" type="application/vnd.vmware.vcloud.
rasdItemsList+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/disks"
/>
     <Link rel="edit" type="application/vnd.vmware.vcloud.
rasdItemsList+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/disks"
/>
     <Link rel="down" type="application/vnd.vmware.vcloud.
rasdItemsList+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/media"
/>
     <Link rel="down" type="application/vnd.vmware.vcloud.
rasdItemsList+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/networkCards"
/>
     <Link rel="edit" type="application/vnd.vmware.vcloud.
rasdItemsList+xml"
href="https://10.128.248.112/api/v1.0/vApp/
vm-690224753/virtualHardwareSection/networkCards"
/>
   </VirtualHardwareSection>
 </message-body>
</vmware-vcloud-response>

 

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