Reference for IsAgentAlreadyProtectedWithAnotherType

Url: agents/isAgentAlreadyProtectedWithAnotherType

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"?>
    <agentDescriptor i:type="relatedServerAgentDescriptor" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://apprecovery.com/management/api/2010/05">
      <agentType>Protected</agentType>
      <credentials>
        <credentialsAccountId>1627aea5-8e0a-4371-9022-9b504344e724</credentialsAccountId>
        <encryptPassword>true</encryptPassword>
        <password>String content</password>
        <passwordEncrypted>String content</passwordEncrypted>
        <userName>String content</userName>
        <useCoreServiceCredentials>true</useCoreServiceCredentials>
      </credentials>
      <displayName>String content</displayName>
      <hostName>String content</hostName>
      <hostUri>http://www.example.com/</hostUri>
      <id>1627aea5-8e0a-4371-9022-9b504344e724</id>
      <machineFlags i:nil="true" />
      <metadataCredentials>
        <!--Valid elements of type: agentCredentials, oracleInstanceCredentials, instanceCredentials, virtualInstanceCredentials-->
        <defaultCredentials i:type="agentCredentials">
          <credentialsAccountId>1627aea5-8e0a-4371-9022-9b504344e724</credentialsAccountId>
          <encryptPassword>true</encryptPassword>
          <password>String content</password>
          <passwordEncrypted>String content</passwordEncrypted>
          <userName>String content</userName>
          <useCoreServiceCredentials>true</useCoreServiceCredentials>
        </defaultCredentials>
        <!--Valid elements of type: agentCredentials, oracleInstanceCredentials, instanceCredentials, virtualInstanceCredentials-->
        <exchangeCredentials i:type="agentCredentials">
          <credentialsAccountId>1627aea5-8e0a-4371-9022-9b504344e724</credentialsAccountId>
          <encryptPassword>true</encryptPassword>
          <password>String content</password>
          <passwordEncrypted>String content</passwordEncrypted>
          <userName>String content</userName>
          <useCoreServiceCredentials>true</useCoreServiceCredentials>
        </exchangeCredentials>
        <oracleCredentials>
          <oracleInstancesCredentials>
            <instanceCredentials>
              <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>
            </instanceCredentials>
            <instanceCredentials>
              <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>
            </instanceCredentials>
          </oracleInstancesCredentials>
        </oracleCredentials>
        <sqlCredentials>
          <instancesCredentials>
            <!--Valid elements of type: virtualInstanceCredentials-->
            <instanceCredentials i:type="virtualInstanceCredentials">
              <credentialsAccountId>1627aea5-8e0a-4371-9022-9b504344e724</credentialsAccountId>
              <encryptPassword>true</encryptPassword>
              <password>String content</password>
              <passwordEncrypted>String content</passwordEncrypted>
              <userName>String content</userName>
              <instanceName>String content</instanceName>
              <useDefaultCredentials>true</useDefaultCredentials>
              <useWindowsAuthentication>true</useWindowsAuthentication>
              <virtualServerName>String content</virtualServerName>
            </instanceCredentials>
            <!--Valid elements of type: virtualInstanceCredentials-->
            <instanceCredentials i:type="virtualInstanceCredentials">
              <credentialsAccountId>1627aea5-8e0a-4371-9022-9b504344e724</credentialsAccountId>
              <encryptPassword>true</encryptPassword>
              <password>String content</password>
              <passwordEncrypted>String content</passwordEncrypted>
              <userName>String content</userName>
              <instanceName>String content</instanceName>
              <useDefaultCredentials>true</useDefaultCredentials>
              <useWindowsAuthentication>true</useWindowsAuthentication>
              <virtualServerName>String content</virtualServerName>
            </instanceCredentials>
          </instancesCredentials>
        </sqlCredentials>
      </metadataCredentials>
      <sshPort>4294967295</sshPort>
      <hyperVHostName>String content</hyperVHostName>
    </agentDescriptor>

The following is an example response XML body:

    <?xml version="1.0" encoding="utf-16"?>
    <boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

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.datacontract.org/2004/07/Replay.Core.Contracts.Agents" />
        <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
        <xs:complexType name="agentDescriptor">
          <xs:sequence>
            <xs:element minOccurs="0" name="agentType" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" type="q1:AgentType" />
            <xs:element minOccurs="0" name="credentials" nillable="true" type="tns:agentCredentials" />
            <xs:element minOccurs="0" name="displayName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="hostName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="hostUri" nillable="true" type="xs:anyURI" />
            <xs:element minOccurs="0" name="id" type="ser:guid" />
            <xs:element minOccurs="0" name="machineFlags" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" type="q2:MachineFlags" />
            <xs:element minOccurs="0" name="metadataCredentials" nillable="true" type="tns:credentialsDescriptor">
              <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="sshPort" type="xs:unsignedInt" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="agentDescriptor" nillable="true" type="tns:agentDescriptor" />
        <xs:complexType name="agentCredentials">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:baseCredentials">
              <xs:sequence>
                <xs:element minOccurs="0" name="useCoreServiceCredentials" type="xs:boolean">
                  <xs:annotation>
                    <xs:appinfo>
                      <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
                    </xs:appinfo>
                  </xs:annotation>
                </xs:element>
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="agentCredentials" nillable="true" type="tns:agentCredentials" />
        <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="credentialsDescriptor">
          <xs:sequence>
            <xs:element minOccurs="0" name="defaultCredentials" nillable="true" type="tns:baseCredentials">
              <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="exchangeCredentials" nillable="true" type="tns:baseCredentials">
              <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="oracleCredentials" nillable="true" type="tns:oracleCredentials">
              <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="sqlCredentials" nillable="true" type="tns:sqlCredentials">
              <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="credentialsDescriptor" nillable="true" type="tns:credentialsDescriptor" />
        <xs:complexType name="oracleCredentials">
          <xs:sequence>
            <xs:element minOccurs="0" name="oracleInstancesCredentials" nillable="true" type="tns:oracleInstancesCredentials" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="oracleCredentials" nillable="true" type="tns:oracleCredentials" />
        <xs:complexType name="oracleInstancesCredentials">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="instanceCredentials" nillable="true" type="tns:oracleInstanceCredentials" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="oracleInstancesCredentials" nillable="true" type="tns:oracleInstancesCredentials" />
        <xs:complexType name="sqlCredentials">
          <xs:sequence>
            <xs:element minOccurs="0" name="instancesCredentials" nillable="true" type="tns:instancesCredentials" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="sqlCredentials" nillable="true" type="tns:sqlCredentials" />
        <xs:complexType name="instancesCredentials">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="instanceCredentials" nillable="true" type="tns:instanceCredentials" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="instancesCredentials" nillable="true" type="tns:instancesCredentials" />
        <xs:complexType name="relatedServerAgentDescriptor">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:agentDescriptor">
              <xs:sequence>
                <xs:element minOccurs="0" name="hyperVHostName" nillable="true" type="xs:string" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="relatedServerAgentDescriptor" nillable="true" type="tns:relatedServerAgentDescriptor" />
      </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:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
        <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:simpleType name="MachineFlags">
          <xs:annotation>
            <xs:appinfo>
              <ActualType Name="long" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
          <xs:list>
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value="None">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="Agent">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="Cluster">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="ClusterNode">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="EsxServer">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="EsxVirtualMachine">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">16</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="HyperVServer">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">32</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="HyperVVirtualMachine">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">64</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="SmbServer">
                  <xs:annotation>
                    <xs:appinfo>
                      <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">128</EnumerationValue>
                    </xs:appinfo>
                  </xs:annotation>
                </xs:enumeration>
              </xs:restriction>
            </xs:simpleType>
          </xs:list>
        </xs:simpleType>
        <xs:element name="MachineFlags" nillable="true" type="tns:MachineFlags" />
      </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>
    </Schemas>