Reference for GetClusterNodesRequiredForProtect

Url: hyperv/{hyperVClusterAgentId}/clusterNodesRequiredForProtect

HTTP Method: GET

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

The following is an example request XML body:

No Xml request body for this method. False

The following is an example response XML body:

<?xml version="1.0" encoding="utf-16"?>
<clusterNodes xmlns="http://apprecovery.com/management/api/2010/05">
  <clusterNode>
    <Name>String content</Name>
    <Version>None</Version>
    <BuildNumber>4294967295</BuildNumber>
    <InstanceId>String content</InstanceId>
    <State>Up</State>
    <CSDVersion>String content</CSDVersion>
    <FQDN>String content</FQDN>
    <IPAddresses>
      <ipAddress>
        <addressFamily>String content</addressFamily>
        <address>String content</address>
      </ipAddress>
      <ipAddress>
        <addressFamily>String content</addressFamily>
        <address>String content</address>
      </ipAddress>
    </IPAddresses>
    <AccessibleAddress>String content</AccessibleAddress>
    <AgentServiceState>Unknown</AgentServiceState>
    <IsAgentUsingNonDefaultPort>true</IsAgentUsingNonDefaultPort>
  </clusterNode>
  <clusterNode>
    <Name>String content</Name>
    <Version>None</Version>
    <BuildNumber>4294967295</BuildNumber>
    <InstanceId>String content</InstanceId>
    <State>Up</State>
    <CSDVersion>String content</CSDVersion>
    <FQDN>String content</FQDN>
    <IPAddresses>
      <ipAddress>
        <addressFamily>String content</addressFamily>
        <address>String content</address>
      </ipAddress>
      <ipAddress>
        <addressFamily>String content</addressFamily>
        <address>String content</address>
      </ipAddress>
    </IPAddresses>
    <AccessibleAddress>String content</AccessibleAddress>
    <AgentServiceState>Unknown</AgentServiceState>
    <IsAgentUsingNonDefaultPort>true</IsAgentUsingNonDefaultPort>
  </clusterNode>
</clusterNodes>

The following is the request XML Schema:

The request body is empty.

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.Metadata.Cluster" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.WmiApi.Services" />
    <xs:complexType name="clusterNodes">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="clusterNode" nillable="true" type="tns:clusterNode" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="clusterNodes" nillable="true" type="tns:clusterNodes" />
    <xs:complexType name="clusterNode">
      <xs:sequence>
        <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Version" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Cluster" type="q1:WindowsVersion" />
        <xs:element minOccurs="0" name="BuildNumber" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="InstanceId" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="State" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Cluster" type="q2:ClusterNodeState" />
        <xs:element minOccurs="0" name="CSDVersion" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FQDN" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="IPAddresses" nillable="true" type="tns:ipAddresses" />
        <xs:element minOccurs="0" name="AccessibleAddress" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AgentServiceState" xmlns:q3="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.WmiApi.Services" type="q3:State" />
        <xs:element minOccurs="0" name="IsAgentUsingNonDefaultPort" type="xs:boolean" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="clusterNode" nillable="true" type="tns:clusterNode" />
    <xs:complexType name="ipAddresses">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="ipAddress" nillable="true" type="tns:ipAddress" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="ipAddresses" nillable="true" type="tns:ipAddresses" />
    <xs:complexType name="ipAddress">
      <xs:sequence>
        <xs:element minOccurs="0" name="addressFamily" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="address" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="ipAddress" nillable="true" type="tns:ipAddress" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Cluster" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Cluster" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:simpleType name="WindowsVersion">
      <xs:restriction base="xs:string">
        <xs:enumeration value="None" />
        <xs:enumeration value="WindowsServer2000">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">50</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="Windows2003">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">52</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="Windows2008">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">60</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="Windows2008R2">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">61</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="WindowsServer8">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">62</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="WindowsServer8R2">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">63</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="WindowsServer16">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">100</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="WindowsServer2019">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">101</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="WindowsVersion" nillable="true" type="tns:WindowsVersion" />
    <xs:simpleType name="ClusterNodeState">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Up" />
        <xs:enumeration value="Down" />
        <xs:enumeration value="Paused" />
        <xs:enumeration value="Joining" />
        <xs:enumeration value="Unknown">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="ClusterNodeState" nillable="true" type="tns:ClusterNodeState" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.WmiApi.Services" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.WmiApi.Services" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="State">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Unknown" />
        <xs:enumeration value="Stopped" />
        <xs:enumeration value="StartPending" />
        <xs:enumeration value="StopPending" />
        <xs:enumeration value="Running" />
        <xs:enumeration value="ContinuePending" />
        <xs:enumeration value="PausePending" />
        <xs:enumeration value="Paused" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="State" nillable="true" type="tns:State" />
  </xs:schema>
</Schemas>