Zerto APIs : vSphere to vCD VPG Management APIs : vSphere to vCD - Create New VPG Settings
  
vSphere to vCD - Create New VPG Settings
To create a VPG, run the following APIs:
1. Get a VPG Settings Identifier
2. Get an Empty VPG Template
3. Add Values in the Empty VPG Template
4. Get a Full VPG Template
 
 
 
Get a VPG Settings Identifier
Run this API to get a VPG settings identifier. With the VPG Settings Identifier, you can request for an empty VPG template.
Request Body Using Json Format
Response In Json Format
 
method
url
POST
https://zvm_ip:port/v1/vpgSettings
 
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.
 
Request Body Using Json Format
You can create a skeleton VPG settings object by using the following request body:
{}
Response In Json Format
The following is an example response.
 
{
  "VpgSettingsIdentifier": "String content"
}
 
VpgSettingsIdentifier
The identifier of the VPG settings.
 
Back to vSphere to vCD VPG Management APIs
Back to All APIs
Get an Empty VPG Template
Run this API to get an empty VPG template to create a new VPG. Use this template to add parameters values for the VPG Settings Identifier. See Add Values in the Empty VPG Template.
 
method
url
GET
https://zvm_ip:port/v1/vpgSettings/{VpgSettingsIdentifier}
 
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.
 
Request Body Using Json Format
Response In Json Format
Request Body Using Json Format
The request body is empty.
Response In Json Format
The following is an example response.
 
[{
  "Backup": "String Content",
  "Basic": {
    "JournalHistoryInHours": number,
    "Name": "String Content",
    "Priority": "String Content",
    "ProtectedSiteIdentifier": "String Content",
    "RecoverySiteIdentifier": "String Content",
    "RpoInSeconds": Number,
    "ServiceProfileIdentifier": "String Content",
    "TestIntervalInMinutes":Number,
    "UseWanCompression": Boolean,
    "ZorgIdentifier": "String Content"
  },
  "BootGroups": {
    "BootGroups":[{
      "BootDelayInSeconds": Number,
      "BootGroupIdentifier": "String Content",
      "Name": "String Content"
    }]
  },
  "Journal": {
    "DatastoreIdentifier": "String Content",
    "Limitation": {
      "HardLimitInMB": Number,
      "HardLimitInPercent": Number,
      "WarningThresholdInMB": Number,
      "WarningThresholdInPercent": Number
    }
  },
  "Networks": {
    "Failover": {
      Hypervisor": {
        "DefaultNetworkIdentifier": "String Content"
      }
      "VCD": null
    },
    "FailoverTest": {
      "Hypervisor": {
        "DefaultNetworkIdentifier": "String Content"
      }
      "VCD": null
    }
  },
  "Protected": {
    "VCD": null
  }
  "Recovery": {
    "DefaultDatastoreClusterIdentifier": "String Content",
    "DefaultDatastoreIdentifier": "String Content",
    "DefaultFolderIdentifier": "String Content",
    "DefaultHostClusterIdentifier": "String Content",
    "DefaultHostIdentifier": "String Content",
    "ResourcePoolIdentifier": "String Content"
    "VCD": null
  },
  "Scripting": {
    "PostBackup": "String Content",
    "PostRecovery": {
      "Command": "String Content",
      "Parameters": null,
      "TimeoutInSeconds": Number
    },
    "PreRecovery": {
      "Command": "String Content",
      "Parameters": "String Content",
      "TimeoutInSeconds": Number
  },
  "Vms": [],
  "VpgIdentifier": "String Content",
  "VpgSettingsIdentifier": "String Content"
}]
 
 
 
 
 
Add Values in the Empty VPG Template
Add values for the new VPG by running a PUT API. The empty template includes mandatory fields for creating a VPG. The mandatory fields are specified in the Request Body Using Json Format.
By running the PUT API with a value in RecoveryOrgVdcIdentifier, you are defining the recovery site as a vCD site. When RecoveryOrgVdcIdentifier is set, both the RecoveryOrgVdcNetworkIdentifier and RecoveryStoragePolicyIdentifier get a default value.
After adding the values in the empty template, run a GET API to receive the full template, with the newly defined parameters and their sub-parameters. Run a PUT API to add values for the sub-parameters. See Get a Full VPG Template.
Note: Once all parameters are set, commit the changes using POST commit with the full JSON request body:
https://zvm_ip:port/v1/vpgSettings/{VpgSettingsIdentifier}/commit
 
method
url
PUT
https://zvm_ip:port/v1/vpgSettings/{VpgSettingsIdentifier}
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.
Request Body Using Json Format
Response In Json Format
Request Body Using Json Format
The following is an example vSphere to vCD request Json body.
 
[{
  "Basic": {
    "Name": "string content",
    "ProtectedSiteIdentifier": "string content",
    "RecoverySiteIdentifier": "string content"
    "ServiceProfileIdentifier": "string content"
  },
  "Networks": {
    "Failover": {
     "VCD": {
      "DefaultRecoveryOrgVdcNetworkIdentifier": "string content"
     }
    },
    "FailoverTest": {
     "VCD": {
      "DefaultRecoveryOrgVdcNetworkIdentifier": "string content"
     }
    },
  "Recovery": {
    "VCD": {
     "OrgVdcIdentifier": "'+RecoveryOrgVdcIdentifier+'"
    }
  },
  "Vms": [
    {
     "Recovery": {
      "VCD": {
       "StoragePolicyIdentifier": "string content"
      }
     },
     "VmIdentifier": "string content"
    }
  ]
}
 
Parameter
Description
Mandatory
Default
Basic
 
Name
The name of the VPG.
Yes
 
ProtectedSiteIdentifier
The identifier of the site where the VPG will be protected. This is the site where the API runs.
 
Current site
RecoverySiteIdentifier
The identifier of the site where the VPG will be recovered.
Yes
 
ServiceProfileIdentifier
The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used.
Yes (for ZCM)
 
Networks
Failover
Information about the networks used for failover.
 
 
vCD
DefaultRecoveryOrgVdcNetworkIdentifier
The identifier of the Org vDC network. This is the default recovery settings applied to every virtual machine in the VPG. When OrgVdcIdentifier is set, DefaultRecoveryOrgVdcNetworkIdentifier is set by default. Default value is none or "00000000-0000-0000-0000-000000000000."
 
None
 
FailoverTest
Information about the networks used for testing failover.
 
 
vCD
DefaultRecoveryOrgVdcNetworkIdentifier
The identifier of the Org vDC network. This is the default recovery settings applied to every virtual machine in the VPG. When OrgVdcIdentifier is set, DefaultRecoveryOrgVdcNetworkIdentifier is set by default. Default value is none or "00000000-0000-0000-0000-000000000000."
 
None
Recovery
 
vCD
OrgVdcIdentifier
The identifier of an Org vDC.
Yes
 
Vms
VmIdentifier
The identifier of the protected VMs.
Yes
 
 
Response In Json Format
The response body is empty.
Get a Full VPG Template
After you add the values to the mandatory parameters, run this API to receive a more detailed template. The detailed template includes sub-parameters of the parameters to which you added values. Add values to the sub-parameters using the PUT API. See Add Values in the Empty VPG Template.
 
method
url
GET
https://zvm_ip:port/v1/vpgSettings/{VpgSettingsIdentifier}
 
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.
 
Request Body Using Json Format
Response In Json Format
Request Body Using Json Format
The request body is empty.
Response In Json Format
The following is an example vCD response Json body.
 
[{
  "Basic": {
    "JournalHistoryInHours": 24,
    "Name": "String Content",
    "Priority": "String Content",
    "ProtectedSiteIdentifier": "String Content",
    "RecoverySiteIdentifier": "String Content",
    "RpoInSeconds": 300,
    "ServiceProfileIdentifier": "string content"
    "TestIntervalInMinutes": 262080,
    "UseWanCompression": Boolean,  },
  "Journal": {
    "Limitation": {
      "HardLimitInMB": 153600,
      "HardLimitInPercent": 0,
      "WarningThresholdInMB": 115200,
      "WarningThresholdInPercent": 0
    }
  },
  "Networks": {
    "Failover": {
      "VCD": {
       "IsEnableGuestCustomization": Boolean
       "DefaultRecoveryOrgVdcNetworkIdentifier": "string content"
      }
    }
    "FailoverTest": {
      "VCD": {
       "IsEnableGuestCustomization": Boolean
       "DefaultRecoveryOrgVdcNetworkIdentifier": "string content"
      }
    }
  },
  "Recovery": {
    "VCD": {
      "OrgVdcIdentifier": "String Content"
    }
  },
  "Vms":[
    {
    "Journal":{
      "Limitation":{
        "HardLimitInMB":153600,
        "HardLimitInPercent":0,
        "WarningThresholdInMB":115200,
        "WarningThresholdInPercent":0
      }
    },
    "Nics": [
     {
      "Failover":{
        "VCD": {
         "IpAddress": null,
         "IpMode": "String Content",
         "IsConnected": Boolean,
         "IsPrimary": Boolean
         "IsResetMacAddress": Boolean
         "RecoveryOrgVdcNetworkIdentifier":"String content",
        }
      },
      "FailoverTest":{
        "VCD": {
         "IpAddress": null,
         "IpMode": "String Content",
         "IsConnected": Boolean,
         "IsPrimary": Boolean
         "IsResetMacAddress": Boolean
         "RecoveryOrgVdcNetworkIdentifier":"String content",
        }
     },
      "NicIdentifier":"String content"
    }
 ],
    "Recovery":{
      "VCD": {
       "StoragePolicyIdentifier": "string content",
       }
    },
    "VmIdentifier": "string content",
    "Volumes":[{
      "IsSwap": Boolean,
      "VCD": {
         "IsThin": Boolean
       },
      "VolumeIdentifier":"String content"
    }]
  },
 ]
  "VpgIdentifier": "String Content",
  "VpgSettingsIdentifier": "String Content"
}
 
Parameter
Description
Basic
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 site where the VPG virtual machines will be protected. This is the site where the API runs.
RecoverySiteIdentifier
The identifier of the 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.
Journal
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
Failover
Information about the networks used for failover.
VCD
IsEnableGuestCustomization
■ True: The computer name and network settings configured for this virtual machine are applied to its Guest OS when the virtual machine is powered on. Use this option to enable re-IPing the recovered virtual machines.
■ False: The computer name and network settings configured for this virtual machine are not applied to its Guest OS when the virtual machine is powered on. Re-IPing is not available.
Note: The same value should be set for both failover and failover test.
DefaultRecoveryOrgVdcNetworkIdentifier
The identifier of the Org vDC network. This is the default recovery settings applied to every virtual machine in the VPG. When OrgVdcIdentifier is set, DefaultRecoveryOrgVdcNetworkIdentifier is set by default. Default value is none or "00000000-0000-0000-0000-000000000000."
FailoverTest
Information about the networks used for failover test.
VCD
IsEnableGuestCustomization
True: The computer name and network settings configured for this virtual
machine are applied to its Guest OS when the virtual machine is powered on. Use this option to enable re-IPing the recovered virtual machines.
False: The computer name and network settings configured for this virtual
machine are not applied to its Guest OS when the virtual machine is powered on. Re-Iping is not available.
Note: The same value should be set for both failover and failover test.
DefaultRecoveryOrgVdcNetworkIdentifier
The identifier of the Org vDC network. This is the default recovery settings applied to every virtual machine in the VPG. When OrgVdcIdentifier is set, DefaultRecoveryOrgVdcNetworkIdentifier is set by default. Default value is none or "00000000-0000-0000-0000-000000000000."
Recovery
VCD
OrgVcdIdentifier
The identifier of an Org vDC.
Vms
Journal
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
Failover
Information about the networks used for failover by this virtual machine.
VCD
IpMode
The IP mode. Possible values are:
■ Static IP Pool - pulls IP addresses from the network's IP pool.
■ Static Manual - allows you to specify an IP address.
■ DHCP - pulls IP addresses from a DHCP server.
IsConnected
True: Is NIC connected
False: Is NIC not connected.
IsPrimary
True: The DNS server that handles Internet protocol mapping is the primary.
False: The DNS server that handles Internet protocol mapping is not the primary.
IsResetMacAddress
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.
RecoveryOrgVdcNetworkIdentifier
The identifier of the Org vDC network. This is the recovery settings applied to the virtual machine When OrgVdcIdentifier is set, RecoveryOrgVdcNetworkIdentifier is set by default. Default value is none or "00000000-0000-0000-0000-000000000000."
FailoverTest
Information about the networks used for failover test by this virtual machine.
VCD
IpMode
The IP mode. Possible values are:
■ Static IP Pool - pulls IP addresses from the network's IP pool.
■ Static Manual - allows you to specify an IP address.
■ DHCP - pulls IP addresses from a DHCP server.
IsConnected
True: Is NIC connected
False: Is NIC not connected.
IsPrimary
True: The DNS server that handles Internet protocol mapping is the primary.
False: The DNS server that handles Internet protocol mapping is not the primary.
IsResetMacAddress
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.
RecoveryOrgVdcNetworkIdentifier
The identifier of the Org vDC network. This is the recovery settings applied to the virtual machine When OrgVdcIdentifier is set, RecoveryOrgVdcNetworkIdentifier is set by default
NicIdentifier
The identifier of the NIC for which settings are returned.
Recovery
VCD
StoragePolicyIdentifier
The identifier of the recovery storage policy. When the VmIdentifier is set, the StoragePolicyIdentifier is set by default. Default value is none or "00000000-0000-0000-0000-000000000000."
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.
VCD
IsThin
True: The recovery volumes are thin-provisioned.
False: The recovery volumes are not thin-provisioned.
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
 
Back to vSphere to vCD VPG Management APIs
Back to All APIs