Zerto APIs : VPG Management API : VPG Settings: POST
  
VPG Settings: POST
The POST method is used for the following purposes:
■ To create a VPG settings identifier, or a session identifier.
■ To commit the settings object to deploy the VPG in the Zerto Virtual Manager
■ To add virtual machines to a VPG
■ To add NIC settings to a virtual machine.
You can use the same URL, https://zvm_ip:port/v1/vpgSettings, to either create a new VPG or edit an existing one.
■ To create a new VPG, put the parameters you wish to include in the VPG - in the request body.
■ To update an existing VPG, put the VPG Identifier in the request body.
Note: A maximum of 100 VPGSettings objects can coexist in temporary state. Make sure you commit or delete VPG settings objects that are no longer in use.
See also:
■ VPG Settings: GET
■ VPG Settings: PUT
■ VPG Settings: DELETE
URL
 
Create a new VPG settings Identifier
https://zvm_ip:port/v1/vpgSettings
Create VPG settings Identifier for an existing VPG
https://zvm_ip:port/v1/vpgSettings
Commit a settings object
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/commit
Add VMs to a settings object
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms
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 that is to be added to a VPG or for a NIC that is added to a virtual machine in the VPG. The identifier comprises the server identifier and the virtual machine moref, with the format, serverid.moref.
\
When creating a VPG settings object, The following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgSettings.
 
  "Backup": {
    "RepositoryIdentifier": "String content",
    "RetentionPeriod": "String content",
    "Retry": {
      "IntervalInMinutes":2147483647,
      "Number":2147483647,
      "Retry": Boolean
    },
    "Scheduler": {
      "DayOfWeek": "String content",
      "SchedulerPeriod": "String content",
      "TimeOfDay": "String content"
    }
  },
  "Basic": {
    "JournalHistoryInHours":2147483647,
    "Name": "String content",
    "Priority": "String content",
    "ProtectedSiteIdentifier": "String content",
    "RecoverySiteIdentifier": "String content",
    "RpoInSeconds":4294967295,
    "ServiceProfileIdentifier": "String content",
    "TestIntervalInMinutes":2147483647,
    "UseWanCompression": Boolean,
    "ZorgIdentifier": "String content"
  },
  "BootGroups": {
    "BootGroups":[{
      "BootDelayInSeconds":4294967295,
      "BootGroupIdentifier": "String content",
      "Name": "String content"
    }]
  },
  "Journal": {
    "DatastoreIdentifier": "String content",
    "Limitation": {
      "HardLimitInMB":2147483647,
      "HardLimitInPercent":2147483647,
      "WarningThresholdInMB":2147483647,
      "WarningThresholdInPercent":2147483647
    }
  },
  "Networks": {
    "Failover": {
      "Hypervisor": {
        "DefaultNetworkIdentifier": "String content"
      }
    },
    "FailoverTest": {
      "Hypervisor": {
        "DefaultNetworkIdentifier": "String content"
      }
    }
  },
  "Recovery": {
    "DefaultDatastoreClusterIdentifier": "String content",
    "DefaultDatastoreIdentifier": "String content",
    "DefaultFolderIdentifier": "String content",
    "DefaultHostClusterIdentifier": "String content",
    "DefaultHostIdentifier": "String content",
    "ResourcePoolIdentifier": "String content"
  },
  "Scripting": {
    "PostBackup": {
      "Command": "String content",
      "Parameters": "String content",
      "TimeoutInSeconds":2147483647
    },
    "PostRecovery": {
      "Command": "String content",
      "Parameters": "String content",
      "TimeoutInSeconds":2147483647
    },
    "PreRecovery": {
      "Command": "String content",
      "Parameters": "String content",
      "TimeoutInSeconds":2147483647
    }
  },
  "Vms":[{
    "BootGroupIdentifier": "String content",
    "Journal": {
      "DatastoreIdentifier": "String content",
      "Limitation": {
        "HardLimitInMB":4294967295,
        "HardLimitInPercent":4294967295,
        "WarningThresholdInMB":4294967295,
        "WarningThresholdInPercent":4294967295
      }
    },
  "Nics":[{
      "Failover": {
        "Hypervisor": {
          "DnsSuffix": "String content",
          "IpConfig": {
            "Gateway": "String content",
            "IsDhcp": Boolean,
            "PrimaryDns": "String content",
            "SecondaryDns": "String content",
            "StaticIp": "String content",
            "SubnetMask": "String content"
          },
          "NetworkIdentifier": "String content",
          "ShouldReplaceMacAddress": Boolean
        }
      },
        "FailoverTest": {
        "Hypervisor": {
          "DnsSuffix": "String content",
          "IpConfig": {
            "Gateway": "String content",
            "IsDhcp": Boolean,
            "PrimaryDns": "String content",
            "SecondaryDns": "String content",
            "StaticIp": "String content",
            "SubnetMask": "String content"
          },
          "NetworkIdentifier": "String content",
          "ShouldReplaceMacAddress": Boolean
        },
      },
      "NicIdentifier": "String content"
    }],
    "Recovery": {
      "DatastoreClusterIdentifier": "String content",
      "DatastoreIdentifier": "String content",
      "FolderIdentifier": "String content",
      "HostClusterIdentifier": "String content",
      "HostIdentifier": "String content",
      "ResourcePoolIdentifier": "String content"
    },
    "VmIdentifier": "String content",
    "Volumes":[{
      "Datastore": {
        "DatastoreClusterIdentifier": "String content",
        "DatastoreIdentifier": "String content",
        "IsThin": Boolean
      },
      "IsSwap": Boolean,
      "Preseed": null,
      "RDM": null,
      "VCD": null,
      "VolumeIdentifier": "String content"
 
When creating a VPG settings object for an existing VPG, the following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgSettings.
 
{
  "VpgIdentifier":"String content"
}
 
The request body for https://zvm_ip:port/v1/vpgSettings/commit is empty.
The following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms.
 
 
{
  "BootGroupIdentifier":"String content",
  "Journal":{
    "DatastoreIdentifier":"String content",
    "Limitation":{
      "HardLimitInMB":4294967295,
      "HardLimitInPercent":4294967295,
      "WarningThresholdInMB":4294967295,
      "WarningThresholdInPercent":4294967295
    }
  },
  "Nics":[{
    "Failover":{
      "Hypervisor":{
        "DnsSuffix":"String content",
        "IpConfig":{
          "Gateway":"String content",
          "IsDhcp":true,
          "PrimaryDns":"String content",
          "SecondaryDns":"String content",
          "StaticIp":"String content",
          "SubnetMask":"String content"
        },
        "NetworkIdentifier":"String content",
        "ShouldReplaceMacAddress":true
      }
    },
    "FailoverTest":{
      "Hypervisor":{
        "DnsSuffix":"String content",
        "IpConfig":{
          "Gateway":"String content",
          "IsDhcp":true,
          "PrimaryDns":"String content",
          "SecondaryDns":"String content",
          "StaticIp":"String content",
          "SubnetMask":"String content"
        },
        "NetworkIdentifier":"String content",
        "ShouldReplaceMacAddress":true
      }
    },
    "NicIdentifier":"String content"
  }],
  "Recovery":{
    "DatastoreClusterIdentifier":"String content",
    "DatastoreIdentifier":"String content",
    "FolderIdentifier":"String content",
    "HostClusterIdentifier":"String content",
    "HostIdentifier":"String content",
    "ResourcePoolIdentifier":"String content"
  },
  "VmIdentifier":"String content",
    "Volumes":[{
      "Datastore": {
        "DatastoreClusterIdentifier": "String content",
        "DatastoreIdentifier": "String content",
        "IsThin": Boolean
      },
      "IsSwap": Boolean,
      "Preseed": null,
      "RDM": null,
      "VCD": null,
      "VolumeIdentifier": "String content"
 
 
Request Values
Create a VPG settings object for a new VPG
Request values for https://zvm_ip:port/v1/vpgSettings.
Parameter
Description
Backup (Deprecated)
Information related to offsite backup.
RepositoryIdentifier
The identifier of the repository where offsite backups will be written.
RetentionPeriod
The length of time to keep offsite backups, up to a maximum of 12 months. Over time, Zerto reduces the number of stored offsite backups to save space.
The SchedulerPeriod parameter defines whether backups are created daily or weekly.
For an explanation of how Zerto reduces the number of offsite backups, see the Zerto Administration Guide.
Retry
Information about backup retries.
IntervalInMinutes
How much time to wait, in minutes, after a backup job fails before running the backup job again.
Number
The number of retries that will be attempted.
Retry
True: The offsite backup job will rerun automatically if it fails.
False: The offsite backup job will not rerun automatically if it fails.
Scheduler
Offsite backup schedule settings.
DayOfWeek
The day of the week that the offsite backups will run.
SchedulerPeriod
Daily: The offsite backups will run every day.
Weekly: The offsite backups will run once a week.
TimeOfDay
The time of day when offsite backup jobs will run. The time is based on a 24-hour clock.
Basic
Basic VPG settings.
JournalHistoryInHours
The time that all write commands are saved in the journal. The value is between 1 and 336 (14 days).
Name
The name of the VPG.
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.
ProtectedSiteIdentifier
The identifier of the source site where the VPG virtual machines will be protected. This is the site where the API runs.
RecoverySiteIdentifier
The identifier of the target site where the VPG virtual machines will be recovered.
RpoInSeconds
The maximum desired time between each automatic checkpoint being written to the journal before an alert is issued.
ServiceProfileIdentifier
The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used.
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.
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.
ZorgIdentifier
The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manager.
BootGroups
Information about boot groups.
BootGroups
–
BootDelayInSeconds
Specifies the delay, in seconds, between starting up the virtual machines in this group and starting up the virtual machines in the next group.
BootGroupIdentifier
The identifier of a boot group.
Name
The name of a boot group.
Journal
Information about the journal.
DatastoreIdentifier
The identifier of the storage used by the journal for the virtual machine. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref.
Limitation
Information about the journal limitations.
HardLimitInMB
The maximum journal size in MBs. 0 means unlimited. Integer values.
HardLimitInPercent
The percentage of the virtual machine volume size the journal can grow to. 0 means unlimited. Integer values.
WarningThresholdInMB
The journal size, in MBs, that generates a warning that the journal is nearing its hard limit. 0 means unlimited. Integer values.
WarningThresholdInPercent
The percentage of the virtual machine volume size that generates a warning. 0 means unlimited. Integer values.
Networks
Information about the networks that connect the protected and recovery sites.
Failover
Information about the networks used for failover.
Hypervisor
–
DefaultNetworkIdentifier
The network identifier of the network to use during a failover or move operation in which the recovered virtual machines will run.
FailoverTest
Information about the networks used for testing failover.
Hypervisor
–
DefaultNetworkIdentifier
The network identifier of the network to use when testing the failover of virtual machines in the recovery site.
Recovery
Information about the recovery site.
DefaultDatastoreClusterIdentifier
The identifier of the default datastore cluster used in the recovery site.
Note: Only when the recovery site is a vSphere site.
 
DefaultDatastoreIdentifier
The identifier of the default storage where the metadata files for the virtual machines are stored, such as the vmx or vhdx files. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref.
DefaultFolderIdentifier
The identifier of the default host cluster that handles the replicated data. The identifier comprises the server identifier and the folder moref, with the format, serverid.moref.
DefaultHostClusterIdentifier
The identifier of the default host that handles the replicated data. The identifier comprises the server identifier and the host cluster moref, with the format, serverid.moref.
DefaultHostIdentifier
The identifier of the resource pool for the recovered virtual machines. The identifier comprises the server identifier and the host moref, with the format, serverid.moref.
ResourcePoolIdentifier
The identifier of the storage cluster of the VRA virtual machine. The identifier comprises the server identifier and the resource pool moref, with the format, serverid.moref.
Scripting
Information about the scripts to run, either before or after recovery operation, or after an offsite backup is run.
PostBackup
Information about scripts that are run after an offsite backup is performed.
Command
The full path of the script. The script must be located on the same machine as the Zerto Virtual Manager for the recovery site.
Parameters
Parameters to pass to the script.
TimeoutInSeconds
The time-out, in seconds, for the script to run.
PostRecovery
Information about scripts that are run after a recovery operation is performed.
Command
The full path of the script. The script must be located on the same machine as the Zerto Virtual Manager for the recovery site.
Parameters
Parameters to pass to the script.
TimeoutInSeconds
The time-out, in seconds, for the script to run.
PreRecovery
Information about scripts that are run before a recovery operation is performed.
Command
The full path of the script. The script must be located on the same machine as the Zerto Virtual Manager for the recovery site.
Parameters
Parameters to pass to the script.
TimeoutInSeconds
The time-out, in seconds, for the script to run.
Vms
Information about the virtual machines in a VPG.
BootGroupIdentifier
The boot group identifier of a virtual machine.
Journal
Journal information of the virtual machine
DatastoreIdentifier
The identifier of the storage used by the journal for the virtual machine. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref.
Limitation
Information about the journal limitations.
HardLimitInMB
The maximum journal size in MBs. 0 means unlimited. Integer values.
HardLimitInPercent
The percentage of the virtual machine volume size the journal can grow to. 0 means unlimited. Integer values.
WarningThresholdInMB
The journal size, in MBs, that generates a warning that the journal is nearing its hard limit. 0 means unlimited. Integer values.
WarningThresholdInPercent
The percentage of the virtual machine volume size that generates a warning. 0 means unlimited. Integer values.
Nics
Information about NICs used by the virtual machine in the VPG.
Failover
Information about the networks used for failover by this virtual machine.
Hypervisor
–
DnsSuffix
The DNS name excluding the host.
IpConfig
Information about the IP configuration of the recovery site used for failovers.
Gateway
The mask for the network.
IsDhcp
True: DHCP will be used for the virtual machine on the recovery site.
False: A static IP address will be used for the virtual machine on the recovery site.
PrimaryDns
The IP address of the primary DNS server that handles Internet protocol mapping.
SecondaryDns
The IP address of the alternate, secondary, DNS server that handles Internet protocol mapping.
StaticIp
The IP of the restored virtual machine.
SubnetMask
The subnet mask for the network.
NetworkIdentifier
The network identifier of the network used for failover or move by this virtual machine.
ShouldReplaceMacAddress
True: The Media Access Control (MAC) address used on the protected site will be copied to the recovery site.
False: The Media Access Control (MAC) address used on the protected site will not be copied to the recovery site.
FailoverTest
Information about the networks used for testing failover by this virtual machine.
Hypervisor
–
DnsSuffix
The DNS name excluding the host.
IpConfig
Information about the IP configuration of the recovery site used for testing failovers.
Gateway
The mask for the network.
IsDhcp
True: DHCP will be used for the virtual machine on the recovery site.
False: A static IP address will be used for the virtual machine on the recovery site.
PrimaryDns
The IP address of the primary DNS server that handles Internet protocol mapping.
SecondaryDns
The IP address of the alternate, secondary, DNS server that handles Internet protocol mapping.
StaticIp
The IP of the restored virtual machine.
SubnetMask
The subnet mask for the network.
NetworkIdentifier
The network identifier of the network used for testing failover by this virtual machine.
ShouldReplaceMacAddress
True: The Media Access Control (MAC) address used on the protected site will be copied to the recovery site.
False: The Media Access Control (MAC) address used on the protected site will not be copied to the recovery site.
NicIdentifier
The identifier of the NIC for which settings are returned.
Recovery
Information about the recovery site.
DatastoreClusterIdentifier
The identifier of the datastore cluster used in the recovery site for the VM.
Note: Only when the recovery site is a vSphere site.
 
DatastoreIdentifier
The identifier of the storage used by the journal for the virtual machine. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref
FolderIdentifier
The identifier of the folder used for recovery by the virtual machine. The identifier comprises the server identifier and the folder moref, with the format, serverid.moref.
HostClusterIdentifier
The identifier of the host cluster that handles the replicated data. The identifier comprises the server identifier and the host cluster moref, with the format, serverid.moref.
HostIdentifier
The identifier of the host that handles the replicated data. The identifier comprises the server identifier and the host moref, with the format, serverid.moref.
ResourcePoolIdentifier
The identifier of the resource pool for the recovered virtual machines. The identifier comprises the server identifier and the resource pool moref, with the format, serverid.moref.
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.
Datastore
Information about the datastore used by the virtual machine.
DatastoreClusterIdentifier
The identifier of the datastore cluster used in the recovery site for the volume.
Note: Only when the recovery site is a vSphere site.
 
DatastoreIdentifier
The identifier of the storage. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref.
IsThin
True: The recovery volumes are thin-provisioned.
False: The recovery volumes are not thin-provisioned.
IsSwap
True: The recovery disk is marked as a temp data disk.
False: The recovery disk is not marked as a temp data disk.
Preseed
Information about the disk used for preseeding.
RDM
Information about the RDM.
vCD
 
VolumeIdentifier
The identifier of the volume.
Create a VPG settings object for an existing VPG
Request values for https://zvm_ip:port/v1/vpgSettings.
 
Parameter
Description
VpgIdentifier
The identifier of the existing VPG.
 
Commit a VPG settings object
Request values for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/commit is empty.
Add a virtual machine to a VPG settings object
Request values for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms.
 
Parameter
Description
BootGroupIdentifier
The boot group identifier of a virtual machine.
Journal
Journal information of the virtual machine
DatastoreIdentifier
The identifier of the storage used by the journal for the virtual machine. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref.
Limitation
Information about the journal limitations.
HardLimitInMB
The maximum journal size in MBs. 0 means unlimited. Integer values.
HardLimitInPercent
The percentage of the virtual machine volume size the journal can grow to. 0 means unlimited. Integer values.
WarningThresholdInMB
The journal size, in MBs, that generates a warning that the journal is nearing its hard limit. 0 means unlimited. Integer values.
WarningThresholdInPercent
The percentage of the virtual machine volume size that generates a warning. 0 means unlimited. Integer values.
Nics
Information about NICs used by the virtual machine in the VPG.
Failover
Information about the networks used for failover by this virtual machine.
Hypervisor
–
DnsSuffix
The DNS name excluding the host.
IpConfig
Information about the IP configuration of the recovery site used for failovers.
Gateway
The mask for the network.
IsDhcp
True: DHCP will be used for the virtual machine on the recovery site.
False: A static IP address will be used for the virtual machine on the recovery site.
PrimaryDns
The IP address of the primary DNS server that handles Internet protocol mapping.
SecondaryDns
The IP address of the alternate, secondary, DNS server that handles Internet protocol mapping.
StaticIp
The IP of the restored virtual machine.
SubnetMask
The subnet mask for the network.
NetworkIdentifier
The network identifier of the network used for failover or move by this virtual machine.
ShouldReplaceMacAddress
True: The Media Access Control (MAC) address used on the protected site will be copied to the recovery site.
False: The Media Access Control (MAC) address used on the protected site will not be copied to the recovery site.
FailoverTest
Information about the networks used for testing failover by this virtual machine.
Hypervisor
–
DnsSuffix
The DNS name excluding the host.
IpConfig
Information about the IP configuration of the recovery site used for testing failovers.
Gateway
The mask for the network.
IsDhcp
True: DHCP will be used for the virtual machine on the recovery site.
False: A static IP address will be used for the virtual machine on the recovery site.
PrimaryDns
The IP address of the primary DNS server that handles Internet protocol mapping.
SecondaryDns
The IP address of the alternate, secondary, DNS server that handles Internet protocol mapping.
StaticIp
The IP of the restored virtual machine.
SubnetMask
The subnet mask for the network.
NetworkIdentifier
The network identifier of the network used for testing failover by this virtual machine.
ShouldReplaceMacAddress
True: The Media Access Control (MAC) address used on the protected site will be copied to the recovery site.
False: The Media Access Control (MAC) address used on the protected site will not be copied to the recovery site.
NicIdentifier
The identifier of the NIC for which settings are returned.
Recovery
Information about the recovery site.
DatastoreClusterIdentifier
The identifier of the datastore cluster used in the recovery site for the VM.
Note: Only when the recovery site is a vSphere site.
 
DatastoreIdentifier
The identifier of the storage used by the journal for the virtual machine. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref.
FolderIdentifier
The identifier of the folder used for recovery by the virtual machine. The identifier comprises the server identifier and the folder moref, with the format, serverid.moref.
HostClusterIdentifier
The identifier of the host cluster that handles the replicated data. The identifier comprises the server identifier and the host cluster moref, with the format, serverid.moref.
HostIdentifier
The identifier of the host that handles the replicated data. The identifier comprises the server identifier and the host moref, with the format, serverid.moref.
ResourcePoolIdentifier
The identifier of the resource pool for the recovered virtual machines. The identifier comprises the server identifier and the resource pool moref, with the format, serverid.moref.
VmIdentifier
The identifier of the virtual machine. The identifier comprises the server identifier and the virtual machine moref, with the format, serverid.moref.
Volumes
Information about the volumes used by the virtual machine.
Datastore
Information about the datastore used by the virtual machine.
DatastoreClusterIdentifier
The identifier of the datastore cluster used in the recovery site for the volume.
Note: Only when the recovery site is a vSphere site.
 
DatastoreIdentifier
The identifier of the storage. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref.
IsThin
True: The recovery volumes are thin-provisioned.
False: The recovery volumes are not thin-provisioned.
IsSwap
True: The recovery disk is marked as a temp data disk.
False: The recovery disk is not marked as a temp data disk.
Preseed
Information about the disk used for preseeding.
RDM
Information about the RDM.
vCD
 
VolumeIdentifier
The identifier of the volume.
 
Response In Json Format
The following is an example response Json body for https://zvm_ip:port/v1/vpgSettings and https://zvm_ip:port/v1/vpgSettings/commit.
 
"String content"
The response body for https://zvm_ip:port/v1/vpgSettings/vms and for https://zvm_ip:port/v1/vpgSettings/vms/{VMIDENTIFIER}/nics is empty.
Response values
The response value for https://zvm_ip:port/v1/vpgSettings is the vpgSettingsIdentifier.
The response value for https://zvm_ip:port/v1/vpgSettings/commit is the task identifier.