Reference for SetAgentReplicationSettings

Url: replication/agents/{agentId}

HTTP Method: PUT

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"?>
<agentReplicationSettings xmlns="http://apprecovery.com/management/api/2010/05">
  <agentRemoteSlaveCoreSettings>
    <agentRemoteSlaveCoreSetting>
      <agentPairingState>Unknown</agentPairingState>
      <displayName>String content</displayName>
      <lastReplicatedRecoveryPointTimestamp>1999-05-31T11:20:00</lastReplicatedRecoveryPointTimestamp>
      <lastSeededRecoveryPointTimestamp>1999-05-31T11:20:00</lastSeededRecoveryPointTimestamp>
      <pauseReplication>true</pauseReplication>
      <remoteSlaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</remoteSlaveCoreId>
    </agentRemoteSlaveCoreSetting>
    <agentRemoteSlaveCoreSetting>
      <agentPairingState>Unknown</agentPairingState>
      <displayName>String content</displayName>
      <lastReplicatedRecoveryPointTimestamp>1999-05-31T11:20:00</lastReplicatedRecoveryPointTimestamp>
      <lastSeededRecoveryPointTimestamp>1999-05-31T11:20:00</lastSeededRecoveryPointTimestamp>
      <pauseReplication>true</pauseReplication>
      <remoteSlaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</remoteSlaveCoreId>
    </agentRemoteSlaveCoreSetting>
  </agentRemoteSlaveCoreSettings>
  <priority>Undefined</priority>
  <remoteCoreSummaryInfo>
    <hostName>String content</hostName>
    <id>1627aea5-8e0a-4371-9022-9b504344e724</id>
    <isReplicationOnlyRepositorySupported_x0020_>true</isReplicationOnlyRepositorySupported_x0020_>
    <version>
      <_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>
    </version>
  </remoteCoreSummaryInfo>
  <replicatedAgentName>String content</replicatedAgentName>
</agentReplicationSettings>

The following is an example response XML body:

No Xml response output for this method.

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.Replication" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Replication.Pairing" />
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/System" />
    <xs:complexType name="agentReplicationSettings">
      <xs:sequence>
        <xs:element minOccurs="0" name="agentRemoteSlaveCoreSettings" nillable="true" type="tns:agentRemoteSlaveCoreSettingsCollection" />
        <xs:element minOccurs="0" name="priority" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Replication" type="q1:AgentReplicationPriority" />
        <xs:element minOccurs="0" name="remoteCoreSummaryInfo" nillable="true" type="tns:remoteMasterSummaryCoreInfo" />
        <xs:element minOccurs="0" name="replicatedAgentName" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agentReplicationSettings" nillable="true" type="tns:agentReplicationSettings" />
    <xs:complexType name="agentRemoteSlaveCoreSettingsCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="agentRemoteSlaveCoreSetting" nillable="true" type="tns:agentRemoteSlaveCoreSetting" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agentRemoteSlaveCoreSettingsCollection" nillable="true" type="tns:agentRemoteSlaveCoreSettingsCollection" />
    <xs:complexType name="agentRemoteSlaveCoreSetting">
      <xs:sequence>
        <xs:element minOccurs="0" name="agentPairingState" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Replication.Pairing" type="q2:ReplicationPairingState" />
        <xs:element minOccurs="0" name="displayName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="lastReplicatedRecoveryPointTimestamp" type="xs:dateTime" />
        <xs:element minOccurs="0" name="lastSeededRecoveryPointTimestamp" type="xs:dateTime" />
        <xs:element minOccurs="0" name="pauseReplication" type="xs:boolean" />
        <xs:element minOccurs="0" name="remoteSlaveCoreId" type="ser:guid" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agentRemoteSlaveCoreSetting" nillable="true" type="tns:agentRemoteSlaveCoreSetting" />
    <xs:complexType name="remoteMasterSummaryCoreInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="hostName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="id" type="ser:guid" />
        <xs:element minOccurs="0" name="isReplicationOnlyRepositorySupported_x0020_" type="xs:boolean" />
        <xs:element minOccurs="0" name="version" nillable="true" xmlns:q3="http://schemas.datacontract.org/2004/07/System" type="q3:Version" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="remoteMasterSummaryCoreInfo" nillable="true" type="tns:remoteMasterSummaryCoreInfo" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Replication.Pairing" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Replication.Pairing" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="ReplicationPairingState">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Unknown" />
        <xs:enumeration value="Pending" />
        <xs:enumeration value="Denied" />
        <xs:enumeration value="Deleted" />
        <xs:enumeration value="Established" />
        <xs:enumeration value="Suspended" />
        <xs:enumeration value="Ignored" />
        <xs:enumeration value="Failover" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="ReplicationPairingState" nillable="true" type="tns:ReplicationPairingState" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Replication" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Replication" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:simpleType name="AgentReplicationPriority">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Undefined" />
        <xs:enumeration value="One" />
        <xs:enumeration value="Two" />
        <xs:enumeration value="Three" />
        <xs:enumeration value="Four" />
        <xs:enumeration value="Five" />
        <xs:enumeration value="Six" />
        <xs:enumeration value="Seven" />
        <xs:enumeration value="Eight" />
        <xs:enumeration value="Nine" />
        <xs:enumeration value="Ten" />
        <xs:enumeration value="Highest">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="Lowest">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">10</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="Default">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="AgentReplicationPriority" nillable="true" type="tns:AgentReplicationPriority" />
  </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>

The following is the response XML Schema:

The response body is empty.