Retrieve VM Configuration operation

The Retrieve VM Configuration operation retrieves the configuration parameters for the specified virtual machine. 

The following table describes the elements for this request.

Adapter request elements for the Retrieve VM Configuration operation

Element

Definition

Required

<operation-type>

Defines the type of the operation: Configure_Vm

Yes

<operation-name>

Defines the name of the operation: Retrieve_VM_Configuration

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 <virtual-machine> element required to execute the operation

Yes

<virtual machine>

Contains the name of the virtual machine for which the configuration details are to be retrieved

Yes

The following figure shows a sample adapter request for the Retrieve VM Configuration operation.

Sample adapter request for the Retrieve VM Configuration operation

<vmware-infrastructure-request>
    <operation-type>Configure_Vm</operation-type>
    <operation-name>Retrieve_VM_Configuration</operation-name>
   <soap-url></soap-url>
   <transport></transport>
    <user-name></user-name>
    <password></password>
    <parameters>
        <virtual-machine>sun1</virtual-machine>
    </parameters>
</vmware-infrastructure-request>

The following figure shows the response for the sample Retrieve VM Configuration operation.

Sample adapter response for the Retrieve VM Configuration operation

 <vmware-infrastructure-response>
    <metadata>
        <status>success</status>
    </metadata>
    <RetrieveVMConfigurationResponse>
        <returnval>
        <VirtualMachine>TestDev</VirtualMachine>
        <propSet>
        <name>capability</name>
        <VirtualMachineCapability>
            <snapshotOperationsSupported>true</snapshotOperationsSupported>
            <multipleSnapshotsSupported>true</multipleSnapshotsSupported>
            <snapshotConfigSupported>true</snapshotConfigSupported>
            <poweredOffSnapshotsSupported>true</poweredOffSnapshotsSupported>
            <memorySnapshotsSupported>true</memorySnapshotsSupported>
            <revertToSnapshotSupported>true</revertToSnapshotSupported>
            <quiescedSnapshotsSupported>true</quiescedSnapshotsSupported>
            <consolePreferencesSupported>true</consolePreferencesSupported>
            <cpuFeatureMaskSupported>true</cpuFeatureMaskSupported>
            <s1AcpiManagementSupported>true</s1AcpiManagementSupported>             <settingScreenResolutionSupported>false</settingScreenResolutionSupported>
            <toolsAutoUpdateSupported>false</toolsAutoUpdateSupported>
        </VirtualMachineCapability>
        </propSet>
        <propSet>
            <name>config</name>
            <VirtualMachineConfigInfo>
            <changeVersion>2009-06-11T00:59:51.37633Z</changeVersion>
            <modified>1970-01-01T00:00:00Z</modified>
             <name>TestDev</name>
            <guestFullName>Microsoft Windows Server 2003, Standard Edition (32-bit)</guestFullName>
            <version>vmx-04</version>
            <uuid>5004090b-99b7-4232-8bf4-1ef1ef420160</uuid>
            <locationId>564ddc25-1718-9007-8a72-d823c019aff3</locationId>
            <template>false</template>
            <guestId>winNetStandardGuest</guestId>
            <annotation/>
            <files><vmPathName>[dev15 disk1] TestDev/TestDev.vmx</vmPathName>
                <snapshotDirectory>[dev15 disk2] TestDev/</snapshotDirectory>
                <suspendDirectory>[dev15 disk2] TestDev/</suspendDirectory>
                <logDirectory>[dev15 disk1] TestDev/</logDirectory>
            </files>
            <tools>
                <afterPowerOn>true</afterPowerOn>
                <afterResume>true</afterResume>
                <beforeGuestStandby>true</beforeGuestStandby>
                <beforeGuestShutdown>true</beforeGuestShutdown>
            </tools>
             <flags>
               <disableAcceleration>false</disableAcceleration>
                <enableLogging>true</enableLogging>
                <useToe>false</useToe>
                <runWithDebugInfo>false</runWithDebugInfo>
                <htSharing>any</htSharing>
            </flags>
            <defaultPowerOps>
                <powerOffType>preset</powerOffType>
                <suspendType>preset</suspendType>
                <resetType>preset</resetType>
                <defaultPowerOffType>hard</defaultPowerOffType>
                <defaultSuspendType>hard</defaultSuspendType>
                <defaultResetType>hard</defaultResetType>
                <standbyAction>checkpoint</standbyAction>
            </defaultPowerOps>
            <hardware>
                <numCPU>1</numCPU>
                <memoryMB>256</memoryMB>
                <VirtualIDEController>
                    <key>200</key>
                    <deviceInfo>
                        <label>IDE 0</label>
                        <summary>IDE 0</summary>
                    </deviceInfo>
                    <busNumber>0</busNumber>
                    <device>3000</device>
                </VirtualIDEController>
                <VirtualPS2Controller>
                    <key>300</key>
                    <deviceInfo>
                        <label>PS2 Controller </label>
                        <summary>PS2 Controller</summary>
                    </deviceInfo>
                    <busNumber>0</busNumber>
                    <device>600</device>
                    <device>700</device>
                    </VirtualPS2Controller>
                    <VirtualPCIController>
                        <key>100</key>
                        <deviceInfo>
                            <label>PCI Controller </label>
                            <summary>PCI Controller</summary>
                        </deviceInfo>
                        <busNumber>0</busNumber>
                         <device>500</device>
                    </VirtualPCIController>
                     <VirtualSIOController>
                        <key>400</key>
                        <deviceInfo>
                            <label>SIO Controller</label>
                            <summary>SIO Controller</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/>
                                <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>4096</videoRamSizeInKB>
                            </VirtualMachineVideoCard>
                            <VirtualFloppy>
                                <key>8000</key>
                                <deviceInfo>
                                    <label>Floppy Drive 1</label>
                                    <summary>Remote /dev/fd0</summary>
                                </deviceInfo>
                               <VirtualFloppyRemoteDeviceBackingInfo>
                                    <deviceName>/dev/fd0</deviceName>
                                </VirtualFloppyRemoteDeviceBackingInfo>
                                 <connectable>
                                    <startConnected>false</startConnected>
                                     <allowGuestControl>true</allowGuestControl>
                                 <connected>false</connected>
                                 </connectable>
                                <controllerkey>400</controllerkey>
                                <unitnumber>0</unitnumber>
                            </VirtualFloppy>
                            <VirtualCdrom>
                                <key>3000</key>
                                <deviceInfo>
                                    <label>CD/DVD Drive 1</label>
                                    <summary>Remote device</summary>
                                </deviceInfo>
                                <VirtualCdromRemotePassthroughBackingInfo>
                                    <deviceName/>
                                    <exclusive>false</exclusive>
                                </VirtualCdromRemotePassthroughBackingInfo>
                                <connectable>
                                    <startConnected>false</startConnected>
                                    <allowGuestControl>true</allowGuestControl>
                                    <connected>false</connected>
                                 </connectable>
                                 <controllerkey>200</controllerkey>
                                </VirtualDisk>
                                <unitnumber>0</unitnumber>
                            </VirtualCdrom>
                            <VirtualPCNet32>
                                <key>4000</key>
                                <deviceInfo>
                                    <label>Network Adapter 1</label>
                                    <summary>VM Network</summary>
                                </deviceInfo>
                                <VirtualEthernetCardNetworkBackingInfo>
                                    <deviceName>VM Network</deviceName>
                                    <Network>network-17</Network>
                                </VirtualEthernetCardNetworkBackingInfo>
                                <connectable>
                                    <startConnected>true</startConnected>
                                     <allowGuestControl>true</allowGuestControl>
                                    <connected>true</connected>
                                </connectable>
                                    <controllerkey>100</controllerkey>
                                    <unitnumber>7</unitnumber>
                                    <addressType>assigned</addressType>
                                    <macAddress>00:50:56:84:26:8b</macAddress>
                                    <wakeOnLanEnabled>true</wakeOnLanEnabled>
                                    </VirtualPCNet32>
                                    <VirtualLsiLogicController>
                                        <key>1000</key>
                                        <deviceInfo>
                                            <label>SCSI Controller 0</label>
                                            <summary>LSI Logic</summary>
                                        </deviceInfo>
                                        <controllerkey>100</controllerkey>
                                        <unitnumber>3</unitnumber>
                                        <busNumber>0</busNumber>
                                        <device>2000</device>
                                        <hotAddRemove>true</hotAddRemove>
                                        <sharedBus>noSharing</sharedBus>
                                        <scsiCtlrUnitNumber>7</scsiCtlrUnitNumber>
                                    </VirtualLsiLogicController>
                                    <VirtualDisk>
                                        <key>2000</key>
                                        <deviceInfo>
                                            <label>Hard Disk 1</label>
                                            <summary>0 KB</summary>
                                        </deviceInfo>
                                        <VirtualDiskFlatVer2BackingInfo>
                                            <file-name>[dev15 disk1] TestDev/TestDev-000004.vmdk</file-name>
                                             <Datastore>datastore-11</Datastore>
                                             <disk-mode>persistent</disk-mode>
                                             <split>false</split>
                                             <writethrough>false</writethrough>
                                             <thinprovisioned>false</thinprovisioned>
                                        </VirtualDiskFlatVer2BackingInfo>
                                        <controllerkey>1000</controllerkey>
                                        <unitnumber>0</unitnumber>
                                        <capacityinKB>0</capacityinKB>
                                        <shares>
                                                <shares>1000</shares>
                                                <level>normal</level>
                                            </shares>
                                         <extraConfig>
                                               <key>vmware.tools.lastInstallStatus.result</key>
                                             <value>unknown</value>
                                         </extraConfig>
                                         <cpuFeatureMask>
                                             <level>0</level>
                                         </cpuFeatureMask>
                                         <cpuFeatureMask>
                                             <level>0</level>
                                             <vendor>amd</vendor>
                                         </cpuFeatureMask>
                                         <cpuFeatureMask>
                                             <level>1</level>
                                         </cpuFeatureMask>
                                         <cpuFeatureMask>
                                             <level>1</level>
                                             <vendor>amd</vendor>
                                         </cpuFeatureMask>
                                          <datastoreUrl>
                                             <name>dev15 disk1</name>
                                             <url>/vmfs/volumes/470e81f0-32b2d06a-a25c-0019b9e1c5fe</url>
                                          </datastoreUrl>
            <VirtualMachineConfigInfo>
            </propSet>
            <propSet>
                <name>configIssue</name>
                <ArrayOfEvent/>
             </propSet>
             <propSet>
                <name>configStatus</name>
                <ManagedEntityStatus>green</ManagedEntityStatus>
             </propSet>
             <propSet>
                <name>customValue</name>
                <ArrayOfCustomFieldValue/>
             </propSet>
             <propSet>
                <name>datastore</name>
                <ArrayOfManagedObjectReference>
                <Datastore>datastore-11</Datastore>
                </ArrayOfManagedObjectReference>
             </propSet>
             <propSet>
                <name>declaredAlarmState</name>
                <ArrayOfAlarmState>
                    <AlarmState>
                        <key>alarm-4.TestDev</key>
                        <VirtualMachine>TestDev</VirtualMachine>
                    <Alarm>alarm-4</Alarm>
                    <overallStatus>gray</overallStatus>
                    <time>2009-06-18T14:39:06Z</time>
                    </AlarmState>
                </ArrayOfAlarmState>
            </propSet>
            <propSet>
                <name>disabledMethod</name>
                <ArrayOfString>
                    <string>ResetVM_Task</string>
                    <string>UnmountToolsInstaller</string>
                    <string>MountToolsInstaller</string>
                    <string>RebootGuest</string>
                    <string>StandbyGuest</string>
                    <string>ShutdownGuest</string>
                     <string>PowerOffVM_Task</string>
                    <string>SuspendVM_Task</string>
                    <string>AcquireMksTicket</string>
                    <string>AnswerVM</string>
                    <string>UpgradeVM_Task</string>
                    <string>UpgradeTools_Task</string>
                    <string>MarkAsVirtualMachine</string>
                </ArrayOfString>
          </propSet>
          <propSet>
              <name>effectiveRole</name>
              <ArrayOfInt>
                  <int>1</int>
              </ArrayOfInt>
            </propSet>
            <propSet>
                <name>environmentBrowser</name>
                <EnvironmentBrowser>envbrowser-2480</EnvironmentBrowser>
            </propSet>
            <propSet>
                <name>guest</name>
                <GuestInfo>
                    <toolsStatus>toolsNotInstalled</toolsStatus>
                    <guestState>notRunning</guestState>
                </GuestInfo>
            </propSet>
            <propSet>
                <name>guestHeartbeatStatus</name>
                <ManagedEntityStatus>gray</ManagedEntityStatus>
            </propSet>
            <propSet>
                <name>layout</name>
                <VirtualMachineFileLayout>
                <configFile>TestDev.vmsd</configFile>
                <configFile>TestDev.vmxf</configFile>
                <configFile>TestDev.nvram</configFile>
                <logFile>vmware.log</logFile>
                    <disk>
                <key>2000</key>
                <diskFile>[dev15 disk1] TestDev/TestDev-000004.vmdk</diskFile>
                <diskFile>[dev15 disk1] TestDev/TestDev.vmdk</diskFile>
                <diskFile>[dev15 disk2] TestDev/TestDev-000002.vmdk</diskFile>
                    </disk>
                <snapshot>
                    <VirtualMachineSnapshot>snapshot-2693</VirtualMachineSnapshot>
                    <snapshotFile>[dev15 disk1] TestDev/TestDev_2.vmdk</snapshotFile>
                    <snapshotFile>[dev15 disk1] TestDev/TestDev.vmdk</snapshotFile>
                    <snapshotFile>[dev15 disk2] TestDev/TestDev-Snapshot18.vmsn</snapshotFile>
                </snapshot>
                </VirtualMachineFileLayout>
            </propSet>
            <propSet>
                <name>name</name>
                <val>TestDev</val>
            </propSet>
            <propSet>
                <name>network</name>
                <ArrayOfManagedObjectReference>
                    <Network>network-17</Network>
                </ArrayOfManagedObjectReference>
            </propSet>
            <propSet>
                <name>overallStatus</name>
                <ManagedEntityStatus>green</ManagedEntityStatus>
            </propSet>
            <propSet>
                <name>parent</name>
                <Folder>group-v3</Folder>
            </propSet>
            <propSet>
                <name>permission</name>
                <ArrayOfPermission/>
             </propSet>
             <propSet>
                <name>recentTask</name>
                <ArrayOfManagedObjectReference/>
             </propSet>
             <propSet>
                <name>resourceConfig</name>
                <ResourceConfigSpec>
                <VirtualMachine>TestDev</VirtualMachine>
                <cpuAllocation>
                    <reservation>0</reservation>
                    <expandableReservation>false</expandableReservation>
                    <limit>-1</limit>
                    <shares>
                        <shares>1000</shares>
                        <level>normal</level>
                    </shares>
                </cpuAllocation>
                <memoryAllocation>
                    <reservation>0</reservation>
                    <expandableReservation>false</expandableReservation>
                    <limit>-1</limit>
                    <shares>
                        <shares>2560</shares>
                        <level>normal</level>
                     </shares>
                 </memoryAllocation>
             </propSet>
             <propSet>
                 <name>resourcePool</name>
                 <ResourcePool>resgroup-2486</ResourcePool>
             </propSet>
             <propSet>
                 </ResourceConfigSpec>
                 <name>runtime</name>
                 <VirtualMachineRuntimeInfo>
                     <HostSystem>xyz.bmc.com</HostSystem>
                     <connectionState>connected</connectionState>
                     <powerState>poweredOff</powerState>
                     <toolsInstallerMounted>false</toolsInstallerMounted>
                     <bootTime>2009-06-18T10:23:42.919999Z</bootTime>
                     <suspendInterval>0</suspendInterval>
                     <memoryOverhead>71675904</memoryOverhead>
                     <maxCpuUsage>1862</maxCpuUsage>
                     <maxMemoryUsage>256</maxMemoryUsage>
                     <numMksConnections>0</numMksConnections>
                 </VirtualMachineRuntimeInfo>
             </propSet>
             <propSet>
                 <name>snapshot</name>
                 <VirtualMachineSnapshotInfo>
                     <VirtualMachineSnapshot>snapshot-2693</VirtualMachineSnapshot>
                     <rootSnapshotList>
                     <VirtualMachineSnapshot>snapshot-2693</VirtualMachineSnapshot>
                     <VirtualMachine>TestDev</VirtualMachine>
                     <name>TestDevSS</name>
                     <description>from WS</description>
                     <createTime>2009-05-28T04:51:56.286038-04:00</createTime>
                     <state>poweredOff</state>
                     <quiesced>false</quiesced>
                     <childSnapshotList>
                     <VirtualMachineSnapshot>snapshot-2967</VirtualMachineSnapshot>
                     <VirtualMachine>TestDev</VirtualMachine>
                     <name>TestDev2</name>
                     <description>from WS</description>
                     <createTime>2009-06-18T02:59:22.240427-04:00</createTime>
                     <state>poweredOn</state>
                     <quiesced>false</quiesced>
                     </childSnapshotList>
                     </rootSnapshotList>
                </VirtualMachineSnapshotInfo>
           </propSet>
           <propSet>
               <name>summary</name>
               <VirtualMachineSummary>
                   <VirtualMachine>TestDev</VirtualMachine>
                       <runtime>
                           <HostSystem>xyz.bmc.com</HostSystem>
                           <connectionState>connected</connectionState>
                           <powerState>poweredOff</powerState>
                            <toolsInstallerMounted>false</toolsInstallerMounted>
                           <bootTime>2009-06-18T10:23:42.919999Z</bootTime>
                           suspendInterval>0</suspendInterval>
                           <memoryOverhead>71675904</memoryOverhead>
                           <maxCpuUsage>1862</maxCpuUsage>
                           <maxMemoryUsage>256</maxMemoryUsage>
                           <numMksConnections>0</numMksConnections>
                       </runtime>
                       <guest>
                           <toolsStatus>toolsNotInstalled</toolsStatus>
                       </guest>
                       <config>
                           <name>TestDev</name>
                           <template>false</template>
                           <vmPathName>[dev15 disk1] TestDev/TestDev.vmx</vmPathName>
                           <memorySizeMB>256</memorySizeMB>
                           <cpuReservation>0</cpuReservation>
                           <memoryReservation>0</memoryReservation>
                           <numCpu>1</numCpu>
                           <numEthernetCards>1</numEthernetCards>
                           <numVirtualDisks>0</numVirtualDisks>
                           <uuid>5004090b-99b7-4232-8bf4-1ef1ef420160</uuid>
                           <guestId>winNetStandardGuest</guestId>
                           <guestFullName>Microsoft Windows Server 2003, Standard Edition (32-bit)</guestFullName>
                           <annotation/>
                       </config>
                       <quickStats>
                           <overallCpuUsage>0</overallCpuUsage>
                           <guestMemoryUsage>0</guestMemoryUsage>
                           <hostMemoryUsage>0</hostMemoryUsage>
                           <guestHeartbeatStatus>gray</guestHeartbeatStatus>
                       </quickStats>
                       <overallStatus>green</overallStatus>
                       </VirtualMachineSummary>
                  </propSet>
                  <propSet>
                      <name>triggeredAlarmState</name>
                      <ArrayOfAlarmState/>
                  </propSet>
        </returnval>
        </RetrieveVMConfigurationResponse>
</vmware-infrastructure-response>

The following table describes the response elements.

Adapter response elements for the Retrieve VM Configuration operation

Element

Definition

<VirtualMachineCapability>

The information about the operation capabilities of a virtual machine

<VirtualMachineConfigInfo>

The configuration settings and virtual hardware for a virtual machine

<Datastore Array>

The collection of datastore objects in the datacenter that is used by this virtual machine

<GuestInfo>

The information about VMware Tools and about the virtual machine from the perspective of VMware Tools

Information about the guest operating system is available in Virtual Center. Guest operating system information reflects the last known state of the virtual machine.

For machines in the Powered On state, this is current information. For machines in the Powered Off state, this is the last recorded state before the virtual machine was powered off.

<GuestHeartbeatStatus>

The guest heartbeat

The heartbeat status is classified as:

  • gray: VMware Tools are not installed or not running.
  • red: No heartbeat. Guest operating system may have stopped responding.
  • yellow: Intermittent heartbeat. May be due to guest load.
  • green: Guest operating system is responding normally.
<VirtualMachineFileLayout>

Detailed information about the files that comprise the virtual machine

<Network Array>

Collection of network objects in the datacenter that is used by this virtual machine

<ResourceConfigSpec>

The resource configuration for a virtual machine

The shares in this specification are evaluated relative to the resource pool to which it is assigned. This will return null if the product the virtual machine is registered on, does not support resource configuration.

<ResourcePool>

The current resource pool that specifies resource allocation for this virtual machine

<VirtualMachineRuntimeInfo>

The information about the execution state and history of a virtual machine

<VirtualMachineSnapshotInfo>

The information about the hierarchy of snapshots in a virtual machine

<VirtualMachineSummary>

Basic information about this virtual machine
This includes:

  • runtimeInfo
  • guest
  • basic configuration
  • alarms
  • performance information

 

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