Reference for UpdateProtectedVolumeFiles

Url: hypervTransferDirectToTarget/updateProtectedVolumeFiles/{snapshotSetId}/

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"?>
<volumeProtectionRequest xmlns="http://apprecovery.com/management/api/2010/05">
  <virtualMachineId>1627aea5-8e0a-4371-9022-9b504344e724</virtualMachineId>
  <volumes>
    <volumeName>
      <guidName>String content</guidName>
      <displayName>String content</displayName>
    </volumeName>
    <volumeName>
      <guidName>String content</guidName>
      <displayName>String content</displayName>
    </volumeName>
  </volumes>
</volumeProtectionRequest>

The following is an example response XML body:

<?xml version="1.0" encoding="utf-16"?>
<protectedVolumes xmlns="http://apprecovery.com/management/api/2010/05">
  <protectedVirtualMachineVolume>
    <volumeFiles>
      <protectedFile>
        <clusterRepresentation>
          <ClusterNodeProtectedFile>
            <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
            <nodeProtectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </nodeProtectedFileId>
          </ClusterNodeProtectedFile>
          <ClusterNodeProtectedFile>
            <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
            <nodeProtectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </nodeProtectedFileId>
          </ClusterNodeProtectedFile>
        </clusterRepresentation>
        <fileIdInfo>
          <driverFileId>2147483647</driverFileId>
          <fileIdHighPart>18446744073709551615</fileIdHighPart>
          <fileIdLowPart>18446744073709551615</fileIdLowPart>
          <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
        </fileIdInfo>
        <fileToHostMapping>
          <hyperVServerFileIdInfo>
            <agentId>1627aea5-8e0a-4371-9022-9b504344e724</agentId>
            <protectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </protectedFileId>
          </hyperVServerFileIdInfo>
          <hyperVServerFileIdInfo>
            <agentId>1627aea5-8e0a-4371-9022-9b504344e724</agentId>
            <protectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </protectedFileId>
          </hyperVServerFileIdInfo>
        </fileToHostMapping>
        <isSharedVirtualDisk>true</isSharedVirtualDisk>
        <virtualDiskPath>String content</virtualDiskPath>
      </protectedFile>
      <protectedFile>
        <clusterRepresentation>
          <ClusterNodeProtectedFile>
            <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
            <nodeProtectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </nodeProtectedFileId>
          </ClusterNodeProtectedFile>
          <ClusterNodeProtectedFile>
            <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
            <nodeProtectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </nodeProtectedFileId>
          </ClusterNodeProtectedFile>
        </clusterRepresentation>
        <fileIdInfo>
          <driverFileId>2147483647</driverFileId>
          <fileIdHighPart>18446744073709551615</fileIdHighPart>
          <fileIdLowPart>18446744073709551615</fileIdLowPart>
          <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
        </fileIdInfo>
        <fileToHostMapping>
          <hyperVServerFileIdInfo>
            <agentId>1627aea5-8e0a-4371-9022-9b504344e724</agentId>
            <protectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </protectedFileId>
          </hyperVServerFileIdInfo>
          <hyperVServerFileIdInfo>
            <agentId>1627aea5-8e0a-4371-9022-9b504344e724</agentId>
            <protectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </protectedFileId>
          </hyperVServerFileIdInfo>
        </fileToHostMapping>
        <isSharedVirtualDisk>true</isSharedVirtualDisk>
        <virtualDiskPath>String content</virtualDiskPath>
      </protectedFile>
    </volumeFiles>
    <volumeGuidName>String content</volumeGuidName>
  </protectedVirtualMachineVolume>
  <protectedVirtualMachineVolume>
    <volumeFiles>
      <protectedFile>
        <clusterRepresentation>
          <ClusterNodeProtectedFile>
            <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
            <nodeProtectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </nodeProtectedFileId>
          </ClusterNodeProtectedFile>
          <ClusterNodeProtectedFile>
            <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
            <nodeProtectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </nodeProtectedFileId>
          </ClusterNodeProtectedFile>
        </clusterRepresentation>
        <fileIdInfo>
          <driverFileId>2147483647</driverFileId>
          <fileIdHighPart>18446744073709551615</fileIdHighPart>
          <fileIdLowPart>18446744073709551615</fileIdLowPart>
          <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
        </fileIdInfo>
        <fileToHostMapping>
          <hyperVServerFileIdInfo>
            <agentId>1627aea5-8e0a-4371-9022-9b504344e724</agentId>
            <protectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </protectedFileId>
          </hyperVServerFileIdInfo>
          <hyperVServerFileIdInfo>
            <agentId>1627aea5-8e0a-4371-9022-9b504344e724</agentId>
            <protectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </protectedFileId>
          </hyperVServerFileIdInfo>
        </fileToHostMapping>
        <isSharedVirtualDisk>true</isSharedVirtualDisk>
        <virtualDiskPath>String content</virtualDiskPath>
      </protectedFile>
      <protectedFile>
        <clusterRepresentation>
          <ClusterNodeProtectedFile>
            <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
            <nodeProtectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </nodeProtectedFileId>
          </ClusterNodeProtectedFile>
          <ClusterNodeProtectedFile>
            <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
            <nodeProtectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </nodeProtectedFileId>
          </ClusterNodeProtectedFile>
        </clusterRepresentation>
        <fileIdInfo>
          <driverFileId>2147483647</driverFileId>
          <fileIdHighPart>18446744073709551615</fileIdHighPart>
          <fileIdLowPart>18446744073709551615</fileIdLowPart>
          <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
        </fileIdInfo>
        <fileToHostMapping>
          <hyperVServerFileIdInfo>
            <agentId>1627aea5-8e0a-4371-9022-9b504344e724</agentId>
            <protectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </protectedFileId>
          </hyperVServerFileIdInfo>
          <hyperVServerFileIdInfo>
            <agentId>1627aea5-8e0a-4371-9022-9b504344e724</agentId>
            <protectedFileId>
              <driverFileId>2147483647</driverFileId>
              <fileIdHighPart>18446744073709551615</fileIdHighPart>
              <fileIdLowPart>18446744073709551615</fileIdLowPart>
              <volumeSerialNumber>18446744073709551615</volumeSerialNumber>
            </protectedFileId>
          </hyperVServerFileIdInfo>
        </fileToHostMapping>
        <isSharedVirtualDisk>true</isSharedVirtualDisk>
        <virtualDiskPath>String content</virtualDiskPath>
      </protectedFile>
    </volumeFiles>
    <volumeGuidName>String content</volumeGuidName>
  </protectedVirtualMachineVolume>
</protectedVolumes>

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:complexType name="volumeProtectionRequest">
      <xs:sequence>
        <xs:element minOccurs="0" name="virtualMachineId" type="ser:guid" />
        <xs:element minOccurs="0" name="volumes" nillable="true" type="tns:volumeNames" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="volumeProtectionRequest" nillable="true" type="tns:volumeProtectionRequest" />
    <xs:complexType name="volumeNames">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="volumeName" nillable="true" type="tns:volumeName" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="volumeNames" nillable="true" type="tns:volumeNames" />
    <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>
</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>
  <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:complexType name="protectedVolumes">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="protectedVirtualMachineVolume" nillable="true" type="tns:protectedVirtualMachineVolume" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectedVolumes" nillable="true" type="tns:protectedVolumes" />
    <xs:complexType name="protectedVirtualMachineVolume">
      <xs:sequence>
        <xs:element minOccurs="0" name="volumeFiles" nillable="true" type="tns:volumeFiles" />
        <xs:element minOccurs="0" name="volumeGuidName" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectedVirtualMachineVolume" nillable="true" type="tns:protectedVirtualMachineVolume" />
    <xs:complexType name="volumeFiles">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="protectedFile" nillable="true" type="tns:protectedFile" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="volumeFiles" nillable="true" type="tns:volumeFiles" />
    <xs:complexType name="protectedFile">
      <xs:sequence>
        <xs:element minOccurs="0" name="clusterRepresentation" nillable="true" type="tns:clusterNodesProtectedFileCollection" />
        <xs:element minOccurs="0" name="fileIdInfo" nillable="true" type="tns:FileIdInfo" />
        <xs:element minOccurs="0" name="fileToHostMapping" nillable="true" type="tns:hyperVServerFileIdInfoCollection" />
        <xs:element minOccurs="0" name="isSharedVirtualDisk" type="xs:boolean" />
        <xs:element minOccurs="0" name="virtualDiskPath" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectedFile" nillable="true" type="tns:protectedFile" />
    <xs:complexType name="clusterNodesProtectedFileCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="ClusterNodeProtectedFile" nillable="true" type="tns:protectedFilesClusterNodesRepresentation" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="clusterNodesProtectedFileCollection" nillable="true" type="tns:clusterNodesProtectedFileCollection" />
    <xs:complexType name="protectedFilesClusterNodesRepresentation">
      <xs:sequence>
        <xs:element minOccurs="0" name="nodeId" type="ser:guid" />
        <xs:element minOccurs="0" name="nodeProtectedFileId" nillable="true" type="tns:FileIdInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectedFilesClusterNodesRepresentation" nillable="true" type="tns:protectedFilesClusterNodesRepresentation" />
    <xs:complexType name="FileIdInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="driverFileId" type="xs:int" />
        <xs:element minOccurs="0" name="fileIdHighPart" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="fileIdLowPart" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="volumeSerialNumber" type="xs:unsignedLong" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="FileIdInfo" nillable="true" type="tns:FileIdInfo" />
    <xs:complexType name="hyperVServerFileIdInfoCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="hyperVServerFileIdInfo" nillable="true" type="tns:hyperVServerFileIdInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="hyperVServerFileIdInfoCollection" nillable="true" type="tns:hyperVServerFileIdInfoCollection" />
    <xs:complexType name="hyperVServerFileIdInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="agentId" type="ser:guid" />
        <xs:element minOccurs="0" name="protectedFileId" nillable="true" type="tns:FileIdInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="hyperVServerFileIdInfo" nillable="true" type="tns:hyperVServerFileIdInfo" />
  </xs:schema>
</Schemas>