Reference for GetAgentEsxServerProtectionSettings

Url: vsphere/{esxServerAgentId}/agentEsxServerProtectionSettings

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"?>
    <agentEsxServerProtectionSettings xmlns="http://apprecovery.com/management/api/2010/05">
      <autoProtectedObjects>
        <esxAutoProtectedObject>
          <id>String content</id>
          <ignoredVirtualMachines>
            <string>String content</string>
            <string>String content</string>
          </ignoredVirtualMachines>
          <path>String content</path>
        </esxAutoProtectedObject>
        <esxAutoProtectedObject>
          <id>String content</id>
          <ignoredVirtualMachines>
            <string>String content</string>
            <string>String content</string>
          </ignoredVirtualMachines>
          <path>String content</path>
        </esxAutoProtectedObject>
      </autoProtectedObjects>
      <autoProtectedPauseConfiguration>
        <pauseInterval>P428DT10H30M12.3S</pauseInterval>
        <pauseType>None</pauseType>
        <pausedTimestamp>1999-05-31T11:20:00</pausedTimestamp>
        <pausedUntilUpgrade>true</pausedUntilUpgrade>
      </autoProtectedPauseConfiguration>
      <autoProtectedTransferScheduleConfiguration>
        <friday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </friday>
        <monday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </monday>
        <saturday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </saturday>
        <sunday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </sunday>
        <thursday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </thursday>
        <tuesday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </tuesday>
        <wednesday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </wednesday>
      </autoProtectedTransferScheduleConfiguration>
      <isVirtualCenter>true</isVirtualCenter>
      <managementServerAddress>String content</managementServerAddress>
      <maxConcurrentStreams>4294967295</maxConcurrentStreams>
      <preferredTransport>String content</preferredTransport>
      <preferredTransportForMetadata>String content</preferredTransportForMetadata>
      <protectionRules>
        <protectAgentlessly>true</protectAgentlessly>
        <protectOrphaned>true</protectOrphaned>
        <protectWithRecoveryPoints>true</protectWithRecoveryPoints>
        <deleteOldSnapshots>true</deleteOldSnapshots>
        <protectPairedToAnotherCore>true</protectPairedToAnotherCore>
      </protectionRules>
    </agentEsxServerProtectionSettings>

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: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.Core.Contracts.Transfer" />
        <xs:complexType name="agentEsxServerProtectionSettings">
          <xs:sequence>
            <xs:element minOccurs="0" name="autoProtectedObjects" nillable="true" type="tns:esxAutoProtectedObjects" />
            <xs:element minOccurs="0" name="autoProtectedPauseConfiguration" nillable="true" type="tns:protectionPauseConfiguration" />
            <xs:element minOccurs="0" name="autoProtectedTransferScheduleConfiguration" nillable="true" type="tns:transferScheduleConfiguration" />
            <xs:element minOccurs="0" name="isVirtualCenter" type="xs:boolean" />
            <xs:element minOccurs="0" name="managementServerAddress" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="maxConcurrentStreams" type="xs:unsignedInt" />
            <xs:element minOccurs="0" name="preferredTransport" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="preferredTransportForMetadata" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="protectionRules" nillable="true" type="tns:esxProtectionRules" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="agentEsxServerProtectionSettings" nillable="true" type="tns:agentEsxServerProtectionSettings" />
        <xs:complexType name="esxAutoProtectedObjects">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="esxAutoProtectedObject" nillable="true" type="tns:esxAutoProtectedObject" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="esxAutoProtectedObjects" nillable="true" type="tns:esxAutoProtectedObjects" />
        <xs:complexType name="esxAutoProtectedObject">
          <xs:sequence>
            <xs:element minOccurs="0" name="id" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="ignoredVirtualMachines" nillable="true" type="tns:stringCollection" />
            <xs:element minOccurs="0" name="path" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="esxAutoProtectedObject" nillable="true" type="tns:esxAutoProtectedObject" />
        <xs:complexType name="stringCollection">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="stringCollection" nillable="true" type="tns:stringCollection" />
        <xs:complexType name="protectionPauseConfiguration">
          <xs:sequence>
            <xs:element minOccurs="0" name="pauseInterval" type="ser:duration" />
            <xs:element minOccurs="0" name="pauseType" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Transfer" type="q1:ProtectionPauseType" />
            <xs:element minOccurs="0" name="pausedTimestamp" type="xs:dateTime" />
            <xs:element minOccurs="0" name="pausedUntilUpgrade" type="xs:boolean" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="protectionPauseConfiguration" nillable="true" type="tns:protectionPauseConfiguration" />
        <xs:complexType name="transferScheduleConfiguration">
          <xs:sequence>
            <xs:element minOccurs="0" name="friday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="monday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="saturday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="sunday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="thursday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="tuesday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="wednesday" nillable="true" type="tns:transfersAgenda" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="transferScheduleConfiguration" nillable="true" type="tns:transferScheduleConfiguration" />
        <xs:complexType name="transfersAgenda">
          <xs:sequence>
            <xs:element minOccurs="0" name="transferScheduleItemsCollection" nillable="true" type="tns:transferScheduleItemsCollection" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="transfersAgenda" nillable="true" type="tns:transfersAgenda" />
        <xs:complexType name="transferScheduleItemsCollection">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="transferScheduleItem" nillable="true" type="tns:transferScheduleItem" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="transferScheduleItemsCollection" nillable="true" type="tns:transferScheduleItemsCollection" />
        <xs:complexType name="transferScheduleItem">
          <xs:sequence />
        </xs:complexType>
        <xs:element name="transferScheduleItem" nillable="true" type="tns:transferScheduleItem" />
        <xs:complexType name="intervalTransferScheduleItem">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:transferScheduleItem">
              <xs:sequence>
                <xs:element minOccurs="0" name="endTime" type="ser:duration" />
                <xs:element minOccurs="0" name="priority" type="xs:int" />
                <xs:element minOccurs="0" name="startTime" type="ser:duration" />
                <xs:element minOccurs="0" name="step" type="ser:duration" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="intervalTransferScheduleItem" nillable="true" type="tns:intervalTransferScheduleItem" />
        <xs:complexType name="esxProtectionRules">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:protectionRules">
              <xs:sequence>
                <xs:element minOccurs="0" name="deleteOldSnapshots" type="xs:boolean" />
                <xs:element minOccurs="0" name="protectPairedToAnotherCore" type="xs:boolean" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="esxProtectionRules" nillable="true" type="tns:esxProtectionRules" />
        <xs:complexType name="protectionRules">
          <xs:sequence>
            <xs:element minOccurs="0" name="protectAgentlessly" type="xs:boolean" />
            <xs:element minOccurs="0" name="protectOrphaned" type="xs:boolean" />
            <xs:element minOccurs="0" name="protectWithRecoveryPoints" type="xs:boolean" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="protectionRules" nillable="true" type="tns:protectionRules" />
        <xs:complexType name="hyperVProtectionRules">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:protectionRules">
              <xs:sequence>
                <xs:element minOccurs="0" name="installAgent" type="xs:boolean" />
                <xs:element minOccurs="0" name="protectShareowner" type="xs:boolean" />
                <xs:element minOccurs="0" name="protectWithoutUnsupportedDisk" type="xs:boolean" />
                <xs:element minOccurs="0" name="upgradeAgent" type="xs:boolean" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="hyperVProtectionRules" nillable="true" type="tns:hyperVProtectionRules" />
      </xs:schema>
      <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Transfer" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Transfer" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:simpleType name="ProtectionPauseType">
          <xs:restriction base="xs:string">
            <xs:enumeration value="None" />
            <xs:enumeration value="PauseUntilResumed" />
            <xs:enumeration value="PauseUntilTime" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="ProtectionPauseType" nillable="true" type="tns:ProtectionPauseType" />
      </xs:schema>
    </Schemas>