Reference for GetInfoForAgentType

Url: dashboard/agentinfo

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"?>
<AgentType xmlns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents">Protected</AgentType>

The following is an example response XML body:

<?xml version="1.0" encoding="utf-16"?>
<dashboardAgentInfoCollection xmlns="http://apprecovery.com/management/api/2010/05">
  <dashboardAgentInfo>
    <agentName>String content</agentName>
    <agentStatus>Online</agentStatus>
    <agentVersion>
      <_Build xmlns="http://schemas.datacontract.org/2004/07/System">2147483647</_Build>
      <_Major xmlns="http://schemas.datacontract.org/2004/07/System">2147483647</_Major>
      <_Minor xmlns="http://schemas.datacontract.org/2004/07/System">2147483647</_Minor>
      <_Revision xmlns="http://schemas.datacontract.org/2004/07/System">2147483647</_Revision>
    </agentVersion>
    <coreName>String content</coreName>
    <nextSnapshotTime>1999-05-31T11:20:00</nextSnapshotTime>
    <repositoryName>String content</repositoryName>
  </dashboardAgentInfo>
  <dashboardAgentInfo>
    <agentName>String content</agentName>
    <agentStatus>Online</agentStatus>
    <agentVersion>
      <_Build xmlns="http://schemas.datacontract.org/2004/07/System">2147483647</_Build>
      <_Major xmlns="http://schemas.datacontract.org/2004/07/System">2147483647</_Major>
      <_Minor xmlns="http://schemas.datacontract.org/2004/07/System">2147483647</_Minor>
      <_Revision xmlns="http://schemas.datacontract.org/2004/07/System">2147483647</_Revision>
    </agentVersion>
    <coreName>String content</coreName>
    <nextSnapshotTime>1999-05-31T11:20:00</nextSnapshotTime>
    <repositoryName>String content</repositoryName>
  </dashboardAgentInfo>
</dashboardAgentInfoCollection>

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:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="AgentType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Protected" />
        <xs:enumeration value="Replicated" />
        <xs:enumeration value="PendingFailover" />
        <xs:enumeration value="Failover" />
        <xs:enumeration value="ClusterNode" />
        <xs:enumeration value="Cluster" />
        <xs:enumeration value="RecoveryPointsOnly" />
        <xs:enumeration value="EsxServer" />
        <xs:enumeration value="EsxVirtualMachine" />
        <xs:enumeration value="Backup" />
        <xs:enumeration value="Unknown" />
        <xs:enumeration value="HyperVServer" />
        <xs:enumeration value="HyperVVirtualMachine" />
        <xs:enumeration value="HyperVCluster" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="AgentType" nillable="true" type="tns:AgentType" />
  </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.Core.Contracts.Agents" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/System" />
    <xs:complexType name="dashboardAgentInfoCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="dashboardAgentInfo" nillable="true" type="tns:dashboardAgentInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="dashboardAgentInfoCollection" nillable="true" type="tns:dashboardAgentInfoCollection" />
    <xs:complexType name="dashboardAgentInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="agentName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="agentStatus" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" type="q1:AgentStatus" />
        <xs:element minOccurs="0" name="agentVersion" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/System" type="q2:Version" />
        <xs:element minOccurs="0" name="coreName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="nextSnapshotTime" type="xs:dateTime">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="repositoryName" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="dashboardAgentInfo" nillable="true" type="tns:dashboardAgentInfo" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="AgentStatus">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Online" />
        <xs:enumeration value="PendingFailover" />
        <xs:enumeration value="Unreachable" />
        <xs:enumeration value="AuthenticationError" />
        <xs:enumeration value="Failed" />
        <xs:enumeration value="Loading" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="AgentStatus" nillable="true" type="tns:AgentStatus" />
  </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>