Reference for FindEsxServerObjectSummary

Url: vsphere/findSummary

HTTP Method: POST

Message direction | Format | Body
--- | --- | ---
Request | XML | Example,Schema
Response | XML | Example,Schema

The following is an example request XML body:

    <?xml version="1.0" encoding="utf-16"?>
    <findEsxServerObjectRequest xmlns="http://apprecovery.com/management/api/2010/05">
      <agentId>String content</agentId>
      <!--Valid elements of type: oracleInstanceCredentials, instanceCredentials, virtualInstanceCredentials-->
      <credentials i:type="oracleInstanceCredentials" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <credentialsAccountId>1627aea5-8e0a-4371-9022-9b504344e724</credentialsAccountId>
        <encryptPassword>true</encryptPassword>
        <password>String content</password>
        <passwordEncrypted>String content</passwordEncrypted>
        <userName>String content</userName>
        <hostName>String content</hostName>
        <instanceServiceName>String content</instanceServiceName>
        <instanceSid>String content</instanceSid>
        <port>2147483647</port>
        <tnsNetworkAlias>String content</tnsNetworkAlias>
        <useWindowsAuthentication>true</useWindowsAuthentication>
      </credentials>
      <password>String content</password>
      <userName>String content</userName>
      <vcenterHost>String content</vcenterHost>
      <vcenterPort>2147483647</vcenterPort>
      <esxTypeNameFilter>
        <string>String content</string>
        <string>String content</string>
      </esxTypeNameFilter>
      <parentId>String content</parentId>
      <searchById>true</searchById>
      <searchByName>true</searchByName>
    </findEsxServerObjectRequest>

The following is an example response XML body:

    <?xml version="1.0" encoding="utf-16"?>
    <objectBaseSummary i:type="virtualMachineSummary_x0020_" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://apprecovery.com/management/api/2010/05">
      <id>String content</id>
      <name>String content</name>
      <allIpAddresses>
        <string>String content</string>
        <string>String content</string>
      </allIpAddresses>
      <error>
        <message>String content</message>
        <type>String content</type>
        <detail>String content</detail>
        <stackTrace>String content</stackTrace>
        <serverException>
          <message>String content</message>
          <type>String content</type>
          <detail>String content</detail>
          <rawException>QmFzZSA2NCBTdHJlYW0=</rawException>
        </serverException>
      </error>
      <hostName>String content</hostName>
      <ip>String content</ip>
      <isConnected>true</isConnected>
      <isConsolidationNeeded>true</isConsolidationNeeded>
      <isPaused>true</isPaused>
      <isPoweredOn>true</isPoweredOn>
      <isVMToolsOk>true</isVMToolsOk>
      <location>
        <Uuid>String content</Uuid>
        <computeResourceId>String content</computeResourceId>
        <datacenterId>String content</datacenterId>
        <datastoreId>String content</datastoreId>
        <folderid>String content</folderid>
        <id>String content</id>
        <name>String content</name>
        <port>2147483647</port>
        <resourcePoolId>String content</resourcePoolId>
        <server>String content</server>
        <storageProfileId>String content</storageProfileId>
        <useVirtualMachineConfigurationFiles>true</useVirtualMachineConfigurationFiles>
        <virtualMachineVersion>String content</virtualMachineVersion>
      </location>
      <size>18446744073709551615</size>
      <uuid>String content</uuid>
    </objectBaseSummary>

The following is the request XML Schema:

    <?xml version="1.0" encoding="utf-16"?>
    <Schemas>
      <xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:element name="anyType" nillable="true" type="xs:anyType" />
        <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
        <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
        <xs:element name="boolean" nillable="true" type="xs:boolean" />
        <xs:element name="byte" nillable="true" type="xs:byte" />
        <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
        <xs:element name="decimal" nillable="true" type="xs:decimal" />
        <xs:element name="double" nillable="true" type="xs:double" />
        <xs:element name="float" nillable="true" type="xs:float" />
        <xs:element name="int" nillable="true" type="xs:int" />
        <xs:element name="long" nillable="true" type="xs:long" />
        <xs:element name="QName" nillable="true" type="xs:QName" />
        <xs:element name="short" nillable="true" type="xs:short" />
        <xs:element name="string" nillable="true" type="xs:string" />
        <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
        <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
        <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
        <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
        <xs:element name="char" nillable="true" type="tns:char" />
        <xs:simpleType name="char">
          <xs:restriction base="xs:int" />
        </xs:simpleType>
        <xs:element name="duration" nillable="true" type="tns:duration" />
        <xs:simpleType name="duration">
          <xs:restriction base="xs:duration">
            <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
            <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
            <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="guid" nillable="true" type="tns:guid" />
        <xs:simpleType name="guid">
          <xs:restriction base="xs:string">
            <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
          </xs:restriction>
        </xs:simpleType>
        <xs:attribute name="FactoryType" type="xs:QName" />
        <xs:attribute name="Id" type="xs:ID" />
        <xs:attribute name="Ref" type="xs:IDREF" />
      </xs:schema>
      <xs:schema xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
        <xs:complexType name="findEsxServerObjectRequest">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:esxServerSummaryRequest">
              <xs:sequence>
                <xs:element minOccurs="0" name="esxTypeNameFilter" nillable="true" type="tns:stringCollection" />
                <xs:element minOccurs="0" name="parentId" nillable="true" type="xs:string" />
                <xs:element minOccurs="0" name="searchById" type="xs:boolean" />
                <xs:element minOccurs="0" name="searchByName" type="xs:boolean" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="findEsxServerObjectRequest" nillable="true" type="tns:findEsxServerObjectRequest" />
        <xs:complexType name="esxServerSummaryRequest">
          <xs:sequence>
            <xs:element minOccurs="0" name="agentId" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="credentials" nillable="true" type="tns:baseCredentials" />
            <xs:element minOccurs="0" name="password" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="userName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="vcenterHost" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="vcenterPort" type="xs:int" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="esxServerSummaryRequest" nillable="true" type="tns:esxServerSummaryRequest" />
        <xs:complexType name="baseCredentials">
          <xs:sequence>
            <xs:element minOccurs="0" name="credentialsAccountId" type="ser:guid" />
            <xs:element minOccurs="0" name="encryptPassword" type="xs:boolean" />
            <xs:element minOccurs="0" name="password" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="passwordEncrypted" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="userName" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="baseCredentials" nillable="true" type="tns:baseCredentials" />
        <xs:complexType name="oracleInstanceCredentials">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:baseCredentials">
              <xs:sequence>
                <xs:element minOccurs="0" name="hostName" nillable="true" type="xs:string" />
                <xs:element minOccurs="0" name="instanceServiceName" nillable="true" type="xs:string" />
                <xs:element minOccurs="0" name="instanceSid" nillable="true" type="xs:string" />
                <xs:element minOccurs="0" name="port" type="xs:int" />
                <xs:element minOccurs="0" name="tnsNetworkAlias" nillable="true" type="xs:string" />
                <xs:element minOccurs="0" name="useWindowsAuthentication" type="xs:boolean" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="oracleInstanceCredentials" nillable="true" type="tns:oracleInstanceCredentials" />
        <xs:complexType name="instanceCredentials">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:baseCredentials">
              <xs:sequence>
                <xs:element minOccurs="0" name="instanceName" nillable="true" type="xs:string" />
                <xs:element minOccurs="0" name="useDefaultCredentials" type="xs:boolean" />
                <xs:element minOccurs="0" name="useWindowsAuthentication" type="xs:boolean" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="instanceCredentials" nillable="true" type="tns:instanceCredentials" />
        <xs:complexType name="virtualInstanceCredentials">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:instanceCredentials">
              <xs:sequence>
                <xs:element minOccurs="0" name="virtualServerName" nillable="true" type="xs:string" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="virtualInstanceCredentials" nillable="true" type="tns:virtualInstanceCredentials" />
        <xs:complexType name="stringCollection">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="stringCollection" nillable="true" type="tns:stringCollection" />
      </xs:schema>
    </Schemas>

The following is the response XML Schema:

    <?xml version="1.0" encoding="utf-16"?>
    <Schemas>
      <xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:element name="anyType" nillable="true" type="xs:anyType" />
        <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
        <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
        <xs:element name="boolean" nillable="true" type="xs:boolean" />
        <xs:element name="byte" nillable="true" type="xs:byte" />
        <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
        <xs:element name="decimal" nillable="true" type="xs:decimal" />
        <xs:element name="double" nillable="true" type="xs:double" />
        <xs:element name="float" nillable="true" type="xs:float" />
        <xs:element name="int" nillable="true" type="xs:int" />
        <xs:element name="long" nillable="true" type="xs:long" />
        <xs:element name="QName" nillable="true" type="xs:QName" />
        <xs:element name="short" nillable="true" type="xs:short" />
        <xs:element name="string" nillable="true" type="xs:string" />
        <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
        <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
        <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
        <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
        <xs:element name="char" nillable="true" type="tns:char" />
        <xs:simpleType name="char">
          <xs:restriction base="xs:int" />
        </xs:simpleType>
        <xs:element name="duration" nillable="true" type="tns:duration" />
        <xs:simpleType name="duration">
          <xs:restriction base="xs:duration">
            <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
            <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
            <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="guid" nillable="true" type="tns:guid" />
        <xs:simpleType name="guid">
          <xs:restriction base="xs:string">
            <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
          </xs:restriction>
        </xs:simpleType>
        <xs:attribute name="FactoryType" type="xs:QName" />
        <xs:attribute name="Id" type="xs:ID" />
        <xs:attribute name="Ref" type="xs:IDREF" />
      </xs:schema>
      <xs:schema xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Virtualization.VSphereApi" />
        <xs:import namespace="http://schemas.datacontract.org/2004/07/System" />
        <xs:complexType name="objectBaseSummary">
          <xs:sequence>
            <xs:element minOccurs="0" name="id" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="objectBaseSummary" nillable="true" type="tns:objectBaseSummary" />
        <xs:complexType name="virtualMachineSummary_x0020_">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:objectBaseSummary">
              <xs:sequence>
                <xs:element minOccurs="0" name="allIpAddresses" nillable="true" type="tns:stringCollection" />
                <xs:element minOccurs="0" name="error" nillable="true" type="tns:serverError" />
                <xs:element minOccurs="0" name="hostName" nillable="true" type="xs:string" />
                <xs:element minOccurs="0" name="ip" nillable="true" type="xs:string" />
                <xs:element minOccurs="0" name="isConnected" type="xs:boolean" />
                <xs:element minOccurs="0" name="isConsolidationNeeded" type="xs:boolean" />
                <xs:element minOccurs="0" name="isPaused" type="xs:boolean" />
                <xs:element minOccurs="0" name="isPoweredOn" type="xs:boolean" />
                <xs:element minOccurs="0" name="isVMToolsOk" type="xs:boolean" />
                <xs:element minOccurs="0" name="location" nillable="true" type="tns:virtualMachineLocation_x0020_" />
                <xs:element minOccurs="0" name="size" type="xs:unsignedLong" />
                <xs:element minOccurs="0" name="uuid" nillable="true" type="xs:string" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="virtualMachineSummary_x0020_" nillable="true" type="tns:virtualMachineSummary_x0020_" />
        <xs:complexType name="stringCollection">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="stringCollection" nillable="true" type="tns:stringCollection" />
        <xs:complexType name="serverError">
          <xs:sequence>
            <xs:element minOccurs="0" name="message" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="type" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="detail" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="stackTrace" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="serverException" nillable="true" type="tns:exception" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="serverError" nillable="true" type="tns:serverError" />
        <xs:complexType name="exception">
          <xs:sequence>
            <xs:element minOccurs="0" name="message" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="type" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="detail" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="rawException" nillable="true" type="xs:base64Binary">
              <xs:annotation>
                <xs:appinfo>
                  <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
                </xs:appinfo>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
        <xs:element name="exception" nillable="true" type="tns:exception" />
        <xs:complexType name="virtualMachineLocation_x0020_">
          <xs:sequence>
            <xs:element minOccurs="0" name="Uuid" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="computeResourceId" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="datacenterId" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="datastoreId" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="folderid" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="id" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="port" type="xs:int" />
            <xs:element minOccurs="0" name="resourcePoolId" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="server" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="storageProfileId" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="useVirtualMachineConfigurationFiles" type="xs:boolean" />
            <xs:element minOccurs="0" name="virtualMachineVersion" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="virtualMachineLocation_x0020_" nillable="true" type="tns:virtualMachineLocation_x0020_" />
        <xs:complexType name="esxHostSystemSummary_x0020_">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:objectBaseSummary">
              <xs:sequence>
                <xs:element minOccurs="0" name="connectionState" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Virtualization.VSphereApi" type="q1:EsxHostSystemConnectionState" />
                <xs:element minOccurs="0" name="isSupportedVersion" type="xs:boolean" />
                <xs:element minOccurs="0" name="productVersion" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/System" type="q2:Version" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="esxHostSystemSummary_x0020_" nillable="true" type="tns:esxHostSystemSummary_x0020_" />
      </xs:schema>
      <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Virtualization.VSphereApi" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Virtualization.VSphereApi" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:simpleType name="EsxHostSystemConnectionState">
          <xs:restriction base="xs:string">
            <xs:enumeration value="Unknown" />
            <xs:enumeration value="Connected" />
            <xs:enumeration value="Disconnected" />
            <xs:enumeration value="NotResponding" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="EsxHostSystemConnectionState" nillable="true" type="tns:EsxHostSystemConnectionState" />
      </xs:schema>
      <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/System" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/System" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:complexType name="Version">
          <xs:sequence>
            <xs:element name="_Build" type="xs:int" />
            <xs:element name="_Major" type="xs:int" />
            <xs:element name="_Minor" type="xs:int" />
            <xs:element name="_Revision" type="xs:int" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="Version" nillable="true" type="tns:Version" />
      </xs:schema>
    </Schemas>