Get vDC Details operation


The Get vDC Details operation enables you to retrieve information about the specified virtual data center (vDC). The retrieved information provides details about the infrastructure services of the vDC and resources associated with the vDC, such as CPU, memory, and network resources.

The following figure shows a sample <items> XML element for the Get vDC Details operation:

Sample <items> XML element for the Get vDC Details operation

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

The following table describes the elements for this adapter request:

Adapter request elements for the Get vDC Details operation

Element

Definition

Required

<operation-name>

Defines the type of operation: Get_vDC_Details

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 elements for the operation

Yes

<vdc-id>

Specifies the ID corresponding to the vDC whose details you want to retrieve
Valid value: Any string

Yes

The following figure shows the sample adapter request for the Get vDC Details operation:

Sample adapter request for the Get vDC Details operation

<vmware-vcloud-request>
  <operation-name>Get_vDC_Details</operation-name>
  <vcloud-organization>TestOrg</vcloud-organization>
  <user-name>TestUser</user-name>
  <password>Password</password>
  <parameters>
  <vdc-id>882004552</vdc-id>
  </parameters>
</vmware-vcloud-request>

The following figure shows the response for the sample adapter request:

Sample adapter response for the Get vDC Details operation

<vmware-vcloud-response>
  <metadata>
    <status>success</status>
  </metadata>
  <status-line>
    <code>200</code>
    <reason>OK</reason>
  </status-line>
  <message-body>
    <Vdc status="1" name="BMCDevOrgvDC" type="application/vnd.vmware.
vcloud.vdc+xml" href="https://10.128.248.112/api/v1.0/vdc/882004552">
      <Link rel="up" type="application/vnd.vmware.vcloud.org+xml"
href="https://10.128.248.112/api/v1.0/org/2001447251" />
      <Link rel="add" type="application/vnd.vmware.vcloud.uploadVApp
TemplateParams+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/action/uploadVApp
Template" />
      <Link rel="add" type="application/vnd.vmware.vcloud.media+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/media" />
      <Link rel="add" type="application/vnd.vmware.vcloud.instantiate
VAppTemplateParams+xml" href="https://10.128.248.112/api/v1.0/vdc
/882004552/action/instantiateVAppTemplate" />
      <Link rel="add" type="application/vnd.vmware.vcloud.cloneVAppParams+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/action/cloneVApp" />
      <Link rel="add" type="application/vnd.vmware.vcloud.cloneVAppTemplate
Params+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/action/cloneVAppTemplate" />
      <Link rel="add" type="application/vnd.vmware.vcloud.cloneMediaParams+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/action/cloneMedia" />
      <Link rel="add" type="application/vnd.vmware.vcloud.captureVAppParams+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/action/captureVApp" />
      <Link rel="add" type="application/vnd.vmware.vcloud.composeVAppParams+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/action/composeVApp" />
      <Link rel="move" type="application/vnd.vmware.vcloud.moveMediaParams+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/action/moveMedia" />
      <Link rel="move" type="application/vnd.vmware.vcloud.moveVAppParams+xml"
 href="https://10.128.248.112/api/v1.0/vdc/882004552/action/moveVApp" />
      <Link rel="move" type="application/vnd.vmware.vcloud.moveVAppTemplateParam
+xml" href="https://10.128.248.112/api/v1.0/vdc/882004552/action/
moveVAppTemplate" />
      <AllocationModel>AllocationPool</AllocationModel>
      <StorageCapacity>
        <Units>MB</Units>
        <Allocated>2242</Allocated>
        <Limit>2242</Limit>
        <Used>2136</Used>
        <Overhead>0</Overhead>
      </StorageCapacity>
      <ComputeCapacity>
        <Cpu>
          <Units>MHz</Units>
          <Allocated>660</Allocated>
          <Limit>660</Limit>
          <Used>0</Used>
          <Overhead>0</Overhead>
        </Cpu>
        <Memory>
          <Units>MB</Units>
          <Allocated>1054</Allocated>
          <Limit>1054</Limit>
          <Used>121</Used>
          <Overhead>0</Overhead>
        </Memory>
      </ComputeCapacity>
      <ResourceEntities>
        <ResourceEntity type="application/vnd.vmware.vcloud.vApp+xml"
 name="TestvAppuser"  href="https://10.128.248.112/api/v1.0/vApp/
vapp-1549082565" />
        <ResourceEntity type="application/vnd.vmware.vcloud.vApp+xml"
 name="TestNewvApp" href="https://10.128.248.112/api/v1.0/vApp/
vapp-1052124975" />
        <ResourceEntity type="application/vnd.vmware.vcloud.vApp+xml"
 name="Test Clone" href="https://10.128.248.112/api/v1.0/vApp/
vapp-1053624935" />
        <ResourceEntity type="application/vnd.vmware.vcloud.vAppTemplate+xml"
 name="TestTmpl2" href="https://10.128.248.112/api/v1.0/vAppTemplate/
vappTemplate-973455519" />
        <ResourceEntity type="application/vnd.vmware.vcloud.vAppTemplate+xml
" name="TestvAppCapture" href="https://10.128.248.112/api/v1.0/vAppTemplate/
vappTemplate-154752694" />
        <ResourceEntity type="application/vnd.vmware.vcloud.vAppTemplate+xml"
 name="TestvApp-Capturenew" href="https://10.128.248.112/api/v1.0/vAppTemplate/
vappTemplate-1821830589" />
        <ResourceEntity type="application/vnd.vmware.vcloud.vAppTemplate+xml"
 name="TestTmpl2" href="https://10.128.248.112/api/v1.0/vAppTemplate/
vappTemplate-1292650381" />
      </ResourceEntities>
      <AvailableNetworks>
        <Network type="application/vnd.vmware.vcloud.network+xml"
 name="BMCDevOrgNetwork"
 href="https://10.128.248.112/api/v1.0/network/539454687" />
      </AvailableNetworks>
      <NicQuota>0</NicQuota>
      <NetworkQuota>1024</NetworkQuota>
      <VmQuota>100</VmQuota>
      <IsEnabled>true</IsEnabled>
    </Vdc>
  </message-body>
</vmware-vcloud-response>

 

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

TrueSight Orchestration Content 23.1