Reference for SetAgentConfiguration

Url: xfer/schedule/{agentId}/config

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"?>
<xferConfig xmlns="http://apprecovery.com/management/api/2010/05">
  <cleanSnapshotTimeout>P428DT10H30M12.3S</cleanSnapshotTimeout>
  <clientSideDeduplication>true</clientSideDeduplication>
  <combineRequests>true</combineRequests>
  <enableCloudTransfer>true</enableCloudTransfer>
  <enableDirectToTargetTransfer>true</enableDirectToTargetTransfer>
  <enableVerification>true</enableVerification>
  <excludedFilesSettings>
    <useDefaultSettings>true</useDefaultSettings>
    <isExcludeDeletedBlocks>true</isExcludeDeletedBlocks>
    <isExcludeSwapFiles>true</isExcludeSwapFiles>
    <isExcludeSubdirectories>true</isExcludeSubdirectories>
    <excludedFilesAndFolders>
      <excludedFileAndFolder>
        <excludedFileAndFolderPath>String content</excludedFileAndFolderPath>
        <volumeName>
          <guidName>String content</guidName>
          <displayName>String content</displayName>
        </volumeName>
      </excludedFileAndFolder>
      <excludedFileAndFolder>
        <excludedFileAndFolderPath>String content</excludedFileAndFolderPath>
        <volumeName>
          <guidName>String content</guidName>
          <displayName>String content</displayName>
        </volumeName>
      </excludedFileAndFolder>
    </excludedFilesAndFolders>
  </excludedFilesSettings>
  <excludedWriterIds>
    <ExcludedWriter xmlns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Transfer">
      <_x003C_Id_x003E_k__BackingField>1627aea5-8e0a-4371-9022-9b504344e724</_x003C_Id_x003E_k__BackingField>
      <_x003C_Name_x003E_k__BackingField>String content</_x003C_Name_x003E_k__BackingField>
    </ExcludedWriter>
    <ExcludedWriter xmlns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Transfer">
      <_x003C_Id_x003E_k__BackingField>1627aea5-8e0a-4371-9022-9b504344e724</_x003C_Id_x003E_k__BackingField>
      <_x003C_Name_x003E_k__BackingField>String content</_x003C_Name_x003E_k__BackingField>
    </ExcludedWriter>
  </excludedWriterIds>
  <getChangedBlocksRetries>4294967295</getChangedBlocksRetries>
  <getChangedBlocksRetryInterval>P428DT10H30M12.3S</getChangedBlocksRetryInterval>
  <initialQueueSize>4294967295</initialQueueSize>
  <isTransferEncrypted>true</isTransferEncrypted>
  <maxChangeLogsSizePercents>4294967295</maxChangeLogsSizePercents>
  <maxConcurrentDirectToTargetWrites>4294967295</maxConcurrentDirectToTargetWrites>
  <maxConcurrentStreams>4294967295</maxConcurrentStreams>
  <maxConcurrentWrites>4294967295</maxConcurrentWrites>
  <maxRetries>2147483647</maxRetries>
  <maxSegmentSize>18446744073709551615</maxSegmentSize>
  <maxTransferQueueDepth>4294967295</maxTransferQueueDepth>
  <minVolumeFreeSpacePercents>4294967295</minVolumeFreeSpacePercents>
  <priority>Undefined</priority>
  <providerId>1627aea5-8e0a-4371-9022-9b504344e724</providerId>
  <readTimeout>P428DT10H30M12.3S</readTimeout>
  <snapshotTimeout>P428DT10H30M12.3S</snapshotTimeout>
  <transferDataReaderPort>65535</transferDataReaderPort>
  <transferTimeout>P428DT10H30M12.3S</transferTimeout>
  <useDefaultMaxRetries>true</useDefaultMaxRetries>
  <writeTimeout>P428DT10H30M12.3S</writeTimeout>
</xferConfig>

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.microsoft.com/2003/10/Serialization/" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Transfer" />
    <xs:complexType name="xferConfig">
      <xs:sequence>
        <xs:element minOccurs="0" name="cleanSnapshotTimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="clientSideDeduplication" nillable="true" type="xs:boolean" />
        <xs:element minOccurs="0" name="combineRequests" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableCloudTransfer" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableDirectToTargetTransfer" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableVerification" type="xs:boolean" />
        <xs:element minOccurs="0" name="excludedFilesSettings" nillable="true" type="tns:excludedFilesSettings" />
        <xs:element minOccurs="0" name="excludedWriterIds" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Transfer" type="q1:ArrayOfExcludedWriter" />
        <xs:element minOccurs="0" name="getChangedBlocksRetries" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="getChangedBlocksRetryInterval" type="ser:duration" />
        <xs:element minOccurs="0" name="initialQueueSize" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="isTransferEncrypted" type="xs:boolean" />
        <xs:element minOccurs="0" name="maxChangeLogsSizePercents" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="maxConcurrentDirectToTargetWrites" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="maxConcurrentStreams" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="maxConcurrentWrites" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="maxRetries" type="xs:int" />
        <xs:element minOccurs="0" name="maxSegmentSize" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="maxTransferQueueDepth" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="minVolumeFreeSpacePercents" type="xs:unsignedInt" />
        <xs:element minOccurs="0" name="priority" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Transfer" type="q2:Priority" />
        <xs:element minOccurs="0" name="providerId" type="ser:guid" />
        <xs:element minOccurs="0" name="readTimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="snapshotTimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="transferDataReaderPort" type="xs:unsignedShort" />
        <xs:element minOccurs="0" name="transferTimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="useDefaultMaxRetries" type="xs:boolean" />
        <xs:element minOccurs="0" name="writeTimeout" type="ser:duration" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="xferConfig" nillable="true" type="tns:xferConfig" />
    <xs:complexType name="excludedFilesSettings">
      <xs:sequence>
        <xs:element minOccurs="0" name="useDefaultSettings" type="xs:boolean" />
        <xs:element minOccurs="0" name="isExcludeDeletedBlocks" type="xs:boolean" />
        <xs:element minOccurs="0" name="isExcludeSwapFiles" type="xs:boolean" />
        <xs:element minOccurs="0" name="isExcludeSubdirectories" type="xs:boolean" />
        <xs:element minOccurs="0" name="excludedFilesAndFolders" nillable="true" type="tns:excludedFileAndFolderCollection" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="excludedFilesSettings" nillable="true" type="tns:excludedFilesSettings" />
    <xs:complexType name="excludedFileAndFolderCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="excludedFileAndFolder" nillable="true" type="tns:excludedFileAndFolder" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="excludedFileAndFolderCollection" nillable="true" type="tns:excludedFileAndFolderCollection" />
    <xs:complexType name="excludedFileAndFolder">
      <xs:sequence>
        <xs:element minOccurs="0" name="excludedFileAndFolderPath" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="volumeName" nillable="true" type="tns:volumeName" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="excludedFileAndFolder" nillable="true" type="tns:excludedFileAndFolder" />
    <xs:complexType name="volumeName">
      <xs:sequence>
        <xs:element minOccurs="0" name="guidName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="displayName" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="volumeName" nillable="true" type="tns:volumeName" />
  </xs:schema>
  <xs:schema xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Transfer" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Transfer" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:complexType name="ArrayOfExcludedWriter">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="ExcludedWriter" type="tns:ExcludedWriter" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="ArrayOfExcludedWriter" nillable="true" type="tns:ArrayOfExcludedWriter" />
    <xs:complexType name="ExcludedWriter">
      <xs:annotation>
        <xs:appinfo>
          <IsValueType xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</IsValueType>
        </xs:appinfo>
      </xs:annotation>
      <xs:sequence>
        <xs:element name="_x003C_Id_x003E_k__BackingField" type="ser:guid" />
        <xs:element name="_x003C_Name_x003E_k__BackingField" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="ExcludedWriter" nillable="true" type="tns:ExcludedWriter" />
    <xs:simpleType name="Priority">
      <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="Priority" nillable="true" type="tns:Priority" />
  </xs:schema>
</Schemas>

The following is the response XML Schema:

The response body is empty.