XML Request and Response Formats : VPG Settings API XML Request and Response Formats : POST Method Request and Response Formats
  
POST Method Request and Response Formats
Request Body Formats
The following is an example request XML body for https://zvm_ip:port/v1/vpgSettings.
<VpgSettingsApi xmlns="http://schemas.zerto.com/zvm/api">
    <Backup>
      <RepositoryIdentifier>String content</RepositoryIdentifier>
      <RetentionPeriod>String content</RetentionPeriod>
      <Retry>
        <IntervalInMinutes>2147483647</IntervalInMinutes>
        <Number>2147483647</Number>
        <Retry>true</Retry>
      </Retry>
      <Scheduler>
        <DayOfWeek>String content</DayOfWeek>
        <SchedulerPeriod>String content</SchedulerPeriod>
        <TimeOfDay>String content</TimeOfDay>
      </Scheduler>
    </Backup>
    <Basic>
      <JournalHistoryInHours>2147483647</JournalHistoryInHours>
      <Name>String content</Name>
      <Priority>String content</Priority>
      <ProtectedSiteIdentifier>String content</ProtectedSiteIdentifier>
      <RecoverySiteIdentifier>String content</RecoverySiteIdentifier>
      <RpoInSeconds>4294967295</RpoInSeconds>
      <ServiceProfileIdentifier>String content</ServiceProfileIdentifier>
      <TestIntervalInMinutes>2147483647</TestIntervalInMinutes>
      <UseWanCompression>true</UseWanCompression>
      <ZorgIdentifier>String content</ZorgIdentifier>
    </Basic>
    <BootGroups>
      <BootGroups>
        <VpgSettingsBootGroupApi>
          <BootDelayInSeconds>4294967295</BootDelayInSeconds>
          <BootGroupIdentifier>String content</BootGroupIdentifier>
          <Name>String content</Name>
        </VpgSettingsBootGroupApi>
        <VpgSettingsBootGroupApi>
            …
        </VpgSettingsBootGroupApi>
      </BootGroups>
    </BootGroups>
    <Journal>
      <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <Limitation>
        <HardLimitInMB>2147483647</HardLimitInMB>
        <HardLimitInPercent>2147483647</HardLimitInPercent>
        <WarningThresholdInMB>2147483647</WarningThresholdInMB>
        <WarningThresholdInPercent>2147483647</WarningThresholdInPercent>
      </Limitation>
    </Journal>
    <Networks>
      <Failover>
        <Hypervisor>
          <DefaultNetworkIdentifier>String content</DefaultNetworkIdentifier>
        </Hypervisor>
      </Failover>
      <FailoverTest>
        <Hypervisor>
          <DefaultNetworkIdentifier>String content</DefaultNetworkIdentifier>
        </Hypervisor>
      </FailoverTest>
    </Networks>
    <Recovery>
      <DefaultDatastoreClusterIdentifier>String content</DefaultDatastoreClusterIdentifier>
      <DefaultDatastoreIdentifier>String content</DefaultDatastoreIdentifier>
      <DefaultFolderIdentifier>String content</DefaultFolderIdentifier>
      <DefaultHostClusterIdentifier>String content</DefaultHostClusterIdentifier>
      <DefaultHostIdentifier>String content</DefaultHostIdentifier>
      <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
    </Recovery>
    <Scripting>
      <PostBackup>
        <Command>String content</Command>
        <Parameters>String content</Parameters>
        <TimeoutInSeconds>2147483647</TimeoutInSeconds>
      </PostBackup>
      <PostRecovery>
        <Command>String content</Command>
        <Parameters>String content</Parameters>
        <TimeoutInSeconds>2147483647</TimeoutInSeconds>
      </PostRecovery>
      <PreRecovery>
        <Command>String content</Command>
        <Parameters>String content</Parameters>
        <TimeoutInSeconds>2147483647</TimeoutInSeconds>
      </PreRecovery>
    </Scripting>
    <Vms>
      <VpgSettingsVmApi>
        <BootGroupIdentifier>String content</BootGroupIdentifier>
        <Journal>
          <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
          <DatastoreIdentifier>String content</DatastoreIdentifier>
          <Limitation>
            <HardLimitInMB>4294967295</HardLimitInMB>
            <HardLimitInPercent>4294967295</HardLimitInPercent>
            <WarningThresholdInMB>4294967295</WarningThresholdInMB>
            <WarningThresholdInPercent>4294967295</WarningThresholdInPercent>
          </Limitation>
        </Journal>
        <Nics>
          <VpgSettingsVmNicApi>
            <Failover>
              <Hypervisor>
                <DnsSuffix>String content</DnsSuffix>
                <IpConfig>
                  <Gateway>String content</Gateway>
                  <IsDhcp>true</IsDhcp>
                  <PrimaryDns>String content</PrimaryDns>
                  <SecondaryDns>String content</SecondaryDns>
                  <StaticIp>String content</StaticIp>
                  <SubnetMask>String content</SubnetMask>
                </IpConfig>
                <NetworkIdentifier>String content</NetworkIdentifier>
                <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
              </Hypervisor>
            </Failover>
            <FailoverTest>
              <Hypervisor>
                <DnsSuffix>String content</DnsSuffix>
                <IpConfig>
                  <Gateway>String content</Gateway>
                  <IsDhcp>true</IsDhcp>
                  <PrimaryDns>String content</PrimaryDns>
                  <SecondaryDns>String content</SecondaryDns>
                  <StaticIp>String content</StaticIp>
                  <SubnetMask>String content</SubnetMask>
                </IpConfig>
                <NetworkIdentifier>String content</NetworkIdentifier>
                <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
              </Hypervisor>
            </FailoverTest>
            <NicIdentifier>String content</NicIdentifier>
          </VpgSettingsVmNicApi>
          <VpgSettingsVmNicApi>
            <Failover>
              …
            </Failover>
            <FailoverTest>
              …
            </FailoverTest>
            <NicIdentifier>String content</NicIdentifier>
          </VpgSettingsVmNicApi>
        </Nics>
        <Recovery>
          <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
          <DatastoreIdentifier>String content</DatastoreIdentifier>
          <FolderIdentifier>String content</FolderIdentifier>
          <HostClusterIdentifier>String content</HostClusterIdentifier>
          <HostIdentifier>String content</HostIdentifier>
          <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
        </Recovery>
        <VmIdentifier>String content</VmIdentifier>
        <Volumes>
          <VpgSettingsVmVolumeApi>
            <Datastore>
              <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
              <DatastoreIdentifier>String content</DatastoreIdentifier>
              <IsThin>true</IsThin>
            </Datastore>
            <ExistingVolume>
              <DatastoreIdentifier>String content</DatastoreIdentifier>
              <ExistedVmIdentifier>String content</ExistedVmIdentifier>
              <Mode>String content</Mode>
              <Path>String content</Path>
            </ExistingVolume>
            <IsSwap>true</IsSwap>
            <VolumeIdentifier>String content</VolumeIdentifier>
          </VpgSettingsVmVolumeApi>
          <VpgSettingsVmVolumeApi>
             …
          </VpgSettingsVmVolumeApi>
        </Volumes>
      </VpgSettingsVmApi>
      <VpgSettingsVmApi>
         …
      </VpgSettingsVmApi>
    </Vms>
    <VpgIdentifier>String content</VpgIdentifier>
    <VpgSettingsIdentifier>String content</VpgSettingsIdentifier>
</VpgSettingsApi>
The request body for the API https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/commit is empty.
The following is an example request XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms.
<VpgSettingsVmApi xmlns="http://schemas.zerto.com/zvm/api">
    <BootGroupIdentifier>String content</BootGroupIdentifier>
    <Journal>
      <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <Limitation>
        <HardLimitInMB>4294967295</HardLimitInMB>
        <HardLimitInPercent>4294967295</HardLimitInPercent>
        <WarningThresholdInMB>4294967295</WarningThresholdInMB>
        <WarningThresholdInPercent>4294967295</WarningThresholdInPercent>
      </Limitation>
    </Journal>
    <Nics>
      <VpgSettingsVmNicApi>
        <Failover>
          <Hypervisor>
            <DnsSuffix>String content</DnsSuffix>
            <IpConfig>
              <Gateway>String content</Gateway>
              <IsDhcp>true</IsDhcp>
              <PrimaryDns>String content</PrimaryDns>
              <SecondaryDns>String content</SecondaryDns>
              <StaticIp>String content</StaticIp>
              <SubnetMask>String content</SubnetMask>
            </IpConfig>
            <NetworkIdentifier>String content</NetworkIdentifier>
            <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
          </Hypervisor>
        </Failover>
        <FailoverTest>
          <Hypervisor>
            <DnsSuffix>String content</DnsSuffix>
            <IpConfig>
              <Gateway>String content</Gateway>
              <IsDhcp>true</IsDhcp>
              <PrimaryDns>String content</PrimaryDns>
              <SecondaryDns>String content</SecondaryDns>
              <StaticIp>String content</StaticIp>
              <SubnetMask>String content</SubnetMask>
            </IpConfig>
            <NetworkIdentifier>String content</NetworkIdentifier>
            <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
          </Hypervisor>
        </FailoverTest>
        <NicIdentifier>String content</NicIdentifier>
      </VpgSettingsVmNicApi>
      <VpgSettingsVmNicApi>
        <Failover>
          …
        </Failover>
        <FailoverTest>
          …
        </FailoverTest>
        <NicIdentifier>String content</NicIdentifier>
      </VpgSettingsVmNicApi>
    </Nics>
    <Recovery>
      <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <FolderIdentifier>String content</FolderIdentifier>
      <HostClusterIdentifier>String content</HostClusterIdentifier>
      <HostIdentifier>String content</HostIdentifier>
      <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
    </Recovery>
    <VmIdentifier>String content</VmIdentifier>
    <Volumes>
      <VpgSettingsVmVolumeApi>
        <Datastore>
          <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
          <DatastoreIdentifier>String content</DatastoreIdentifier>
          <IsThin>true</IsThin>
        </Datastore>
        <ExistingVolume>
          <DatastoreIdentifier>String content</DatastoreIdentifier>
          <ExistedVmIdentifier>String content</ExistedVmIdentifier>
          <Mode>String content</Mode>
          <Path>String content</Path>
        </ExistingVolume>
        <IsSwap>true</IsSwap>
        <VolumeIdentifier>String content</VolumeIdentifier>
      </VpgSettingsVmVolumeApi>
      <VpgSettingsVmVolumeApi>
        …
      </VpgSettingsVmVolumeApi>
    </Volumes>
</VpgSettingsVmApi>
The following is an example request XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics.
<VpgSettingsVmNicApi xmlns="http://schemas.zerto.com/zvm/api">
  <Failover>
    <Hypervisor>
      <DnsSuffix>String content</DnsSuffix>
      <IpConfig>
        <Gateway>String content</Gateway>
        <IsDhcp>true</IsDhcp>
        <PrimaryDns>String content</PrimaryDns>
        <SecondaryDns>String content</SecondaryDns>
        <StaticIp>String content</StaticIp>
        <SubnetMask>String content</SubnetMask>
      </IpConfig>
      <NetworkIdentifier>String content</NetworkIdentifier>
      <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
    </Hypervisor>
  </Failover>
  <FailoverTest>
    <Hypervisor>
      <DnsSuffix>String content</DnsSuffix>
      <IpConfig>
        <Gateway>String content</Gateway>
        <IsDhcp>true</IsDhcp>
        <PrimaryDns>String content</PrimaryDns>
        <SecondaryDns>String content</SecondaryDns>
        <StaticIp>String content</StaticIp>
        <SubnetMask>String content</SubnetMask>
      </IpConfig>
      <NetworkIdentifier>String content</NetworkIdentifier>
      <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
    </Hypervisor>
  </FailoverTest>
  <NicIdentifier>String content</NicIdentifier>
</VpgSettingsVmNicApi>
Response Body Formats
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings.
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">String content</string>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/commit.
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">String content</string>
The response XML bodies for the following APIs are empty:
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics