Zerto APIs : vSphere to Azure VPG Management APIs : vSphere to Azure - Edit Existing VPG Settings
  
vSphere to Azure - Edit Existing VPG Settings
The PUT method is used to update an existing VPG settings object.
 
Edit VPG settings object
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}
Edit basic settings object
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/basic
Edit network settings object
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networks
Edit VM settings object
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}
Edit a specific volume, of a specific VM
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes/{volumeId}
 
Where:
 
zvm_ip
The IP address of the Zerto Virtual Manager where the API is run.
port
The port to access the Zerto Virtual Manager. The default port is 9669.
vpgSettingsIdentifier
The identifier of the VPG settings object.
vmIdentifier
The identifier of the virtual machine. The identifier comprises the server identifier and the virtual machine moref, with the format, serverid.moref.
Request Body Using Json Format
Request Values
Response Format
 
Request Body Using Json Format
The following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}.
 
{
  "Backup": null,
  "Basic": {
    "JournalHistoryInHours": 24,
    "Name": "String Content",
    "Priority": "String Content",
    "ProtectedSiteIdentifier": "String Content",
    "RecoverySiteIdentifier": "String Content",
    "RpoInSeconds": 300,
    "ServiceProfileIdentifier": "string content"
    "TestIntervalInMinutes": 262080,
    "UseWanCompression": Boolean,  },
  "BootGroups":null,
  "Journal":null,
  "Networks": {
    "Failover": {
     "Hypervisor": null,
     "PublicCloud": {
      "VirtualNetworkIdentifier": "string content",
      "SubnetIdentifier": "string content",
      "SecurityGroupIdentifier": "string content"
     },
     "VCD": null
    },
    "FailoverTest": {
     "Hypervisor": null,
     "PublicCloud": {
      "VirtualNetworkIdentifier": "string content",
      "SubnetIdentifier": "string content",
      "SecurityGroupIdentifier": "string content"
     },
     "VCD": null
    }
  },
  "Recovery": {
    "DefaultDatastoreClusterIdentifier": null,
    "DefaultDatastoreIdentifier": null,
    "DefaultFolderIdentifier": null,
    "DefaultHostClusterIdentifier": null,
    "DefaultHostIdentifier": null,
    "PublicCloud": {
     "Failover": {
      "VmInstanceType": "string content",
      "Azure":{
       "RecoveryDiskType": "string content"
      }
     },
     "FailoverTest": {
      "VmInstanceType": "string content",
      "Azure":{
       "RecoveryDiskType": "string content"
      }
     }
    },
    "ResourcePoolIdentifier": null,
    "VCD": null
  },
  "Vms":[
  {
   "BootGroupIdentifier": null,
   "Journal": null,
   "Nics": [
   {
    "Failover": {
     "Hypervisor": null,
     "PublicCloud": {
      "PrivateIP": "string content",
      "VirtualNetworkIdentifier": "string content",
      "SubnetIdentifier": "string content",
      "SecurityGroupIdentifier": "string content"
     },
     "VCD": null
    },
    "FailoverTest": {
     "Hypervisor": null,
     "PublicCloud": {
      "PrivateIP": "string content",
      "VirtualNetworkIdentifier": "string content",
      "SubnetIdentifier": "string content",
      "SecurityGroupIdentifier": "string content"
     },
     "VCD": null
    },
    "NicIdentifier":"String content"
   }
  ],
  "Recovery": {
    "DatastoreClusterIdentifier": null,
    "DatastoreIdentifier": null,
    "FolderIdentifier": null,
    "HostClusterIdentifier": null,
    "HostIdentifier": null,
    "PublicCloud": {
     "Failover": {
      "VmInstanceType": "string content",
      "Azure":{
       "RecoveryDiskType": "string content"
      }
     },
     "FailoverTest": {
      "VmInstanceType": "string content",
      "Azure":{
       "RecoveryDiskType": "string content"
      }
     }
    },
    "ResourcePoolIdentifier": null,
    "VCD": null
  },
  "VmIdentifier": "string content",
    "Volumes":[{
      "Datastore": null,
      "IsSwap": Boolean,
      "Preseed": null,
      "RDM": null,
      "VCD":null,
      "VolumeIdentifier":"String content"
    }]
  },
 ]
  "VpgIdentifier": "String Content",
  "VpgSettingsIdentifier": "String Content"
}
 
The following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/basic.
 
 {
    "JournalHistoryInHours": 24,
    "Name": "String Content",
    "Priority": "String Content",
    "ProtectedSiteIdentifier": "String Content",
    "RecoverySiteIdentifier": "String Content",
    "RpoInSeconds": 300,
    "ServiceProfileIdentifier": "string content"
    "TestIntervalInMinutes": 262080,
    "UseWanCompression": Boolean,  },
  }
 
The following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networks.
 
{
    "Failover": {
     "Hypervisor": null,
     "PublicCloud": {
      "VirtualNetworkIdentifier": "string content",
      "SubnetIdentifier": "string content",
      "SecurityGroupIdentifier": "string content"
     },
     "VCD": null
    },
    "FailoverTest": {
     "Hypervisor": null,
     "PublicCloud": {
      "VirtualNetworkIdentifier": "string content",
      "SubnetIdentifier": "string content",
      "SecurityGroupIdentifier": "string content"
     },
     "VCD": null
    }
  }
 
The following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}
 
{
   "BootGroupIdentifier": null,
   "Journal": null,
   "Nics": [
   {
    "Failover": {
     "Hypervisor": null,
     "PublicCloud": {
      "PrivateIP": "string content",
      "VirtualNetworkIdentifier": "string content",
      "SubnetIdentifier": "string content",
      "SecurityGroupIdentifier": "string content"
     },
     "VCD": null
    },
    "FailoverTest": {
     "Hypervisor": null,
     "PublicCloud": {
      "PrivateIP": "string content",
      "VirtualNetworkIdentifier": "string content",
      "SubnetIdentifier": "string content",
      "SecurityGroupIdentifier": "string content"
     },
     "VCD": null
    },
    "NicIdentifier":"String content"
   }
  ],
  "Recovery": {
    "DatastoreClusterIdentifier": null,
    "DatastoreIdentifier": null,
    "FolderIdentifier": null,
    "HostClusterIdentifier": null,
    "HostIdentifier": null,
    "PublicCloud": {
     "Failover": {
      "VmInstanceType": "string content",
      "Azure":{
       "RecoveryDiskType": "string content"
      }
     },
     "FailoverTest": {
      "VmInstanceType": "string content",
      "Azure":{
       "RecoveryDiskType": "string content"
      }
     }
    },
    "ResourcePoolIdentifier": null,
    "VCD": null
  },
  "VmIdentifier": "string content",
    "Volumes":[{
      "Datastore": null,
      "IsSwap": Boolean,
      "Preseed": null,
      "RDM": null,
      "VCD":null,
      "VolumeIdentifier":"String content"
    }]
}
 
The following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes/{volumeId}.
 
{
      "Datastore": null,
      "IsSwap": Boolean,
      "Preseed": null,
      "RDM": null,
      "VCD":null,
      "VolumeIdentifier":"String content"
}
 
 
Request Values
Update a VPG settings object
Update the basic settings in a VPG settings object
Update the network settings in a VPG settings object
Update the virtual machine settings in a VPG settings object - vmIdentifier
Update the virtual machine settings in a VPG settings object - volumeId
Update a VPG settings object
Request values for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}.
 
Parameter
Description
Mandatory
Default
Basic
 
 
JournalHistoryInHours
The time that all write commands are saved in the journal. The value is between 1 and 336 (14 days).
 
24
Name
The name of the VPG.
Yes
 
Priority
The priority specified for the VPG. Possible values are:
■ Low: The VPG has a low priority for transferring data.
■ Medium: The VPG has a medium priority for transferring data.
■ High: The VPG has a high priority for transferring data.
 
Medium
ProtectedSiteIdentifier
The identifier of the site where the VPG will be protected. This is the site where the API runs.
Yes
 
RecoverySiteIdentifier
The identifier of the site where the VPG will be recovered.
Yes
 
RpoInSeconds
The maximum desired time between each automatic checkpoint being written to the journal before an alert is issued.
 
300
TestIntervalInMinutes
The time, in minutes, recommended between testing the integrity of the VPG. A warning is issued if a test is not done within this time frame. Possible values are:
■ 0: No testing is expected.
■ 43200 or null: Testing is expected monthly.
■ 131040: Testing is expected every three months.
■ 262080: Testing is expected every six months.
■ 394560: Testing is expected every nine months.
■ 525600: Testing is expected every twelve months.
 
262080
UseWanCompression
True: Data will be compressed before sending it to the recovery site.
False: Data will not be compressed before sending it to the recovery site.
 
True
Networks
 
 
Failover
Information about the networks used for failover.
 
 
PublicCloud
 
 
VirtualNetworkIdentifier
The identifier of the virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available vNets.
Yes
 
SubnetIdentifier
The identifier of the subnet which is under the specified virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available Subnets.
Yes
 
SecurityGroupIdentifier
The identifier of the Azure network security to be associated with the virtual machines in this VPG. This is the default recovery settings applied to every virtual machine in the VPG.
See Security Groups.
Yes
None
FailoverTest
Information about the networks used for testing failover.
 
 
PublicCloud
 
 
VirtualNetworkIdentifier
The identifier of the virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available vNets.
Yes
 
SubnetIdentifier
The identifier of the subnet which is under the specified virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available Subnets.
Yes
 
SecurityGroupIdentifier
The identifier of the Azure network security to be associated with the virtual machines in this VPG. This is the default recovery settings applied to every virtual machine in the VPG.
See Security Groups.
Yes
None
Recovery
 
 
PublicCloud
 
 
Failover
 
 
 
VmInstanceType
The virtual machine instance type, within the virtual machine series, to assign to recovered virtual machines. Different sizes within a virtual machine series vary, for example in a number of cores, RAM, and local storage size.
See VM Instance Type.
Yes
 
Azure
 
 
 
RecoveryDiskType
The Azure recovery storage type to which the entire VPG will be recovered; UnmanagedStandard or ManagedPremiumSSD .
Yes
UnmanagedStandard
FailoverTest
 
 
 
VmInstanceType
The virtual machine instance type, within the virtual machine series, to assign to recovered virtual machines. Different sizes within a virtual machine series vary, for example in a number of cores, RAM, and local storage size.
See VM Instance Type.
Yes
 
Azure
 
 
 
RecoveryDiskType
The Azure recovery storage type to which the entire VPG will be recovered; UnmanagedStandard or ManagedPremiumSSD.
Yes
UnmanagedStandard
Vms
 
 
Nics
 
 
Failover
Information about the networks used for failover.
 
 
PublicCloud
 
 
PrivateIP
 
 
DHCP
VirtualNetworkIdentifier
The identifier of the virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available vNets.
Yes
 
SubnetIdentifier
The identifier of the subnet which is under the specified virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available Subnets.
Yes
 
SecurityGroupIdentifier
The identifier of the Azure network security to be associated with the virtual machines in this VPG. This is the default recovery settings applied to every virtual machine in the VPG.
See Security Groups.
Yes
None
FailoverTest
Information about the networks used for testing failover.
 
 
PublicCloud
 
 
VirtualNetworkIdentifier
The identifier of the virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available vNets.
Yes
 
SubnetIdentifier
The identifier of the subnet which is under the specified virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available Subnets.
Yes
 
SecurityGroupIdentifier
The identifier of the Azure network security to be associated with the virtual machines in this VPG. This is the default recovery settings applied to every virtual machine in the VPG.
See Security Groups.
Yes
None
NicIdentifier
The identifier of the NIC for which settings are returned.
Protecting to Azure this value is NULL.
 
 
Recovery
 
 
PublicCloud
 
 
Failover
 
 
 
VmInstanceType
The virtual machine instance type, within the virtual machine series, to assign to recovered virtual machines. Different sizes within a virtual machine series vary, for example in a number of cores, RAM, and local storage size.
See VM Instance Type.
Yes
 
Azure
 
 
 
RecoveryDiskType
The Azure recovery storage type to which the entire VPG will be recovered; UnmanagedStandard or ManagedPremiumSSD .
Yes
UnmanagedStandard
FailoverTest
 
 
 
VmInstanceType
The virtual machine instance type, within the virtual machine series, to assign to recovered virtual machines. Different sizes within a virtual machine series vary, for example in a number of cores, RAM, and local storage size.
See VM Instance Type.
Yes
 
Azure
 
 
 
RecoveryDiskType
The Azure recovery storage type to which the entire VPG will be recovered; UnmanagedStandard or ManagedPremiumSSD.
Yes
UnmanagedStandard
VmIdentifier
The identifier of the virtual machine. The identifier comprises the server identifier and the virtual machine moref, with the format, serverid.more.
 
 
Volumes
Information about the volumes used by the virtual machine.
 
 
IsSwap
True: The recovery disk is marked as a temp data disk.
False: The recovery disk is not marked as a temp data disk.
 
 
VolumeIdentifier
The identifier of the volume.
 
 
VpgIdentifier
The VPG identifier will be specified if a VPG was already created in a previous session.
 
 
VpgSettingsIdentifier
The identifier received after running the following POST API: https://zvm_ip:port/v1/vpgSettings
 
 
 
 
Update the basic settings in a VPG settings object
Request values for https://zvm_ip:port/v1/vpgSettings/basic
 
Parameter
Description
Mandatory
Default
JournalHistoryInHours
The time that all write commands are saved in the journal. The value is between 1 and 336 (14 days).
 
24
Name
The name of the VPG.
Yes
 
Priority
The priority specified for the VPG. Possible values are:
■ Low: The VPG has a low priority for transferring data.
■ Medium: The VPG has a medium priority for transferring data.
■ High: The VPG has a high priority for transferring data.
 
Medium
ProtectedSiteIdentifier
The identifier of the site where the VPG will be protected. This is the site where the API runs.
Yes
 
RecoverySiteIdentifier
The identifier of the site where the VPG will be recovered.
Yes
 
RpoInSeconds
The maximum desired time between each automatic checkpoint being written to the journal before an alert is issued.
 
300
TestIntervalInMinutes
The time, in minutes, recommended between testing the integrity of the VPG. A warning is issued if a test is not done within this time frame. Possible values are:
■ 0: No testing is expected.
■ 43200 or null: Testing is expected monthly.
■ 131040: Testing is expected every three months.
■ 262080: Testing is expected every six months.
■ 394560: Testing is expected every nine months.
■ 525600: Testing is expected every twelve months.
 
262080
UseWanCompression
True: Data will be compressed before sending it to the recovery site.
False: Data will not be compressed before sending it to the recovery site.
 
True
 
Update the network settings in a VPG settings object
Request values for https://zvm_ip:port/v1/vpgSettings/networks
 
Parameter
Description
Mandatory
Default
Failover
Information about the networks used for failover.
 
 
PublicCloud
 
 
VirtualNetworkIdentifier
The identifier of the virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available vNets.
Yes
 
SubnetIdentifier
The identifier of the subnet which is under the specified virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available Subnets.
Yes
 
SecurityGroupIdentifier
The identifier of the Azure network security to be associated with the virtual machines in this VPG. This is the default recovery settings applied to every virtual machine in the VPG.
See Security Groups.
Yes
None
FailoverTest
Information about the networks used for testing failover.
 
 
PublicCloud
 
 
VirtualNetworkIdentifier
The identifier of the virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available vNets.
Yes
 
SubnetIdentifier
The identifier of the subnet which is under the specified virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available Subnets.
Yes
 
SecurityGroupIdentifier
The identifier of the Azure network security to be associated with the virtual machines in this VPG. This is the default recovery settings applied to every virtual machine in the VPG.
See Security Groups.
Yes
None
 
Update the virtual machine settings in a VPG settings object - vmIdentifier
Request values for https://zvm_ip:port/v1/vpgSettings/vms/{vmIdentifier}/{vmIdentifier}
 
Parameter
Description
Mandatory
Default
Nics
 
 
Failover
Information about the networks used for failover.
 
 
PublicCloud
 
 
PrivateIP
 
 
DHCP
VirtualNetworkIdentifier
The identifier of the virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available vNets.
Yes
 
SubnetIdentifier
The identifier of the subnet which is under the specified virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available Subnets.
Yes
 
SecurityGroupIdentifier
The identifier of the Azure network security to be associated with the virtual machines in this VPG. This is the default recovery settings applied to every virtual machine in the VPG.
See Security Groups.
Yes
None
FailoverTest
Information about the networks used for testing failover.
 
 
PublicCloud
 
 
VirtualNetworkIdentifier
The identifier of the virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available vNets.
Yes
 
SubnetIdentifier
The identifier of the subnet which is under the specified virtual network. This is the default recovery settings applied to every virtual machine in the VPG.
See Available Subnets.
Yes
 
SecurityGroupIdentifier
The identifier of the Azure network security to be associated with the virtual machines in this VPG. This is the default recovery settings applied to every virtual machine in the VPG.
See Security Groups.
Yes
None
NicIdentifier
The identifier of the NIC for which settings are returned.
Protecting to Azure this value is NULL.
 
 
Recovery
 
 
PublicCloud
 
 
Failover
 
 
 
VmInstanceType
The virtual machine instance type, within the virtual machine series, to assign to recovered virtual machines. Different sizes within a virtual machine series vary, for example in a number of cores, RAM, and local storage size.
See VM Instance Type.
Yes
 
Azure
 
 
 
RecoveryDiskType
The Azure recovery storage type to which the entire VPG will be recovered; UnmanagedStandard or ManagedPremiumSSD .
Yes
UnmanagedStandard
FailoverTest
 
 
 
VmInstanceType
The virtual machine instance type, within the virtual machine series, to assign to recovered virtual machines. Different sizes within a virtual machine series vary, for example in a number of cores, RAM, and local storage size.
See VM Instance Type.
Yes
 
Azure
 
 
 
RecoveryDiskType
The Azure recovery storage type to which the entire VPG will be recovered; UnmanagedStandard or ManagedPremiumSSD.
Yes
UnmanagedStandard
VmIdentifier
The identifier of the virtual machine. The identifier comprises the server identifier and the virtual machine moref, with the format, serverid.more.
 
 
Volumes
Information about the volumes used by the virtual machine.
 
 
IsSwap
True: The recovery disk is marked as a temp data disk.
False: The recovery disk is not marked as a temp data disk.
 
 
VolumeIdentifier
The identifier of the volume.
 
 
 
Update the virtual machine settings in a VPG settings object - volumeId
Request values for https://zvm_ip:port/v1/vpgSettings/vms/{vmIdentifier}/{vmIdentifier}/volumes/{volumeId}
 
Parameter
Description
Mandatory
Default
IsSwap
True: The recovery disk is marked as a temp data disk.
False: The recovery disk is not marked as a temp data disk.
 
 
VolumeIdentifier
The identifier of the volume.
 
 
 
Response Format
The response bodies are empty.