Retrieve Cluster Virtual Machines operation

The Retrieve Cluster Virtual Machines operation retrieves a list of virtual machines and virtual machine templates in the specified cluster.

The following table describes the elements for this request. 

Adapter request elements for Retrieve Cluster Virtual Machines operation

ElementDefinitionRequired

<operation-type>

Defines the type of operation: Cluster

Yes

<operation-name>

Defines the name of operation: Retrieve_Cluster_Virtual_Machines

Yes

<soap-url>

Specifies the URL for the remote SOAP service running on the VMware VirtualCenter 

If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration. 

Default format for HTTPS: https://<hostName>:<port>/sdk/vim 

Default format for HTTP: http://<hostName>:<port>/sdk/vim

Note

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application. 

No

<transport>

Specifies the transport protocol for the message 

If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration. 

Valid values: https-rpc (default), http-rpc

Note

If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled. 

No

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center 

If no user name is specified, the request is executed with the user name that is specified in the configuration.

No

<password>

Specifies the password corresponding to <user-name>

Conditional; required if<user-name> is specified

<parameters>

Contains the <cluster-compute-resource> element required to execute the operation

Yes

<cluster-compute-resource>

Specifies the name of the cluster whose virtual machines you want to retrieve 

Valid value: Any string

Yes

The following code sample shows the <items> XML for specifying whether to retrieve all properties for all virtual machines in a cluster.

Sample <items> XML for retrieving all properties for all virtual machines in a cluster
<items>
	<item>
		<retrieve-all-vm-properties>true</retrieve-all-vm-properties>
		<parameters>
				<cluster-compute-resource></cluster-compute-resource>
			</parameters>
	</item>
</items> 

The following code sample shows the adapter request XML when the <retrieve-all-vm-properties> is set to true.

Sample adapter request XML when the <retrieve-all-vm-properties> element is set to true
 <request-data>
  <vmware-infrastructure-request>
    <operation-type>Cluster</operation-type>
    <operation-name>Retrieve_Cluster_Virtual_Machines_All_Properties</operation-name>
    <retrieve-all-vm-properties>true</retrieve-all-vm-properties>
    <parameters>
      <cluster-compute-resource>TestCluster</cluster-compute-resource>
    </parameters>
  </vmware-infrastructure-request>

The following code sample shows the adapter response when the <retrieve-all-vm-properties> is set to true.

 Sample adapter response when the <retrieve-all-vm-properties> is set to true.
<vmware-infrastructure-response>
  <metadata>
    <status>success</status>
  </metadata>
  <RetrieveClusterVirtualMachinesResponse>
    <returnval>
      <VirtualMachine>vm-12</VirtualMachine>
      <alarmActionsEnabled>true</alarmActionsEnabled>
      <availableField>
        <CustomFieldDef>
          <key>1</key>
          <name>test123</name>
          <type>string</type>
          <managedObjectType>VirtualMachine</managedObjectType>
        </CustomFieldDef>
      </availableField>
      <capability>
        <snapshotOperationsSupported>true</snapshotOperationsSupported>
        <multipleSnapshotsSupported>true</multipleSnapshotsSupported>
        <snapshotConfigSupported>true</snapshotConfigSupported>
        <poweredOffSnapshotsSupported>true</poweredOffSnapshotsSupported>
        <memorySnapshotsSupported>true</memorySnapshotsSupported>
        <revertToSnapshotSupported>true</revertToSnapshotSupported>
        <quiescedSnapshotsSupported>true</quiescedSnapshotsSupported>
        <disableSnapshotsSupported>false</disableSnapshotsSupported>
        <lockSnapshotsSupported>false</lockSnapshotsSupported>
        <consolePreferencesSupported>false</consolePreferencesSupported>
        <cpuFeatureMaskSupported>true</cpuFeatureMaskSupported>
        <s1AcpiManagementSupported>true</s1AcpiManagementSupported>
        <settingScreenResolutionSupported>false</settingScreenResolutionSupported>
        <toolsAutoUpdateSupported>false</toolsAutoUpdateSupported>
        <vmNpivWwnSupported>true</vmNpivWwnSupported>
        <npivWwnOnNonRdmVmSupported>true</npivWwnOnNonRdmVmSupported>
        <vmNpivWwnDisableSupported>true</vmNpivWwnDisableSupported>
        <vmNpivWwnUpdateSupported>true</vmNpivWwnUpdateSupported>
        <swapPlacementSupported>true</swapPlacementSupported>
        <toolsSyncTimeSupported>true</toolsSyncTimeSupported>
        <virtualMmuUsageSupported>true</virtualMmuUsageSupported>
        <diskSharesSupported>true</diskSharesSupported>
        <bootOptionsSupported>true</bootOptionsSupported>
        <bootRetryOptionsSupported>true</bootRetryOptionsSupported>
        <settingVideoRamSizeSupported>true</settingVideoRamSizeSupported>
        <settingDisplayTopologySupported>false</settingDisplayTopologySupported>
        <recordReplaySupported>true</recordReplaySupported>
        <changeTrackingSupported>true</changeTrackingSupported>
      </capability>
      <config>
        <changeVersion>2013-06-19T10:50:29.994638Z</changeVersion>
        <modified>1970-01-01T00:00:00Z</modified>
        <name>Win-2008r2-machine3</name>
        <guestFullName>Microsoft Windows Server 2008 R2 (64-bit)</guestFullName>
        <version>vmx-07</version>
        <uuid>564d317b-c419-1c29-4238-5c8fc2e98bda</uuid>
        <instanceUuid>52bff4c6-0729-f5f3-5374-c6b356c97d87</instanceUuid>
        <npivTemporaryDisabled>true</npivTemporaryDisabled>
        <locationId>564d317b-c419-1c29-4238-5c8fc2e98bda</locationId>
        <template>false</template>
        <guestId>windows7Server64Guest</guestId>
        <alternateGuestName></alternateGuestName>
        <files>
          <vmPathName>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.vmx</vmPathName>
          <snapshotDirectory>[datastore1] Win-2008r2-machine3/</snapshotDirectory>
          <suspendDirectory>[datastore1] Win-2008r2-machine3/</suspendDirectory>
          <logDirectory>[datastore1] Win-2008r2-machine3/</logDirectory>
        </files>
        <tools>
          <toolsVersion>0</toolsVersion>
          <afterPowerOn>true</afterPowerOn>
          <afterResume>true</afterResume>
          <beforeGuestStandby>true</beforeGuestStandby>
          <beforeGuestShutdown>true</beforeGuestShutdown>
          <toolsUpgradePolicy>manual</toolsUpgradePolicy>
          <syncTimeWithHost>false</syncTimeWithHost>
        </tools>
        <flags>
          <disableAcceleration>false</disableAcceleration>
          <enableLogging>true</enableLogging>
          <useToe>false</useToe>
          <runWithDebugInfo>false</runWithDebugInfo>
          <monitorType>release</monitorType>
          <htSharing>any</htSharing>
          <diskUuidEnabled>true</diskUuidEnabled>
          <virtualMmuUsage>automatic</virtualMmuUsage>
          <virtualExecUsage>hvAuto</virtualExecUsage>
          <snapshotPowerOffBehavior>powerOff</snapshotPowerOffBehavior>
          <recordReplayEnabled>false</recordReplayEnabled>
        </flags>
        <defaultPowerOps>
          <powerOffType>soft</powerOffType>
          <suspendType>hard</suspendType>
          <resetType>soft</resetType>
          <defaultPowerOffType>soft</defaultPowerOffType>
          <defaultSuspendType>hard</defaultSuspendType>
          <defaultResetType>soft</defaultResetType>
          <standbyAction>checkpoint</standbyAction>
        </defaultPowerOps>
        <hardware>
          <numCPU>4</numCPU>
          <memoryMB>6144</memoryMB>
          <VirtualIDEController>
            <key>200</key>
            <deviceInfo>
              <label>IDE 0</label>
              <summary>IDE 0</summary>
            </deviceInfo>
            <busNumber>0</busNumber>
          </VirtualIDEController>
          <VirtualIDEController>
            <key>201</key>
            <deviceInfo>
              <label>IDE 1</label>
              <summary>IDE 1</summary>
            </deviceInfo>
            <busNumber>1</busNumber>
            <device>3002</device>
          </VirtualIDEController>
          <VirtualPS2Controller>
            <key>300</key>
            <deviceInfo>
              <label>PS2 controller 0</label>
              <summary>PS2 controller 0</summary>
            </deviceInfo>
            <busNumber>0</busNumber>
            <device>600</device>
            <device>700</device>
          </VirtualPS2Controller>
          <VirtualPCIController>
            <key>100</key>
            <deviceInfo>
              <label>PCI controller 0</label>
              <summary>PCI controller 0</summary>
            </deviceInfo>
            <busNumber>0</busNumber>
            <device>500</device>
            <device>12000</device>
            <device>1000</device>
            <device>4000</device>
          </VirtualPCIController>
          <VirtualSIOController>
            <key>400</key>
            <deviceInfo>
              <label>SIO controller 0</label>
              <summary>SIO controller 0</summary>
            </deviceInfo>
            <busNumber>0</busNumber>
            <device>8000</device>
          </VirtualSIOController>
          <VirtualKeyboard>
            <key>600</key>
            <deviceInfo>
              <label>Keyboard </label>
              <summary>Keyboard</summary>
            </deviceInfo>
            <controllerKey>300</controllerKey>
            <unitNumber>0</unitNumber>
          </VirtualKeyboard>
          <VirtualPointingDevice>
            <key>700</key>
            <deviceInfo>
              <label>Pointing device</label>
              <summary>Pointing device; Device</summary>
            </deviceInfo>
            <VirtualPointingDeviceDeviceBackingInfo>
              <deviceName></deviceName>
              <useAutoDetect>false</useAutoDetect>
              <hostPointingDevice>autodetect</hostPointingDevice>
            </VirtualPointingDeviceDeviceBackingInfo>
            <controllerKey>300</controllerKey>
            <unitNumber>1</unitNumber>
          </VirtualPointingDevice>
          <VirtualMachineVideoCard>
            <key>500</key>
            <deviceInfo>
              <label>Video card </label>
              <summary>Video card</summary>
            </deviceInfo>
            <controllerKey>100</controllerKey>
            <unitNumber>0</unitNumber>
            <videoRamSizeInKB>8192</videoRamSizeInKB>
            <useAutoDetect>false</useAutoDetect>
            <enable3DSupport>false</enable3DSupport>
          </VirtualMachineVideoCard>
          <VirtualMachineVMCIDevice>
            <key>12000</key>
            <deviceInfo>
              <label>VMCI device</label>
              <summary>Device on the virtual machine PCI bus that provides support for the virtual machine communication interface</summary>
            </deviceInfo>
            <controllerKey>100</controllerKey>
            <unitNumber>17</unitNumber>
            <id>-1024881702</id>
            <allowUnrestrictedCommunication>false</allowUnrestrictedCommunication>
          </VirtualMachineVMCIDevice>
          <VirtualLsiLogicSASController>
            <key>1000</key>
            <deviceInfo>
              <label>SCSI controller 0</label>
              <summary>LSI Logic SAS</summary>
            </deviceInfo>
            <controllerKey>100</controllerKey>
            <unitNumber>3</unitNumber>
            <busNumber>0</busNumber>
            <device>2000</device>
            <hotAddRemove>true</hotAddRemove>
            <sharedBus>noSharing</sharedBus>
            <scsiCtlrUnitNumber>7</scsiCtlrUnitNumber>
          </VirtualLsiLogicSASController>
          <VirtualDisk>
            <key>2000</key>
            <deviceInfo>
              <label>Hard disk 1</label>
              <summary>41,943,040 KB</summary>
            </deviceInfo>
            <VirtualDiskFlatVer2BackingInfo>
              <fileName>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.vmdk</fileName>
              <Datastore>datastore-10</Datastore>
              <diskMode>persistent</diskMode>
              <split>false</split>
              <writeThrough>false</writeThrough>
              <thinProvisioned>false</thinProvisioned>
              <uuid>6000C29c-8885-1265-81b5-c0c339a30272</uuid>
              <contentId>571801ae5f5f6fb528117783a4270aa7</contentId>
            </VirtualDiskFlatVer2BackingInfo>
            <controllerKey>1000</controllerKey>
            <unitNumber>0</unitNumber>
            <capacityInKB>41943040</capacityInKB>
            <shares>
              <shares>1000</shares>
              <level>normal</level>
            </shares>
            <storageIOAllocation>
              <limit>-1</limit>
              <shares>
                <shares>1000</shares>
                <level>normal</level>
              </shares>
            </storageIOAllocation>
          </VirtualDisk>
          <VirtualCdrom>
            <key>3002</key>
            <deviceInfo>
              <label>CD/DVD Drive 1</label>
              <summary>ATAPI CD/DVD Drive 1</summary>
            </deviceInfo>
            <VirtualCdromAtapiBackingInfo>
              <deviceName>CD/DVD Drive 1</deviceName>
              <useAutoDetect>false</useAutoDetect>
            </VirtualCdromAtapiBackingInfo>
            <connectable>
              <startConnected>false</startConnected>
              <allowGuestControl>true</allowGuestControl>
              <connected>false</connected>
              <status>untried</status>
            </connectable>
            <controllerKey>201</controllerKey>
            <unitNumber>0</unitNumber>
          </VirtualCdrom>
          <VirtualE1000>
            <key>4000</key>
            <deviceInfo>
              <label>Network adapter 1</label>
              <summary>VM Network</summary>
            </deviceInfo>
            <VirtualEthernetCardNetworkBackingInfo>
              <deviceName>VM Network</deviceName>
              <useAutoDetect>false</useAutoDetect>
              <Network>network-11</Network>
            </VirtualEthernetCardNetworkBackingInfo>
            <connectable>
              <startConnected>true</startConnected>
              <allowGuestControl>true</allowGuestControl>
              <connected>true</connected>
              <status>ok</status>
            </connectable>
            <controllerKey>100</controllerKey>
            <unitNumber>7</unitNumber>
            <addressType>generated</addressType>
            <macAddress>00:0c:29:e9:8b:da</macAddress>
            <wakeOnLanEnabled>false</wakeOnLanEnabled>
          </VirtualE1000>
          <VirtualFloppy>
            <key>8000</key>
            <deviceInfo>
              <label>Floppy drive 1</label>
              <summary>Floppy drive 1</summary>
            </deviceInfo>
            <VirtualFloppyDeviceBackingInfo>
              <deviceName>Floppy drive 1</deviceName>
              <useAutoDetect>false</useAutoDetect>
            </VirtualFloppyDeviceBackingInfo>
            <connectable>
              <startConnected>false</startConnected>
              <allowGuestControl>true</allowGuestControl>
              <connected>false</connected>
              <status>untried</status>
            </connectable>
            <controllerKey>400</controllerKey>
            <unitNumber>0</unitNumber>
          </VirtualFloppy>
        </hardware>
        <cpuAllocation>
          <reservation>0</reservation>
          <limit>-1</limit>
          <shares>
            <shares>4000</shares>
            <level>normal</level>
          </shares>
        </cpuAllocation>
        <memoryAllocation>
          <reservation>0</reservation>
          <limit>-1</limit>
          <shares>
            <shares>61440</shares>
            <level>normal</level>
          </shares>
        </memoryAllocation>
        <memoryHotAddEnabled>false</memoryHotAddEnabled>
        <cpuHotAddEnabled>false</cpuHotAddEnabled>
        <cpuHotRemoveEnabled>false</cpuHotRemoveEnabled>
        <hotPlugMemoryLimit>6144</hotPlugMemoryLimit>
        <hotPlugMemoryIncrementSize>0</hotPlugMemoryIncrementSize>
        <extraConfig>
          <key>nvram</key>
          <value>Win-2008r2-machine3.nvram</value>
        </extraConfig>
        <extraConfig>
          <key>virtualHW.productCompatibility</key>
          <value>hosted</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge0.present</key>
          <value>true</value>
        </extraConfig>
        <extraConfig>
          <key>disk.EnableUUID</key>
          <value>true</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge4.present</key>
          <value>true</value>
        </extraConfig>
        <extraConfig>
          <key>replay.supported</key>
          <value>false</value>
        </extraConfig>
        <extraConfig>
          <key>sched.swap.derivedName</key>
          <value>/vmfs/volumes/51b894df-884656a8-6c11-0024e85eae1d/Win-2008r2-machine3/Win-2008r2-machine3-efb79315.vswp</value>
        </extraConfig>
        <extraConfig>
          <key>scsi0:0.redo</key>
          <value></value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge0.pciSlotNumber</key>
          <value>17</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge4.pciSlotNumber</key>
          <value>21</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge5.pciSlotNumber</key>
          <value>22</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge4.virtualDev</key>
          <value>pcieRootPort</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge6.pciSlotNumber</key>
          <value>23</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge7.pciSlotNumber</key>
          <value>24</value>
        </extraConfig>
        <extraConfig>
          <key>scsi0.pciSlotNumber</key>
          <value>160</value>
        </extraConfig>
        <extraConfig>
          <key>ethernet0.pciSlotNumber</key>
          <value>32</value>
        </extraConfig>
        <extraConfig>
          <key>vmci0.pciSlotNumber</key>
          <value>33</value>
        </extraConfig>
        <extraConfig>
          <key>scsi0.sasWWID</key>
          <value>50 05 05 6b c4 19 1c 20</value>
        </extraConfig>
        <extraConfig>
          <key>vmotion.checkpointFBSize</key>
          <value>8388608</value>
        </extraConfig>
        <extraConfig>
          <key>ethernet0.generatedAddressOffset</key>
          <value>0</value>
        </extraConfig>
        <extraConfig>
          <key>hostCPUID.0</key>
          <value>0000000b756e65476c65746e49656e69</value>
        </extraConfig>
        <extraConfig>
          <key>hostCPUID.1</key>
          <value>000106d100080800000ce33dbfebfbff</value>
        </extraConfig>
        <extraConfig>
          <key>hostCPUID.80000001</key>
          <value>00000000000000000000000120100800</value>
        </extraConfig>
        <extraConfig>
          <key>guestCPUID.0</key>
          <value>0000000b756e65476c65746e49656e69</value>
        </extraConfig>
        <extraConfig>
          <key>guestCPUID.1</key>
          <value>000106d100010800800822010febfbff</value>
        </extraConfig>
        <extraConfig>
          <key>guestCPUID.80000001</key>
          <value>00000000000000000000000120100800</value>
        </extraConfig>
        <extraConfig>
          <key>userCPUID.0</key>
          <value>0000000b756e65476c65746e49656e69</value>
        </extraConfig>
        <extraConfig>
          <key>userCPUID.1</key>
          <value>000106d100080800000822010febfbff</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge4.functions</key>
          <value>8</value>
        </extraConfig>
        <extraConfig>
          <key>userCPUID.80000001</key>
          <value>00000000000000000000000120100800</value>
        </extraConfig>
        <extraConfig>
          <key>evcCompatibilityMode</key>
          <value>false</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge5.present</key>
          <value>true</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge5.virtualDev</key>
          <value>pcieRootPort</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge5.functions</key>
          <value>8</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge6.present</key>
          <value>true</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge6.virtualDev</key>
          <value>pcieRootPort</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge6.functions</key>
          <value>8</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge7.present</key>
          <value>true</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge7.virtualDev</key>
          <value>pcieRootPort</value>
        </extraConfig>
        <extraConfig>
          <key>pciBridge7.functions</key>
          <value>8</value>
        </extraConfig>
        <extraConfig>
          <key>vmware.tools.internalversion</key>
          <value>0</value>
        </extraConfig>
        <extraConfig>
          <key>vmware.tools.requiredversion</key>
          <value>8290</value>
        </extraConfig>
        <extraConfig>
          <key>vmware.tools.installstate</key>
          <value>none</value>
        </extraConfig>
        <extraConfig>
          <key>vmware.tools.lastInstallStatus</key>
          <value>unknown</value>
        </extraConfig>
        <datastoreUrl>
          <name>datastore1</name>
          <url>/vmfs/volumes/51b894df-884656a8-6c11-0024e85eae1d</url>
        </datastoreUrl>
        <swapPlacement>inherit</swapPlacement>
        <bootOptions>
          <bootDelay>0</bootDelay>
          <enterBIOSSetup>false</enterBIOSSetup>
          <bootRetryEnabled>false</bootRetryEnabled>
          <bootRetryDelay>10000</bootRetryDelay>
        </bootOptions>
        <vAssertsEnabled>false</vAssertsEnabled>
        <changeTrackingEnabled>false</changeTrackingEnabled>
      </config>
      <configIssue></configIssue>
      <configStatus>green</configStatus>
      <customValue></customValue>
      <datastore>
        <Datastore>datastore-10</Datastore>
      </datastore>
      <declaredAlarmState>
        <AlarmState>
          <key>alarm-11.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-11</Alarm>
          <overallStatus>gray</overallStatus>
          <time>2013-06-29T05:10:15.138671Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-12.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-12</Alarm>
          <overallStatus>gray</overallStatus>
          <time>2013-06-29T05:10:15.140625Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-2.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-2</Alarm>
          <overallStatus>gray</overallStatus>
          <time>2013-06-29T05:10:15.146484Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-26.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-26</Alarm>
          <overallStatus>gray</overallStatus>
          <time>2013-06-29T05:10:15.152343Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-29.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-29</Alarm>
          <overallStatus>gray</overallStatus>
          <time>2013-06-29T05:10:15.155273Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-31.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-31</Alarm>
          <overallStatus>gray</overallStatus>
          <time>2013-06-29T05:10:15.158203Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-35.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-35</Alarm>
          <overallStatus>gray</overallStatus>
          <time>2013-06-29T05:10:15.160156Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-6.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-6</Alarm>
          <overallStatus>green</overallStatus>
          <time>2013-07-19T00:06:37Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-7.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-7</Alarm>
          <overallStatus>green</overallStatus>
          <time>2013-07-19T00:06:37Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
        <AlarmState>
          <key>alarm-8.vm-12</key>
          <VirtualMachine>vm-12</VirtualMachine>
          <Alarm>alarm-8</Alarm>
          <overallStatus>green</overallStatus>
          <time>2013-07-19T00:06:37Z</time>
          <acknowledged>false</acknowledged>
        </AlarmState>
      </declaredAlarmState>
      <disabledMethod>
        <string>CreateSecondaryVM_Task</string>
        <string>TurnOffFaultToleranceForVM_Task</string>
        <string>MakePrimaryVM_Task</string>
        <string>TerminateFaultTolerantVM_Task</string>
        <string>DisableSecondaryVM_Task</string>
        <string>EnableSecondaryVM_Task</string>
        <string>Destroy_Task</string>
        <string>UnregisterVM</string>
        <string>RevertToCurrentSnapshot_Task</string>
        <string>RemoveAllSnapshots_Task</string>
        <string>UnmountToolsInstaller</string>
        <string>RebootGuest</string>
        <string>StandbyGuest</string>
        <string>ShutdownGuest</string>
        <string>AnswerVM</string>
        <string>UpgradeVM_Task</string>
        <string>UpgradeTools_Task</string>
        <string>TurnOffFaultToleranceForVM_Task</string>
        <string>MakePrimaryVM_Task</string>
        <string>TerminateFaultTolerantVM_Task</string>
        <string>DisableSecondaryVM_Task</string>
        <string>EnableSecondaryVM_Task</string>
        <string>StopRecording_Task</string>
        <string>StopReplaying_Task</string>
        <string>CustomizeVM_Task</string>
        <string>MarkAsTemplate</string>
        <string>ResetGuestInformation</string>
        <string>ExportVm</string>
        <string>PowerOnVM_Task</string>
        <string>MarkAsVirtualMachine</string>
      </disabledMethod>
      <effectiveRole>
        <int>-1</int>
      </effectiveRole>
      <environmentBrowser>envbrowser-12</environmentBrowser>
      <guest>
        <toolsStatus>toolsNotInstalled</toolsStatus>
        <toolsVersionStatus>guestToolsNotInstalled</toolsVersionStatus>
        <toolsRunningStatus>guestToolsNotRunning</toolsRunningStatus>
        <guestState>notRunning</guestState>
      </guest>
      <guestHeartbeatStatus>gray</guestHeartbeatStatus>
      <layout>
        <configFile>Win-2008r2-machine3.vmxf</configFile>
        <configFile>Win-2008r2-machine3.nvram</configFile>
        <configFile>Win-2008r2-machine3.vmsd</configFile>
        <logFile>vmware.log</logFile>
        <disk>
          <key>2000</key>
          <diskFile>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.vmdk</diskFile>
        </disk>
        <swapFile>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3-efb79315.vswp</swapFile>
      </layout>
      <layoutEx>
        <file>
          <key>0</key>
          <name>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.vmdk</name>
          <type>diskDescriptor</type>
          <size>480</size>
        </file>
        <file>
          <key>1</key>
          <name>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3-flat.vmdk</name>
          <type>diskExtent</type>
          <size>42949672960</size>
        </file>
        <file>
          <key>2</key>
          <name>[datastore1] Win-2008r2-machine3/vmware.log</name>
          <type>log</type>
          <size>533113</size>
        </file>
        <file>
          <key>3</key>
          <name>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.vmx</name>
          <type>config</type>
          <size>2907</size>
        </file>
        <file>
          <key>4</key>
          <name>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.vmxf</name>
          <type>extendedConfig</type>
          <size>274</size>
        </file>
        <file>
          <key>5</key>
          <name>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.nvram</name>
          <type>nvram</type>
          <size>8684</size>
        </file>
        <file>
          <key>6</key>
          <name>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.vmsd</name>
          <type>snapshotList</type>
          <size>0</size>
        </file>
        <file>
          <key>7</key>
          <name>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3-efb79315.vswp</name>
          <type>swap</type>
          <size>6442450944</size>
        </file>
        <disk>
          <key>2000</key>
          <chain>
            <fileKey>0</fileKey>
            <fileKey>1</fileKey>
          </chain>
        </disk>
        <timestamp>2013-08-05T22:59:00.261718Z</timestamp>
      </layoutEx>
      <name>Win-2008r2-machine3</name>
      <network>
        <Network>network-11</Network>
      </network>
      <overallStatus>green</overallStatus>
      <parent>group-v3</parent>
      <permission></permission>
      <recentTask></recentTask>
      <resourceConfig>
        <VirtualMachine>vm-12</VirtualMachine>
        <cpuAllocation>
          <reservation>0</reservation>
          <limit>-1</limit>
          <shares>
            <shares>4000</shares>
            <level>normal</level>
          </shares>
        </cpuAllocation>
        <memoryAllocation>
          <reservation>0</reservation>
          <limit>-1</limit>
          <shares>
            <shares>61440</shares>
            <level>normal</level>
          </shares>
        </memoryAllocation>
      </resourceConfig>
      <resourcePool>resgroup-35</resourcePool>
      <rootSnapshot></rootSnapshot>
      <runtime>
        <device>
          <VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState>
            <vmDirectPathGen2Active>false</vmDirectPathGen2Active>
            <vmDirectPathGen2InactiveReasonVm>vmNptIncompatibleAdapterType</vmDirectPathGen2InactiveReasonVm>
          </VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState>
          <key>4000</key>
        </device>
        <HostSystem>host-9</HostSystem>
        <connectionState>connected</connectionState>
        <powerState>poweredOn</powerState>
        <faultToleranceState>notConfigured</faultToleranceState>
        <toolsInstallerMounted>false</toolsInstallerMounted>
        <bootTime>2013-06-21T00:05:22.578153Z</bootTime>
        <suspendInterval>0</suspendInterval>
        <memoryOverhead>430809088</memoryOverhead>
        <maxCpuUsage>8508</maxCpuUsage>
        <maxMemoryUsage>6144</maxMemoryUsage>
        <numMksConnections>0</numMksConnections>
        <recordReplayState>inactive</recordReplayState>
      </runtime>
      <storage>
        <perDatastoreUsage>
          <Datastore>datastore-10</Datastore>
          <committed>49392669362</committed>
          <uncommitted>0</uncommitted>
          <unshared>49392669362</unshared>
        </perDatastoreUsage>
        <timestamp>2013-08-05T22:59:00.263Z</timestamp>
      </storage>
      <summary>
        <VirtualMachine>vm-12</VirtualMachine>
        <runtime>
          <device>
            <VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState>
              <vmDirectPathGen2Active>false</vmDirectPathGen2Active>
              <vmDirectPathGen2InactiveReasonVm>vmNptIncompatibleAdapterType</vmDirectPathGen2InactiveReasonVm>
            </VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState>
            <key>4000</key>
          </device>
          <HostSystem>host-9</HostSystem>
          <connectionState>connected</connectionState>
          <powerState>poweredOn</powerState>
          <faultToleranceState>notConfigured</faultToleranceState>
          <toolsInstallerMounted>false</toolsInstallerMounted>
          <bootTime>2013-06-21T00:05:22.578153Z</bootTime>
          <suspendInterval>0</suspendInterval>
          <memoryOverhead>430809088</memoryOverhead>
          <maxCpuUsage>8508</maxCpuUsage>
          <maxMemoryUsage>6144</maxMemoryUsage>
          <numMksConnections>0</numMksConnections>
          <recordReplayState>inactive</recordReplayState>
        </runtime>
        <guest>
          <toolsStatus>toolsNotInstalled</toolsStatus>
          <toolsVersionStatus>guestToolsNotInstalled</toolsVersionStatus>
          <toolsRunningStatus>guestToolsNotRunning</toolsRunningStatus>
        </guest>
        <config>
          <name>Win-2008r2-machine3</name>
          <template>false</template>
          <vmPathName>[datastore1] Win-2008r2-machine3/Win-2008r2-machine3.vmx</vmPathName>
          <memorySizeMB>6144</memorySizeMB>
          <cpuReservation>0</cpuReservation>
          <memoryReservation>0</memoryReservation>
          <numCpu>4</numCpu>
          <numEthernetCards>1</numEthernetCards>
          <numVirtualDisks>1</numVirtualDisks>
          <uuid>564d317b-c419-1c29-4238-5c8fc2e98bda</uuid>
          <instanceUuid>52bff4c6-0729-f5f3-5374-c6b356c97d87</instanceUuid>
          <guestFullName></guestFullName>
          <installBootRequired>false</installBootRequired>
        </config>
        <storage>
          <committed>49392669362</committed>
          <uncommitted>0</uncommitted>
          <unshared>49392669362</unshared>
          <timestamp>2013-08-05T22:59:00.264648Z</timestamp>
        </storage>
        <quickStats>
          <overallCpuUsage>1595</overallCpuUsage>
          <overallCpuDemand>1616</overallCpuDemand>
          <guestMemoryUsage>921</guestMemoryUsage>
          <hostMemoryUsage>5552</hostMemoryUsage>
          <guestHeartbeatStatus>red</guestHeartbeatStatus>
          <distributedCpuEntitlement>0</distributedCpuEntitlement>
          <distributedMemoryEntitlement>0</distributedMemoryEntitlement>
          <staticCpuEntitlement>0</staticCpuEntitlement>
          <staticMemoryEntitlement>0</staticMemoryEntitlement>
          <privateMemory>4854</privateMemory>
          <sharedMemory>1290</sharedMemory>
          <swappedMemory>0</swappedMemory>
          <balloonedMemory>0</balloonedMemory>
          <consumedOverheadMemory>314</consumedOverheadMemory>
          <ftLogBandwidth>-1</ftLogBandwidth>
          <ftSecondaryLatency>-1</ftSecondaryLatency>
          <ftLatencyStatus>gray</ftLatencyStatus>
          <compressedMemory>0</compressedMemory>
          <uptimeSeconds>3977724</uptimeSeconds>
        </quickStats>
        <overallStatus>green</overallStatus>
      </summary>
      <tag>
        <Tag>
          <key>SYSTEM/COM.VMWARE.VIM.VC</key>
        </Tag>
      </tag>
      <triggeredAlarmState></triggeredAlarmState>
      <value></value>
    </returnval>
 </RetrieveClusterVirtualMachinesResponse>
</vmware-infrastructure-response>

Note

When you specify the <retrieve-all-vm-properties> element as true, all properties for all the virtual machines in the cluster are retrieved. If false, (by default, the <retrieve-all-vm-properties> element is not specified), the default Retrieve Cluster Virtual Machines operation is run, which retrieves only the name and type for all the virtual machines in the cluster.

The following code sample shows a sample adapter request for the Retrieve Cluster Virtual Machines operation when the <retrieve-all-vm-properties> element is set to false.

Sample adapter request for the Retrieve Cluster Virtual Machines operation

<vmware-infrastructure-request>
    <operation-type>Cluster</operation-type>
    <operation-name>Retrieve_Cluster_Virtual_Machines</operation-name>
    <parameters>
      <cluster-compute-resource>Test Cluster</cluster-compute-resource>
    </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Retrieve Cluster Virtual Machines operation.

Adapter response for the Retrieve Cluster Virtual Machines operation

 Sample adapter response for the Retrieve Cluster Virtual Machines operation
<vmware-infrastructure-response>
  <metadata>
    <status>success</status>
  </metadata>
  <RetrieveClusterVirtualMachinesResponse>
    <returnval>
      <VirtualMachine>vm-318</VirtualMachine>
      <template>true</template>
      <name>TestTemplate</name>
    </returnval>
    <returnval>
      <VirtualMachine>vm-307</VirtualMachine>
      <template>false</template>
      <name>testvm</name>
    </returnval>
    <returnval>
      <VirtualMachine>vm-135</VirtualMachine>
      <template>false</template>
      <name>VappTemplate (33a5773c-efd9-4e55-80c7-bdc379c2de9b)</name>
    </returnval>
    
    	-----------------------------------------------
	--------------------------------------------------
	-------------------------------------------------
    <returnval>
      <VirtualMachine>vm-248</VirtualMachine>
      <template>false</template>
      <name>New Virtual Machine 2</name>
    </returnval>
    <returnval>
      <VirtualMachine>vm-241</VirtualMachine>
      <template>false</template>
      <name>vm1</name>
    </returnval>
    <returnval>
      <VirtualMachine>vm-204</VirtualMachine>
      <template>false</template>
      <name>VappTemplate11 (8bc1630c-0f78-458d-abad-27337a74284b)</name>
    </returnval>
  </RetrieveClusterVirtualMachinesResponse>
</vmware-infrastructure-response>

The following table describes the response elements.

Adapter response elements for the Retrieve Cluster Virtual Machines operation.

ElementDefinition

<VirtualMachine>

Contains the managed object reference (MoRef) of the virtual machine or virtual machine template

<template>

Contains the Boolean value that indicates whether the virtual machine is a template

<name>

Contains the name of the virtual machine or virtual machine template

Was this page helpful? Yes No Submitting... Thank you

Comments