Zerto Virtual Replication APIs : VRAs API : VRAs: PUT
  
VRAs: PUT
Enables editing a specific VRA.
URL
Edit VRA
https://zvm_ip:port/v1/vras/{vraIdentifier}
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.
vraIdentifier
The identifier of the VRA to be edited.
Json Request Format
The following is an example request Json body for https://zvm_ip:port/v1/vras.
{
  "GroupName": "String content",
  "HostRootPassword": "String content",
  "UsePublicKeyInsteadOfCredentials": Boolean,
  "VraNetworkDataApi": {
    "DefaultGateway": "String content",
    "SubnetMask": "String content",
    "VraIPAddress": "String content",
    "VraIPConfigurationTypeApi": "String content"
  }
}
XML Request Format
For the XML request format, see “VRAs API PUT Method Request and Response Formats”, on page 268.
Request Values
Request values for https://zvm_ip:port/v1/vras
Parameter
Description
mandatory
 
GroupName
The group the VRA belongs to, used when VRAs use different networks so they can be grouped by network, for example when the same vCenter Server supports two datacenters with separate networks and you are replicating from one datacenter to the second datacenter. If you want to create a new VRA group, enter the name of the new group.
No
 
HostRootPassword
vSphere environments: The password used to access the host for the root user. This field is only required for VMware ESXi 4.x and 5.x hosts. A value is required if UsePublicKeyInsteadOfCredentials is set to false.
 
 
UsePublicKeyInsteadOfCredentials
vSphere environments: Optional. The default is true.
True: A password is not needed to access the host. From ESXi 5.5, by default, Zerto Virtual Manager uses a vSphere Installation Bundle, VIB, to connect to the host, which does not require a password.
False: A password is needed to access the host. For ESX/i versions earlier than 5.5, this parameter must be set to false and a value specified for HostRootPassword.
 
 
VraNetworkDataApi
The VRA network details.
No
 
DefaultGateway
The default gateway for the VRA network when VraIPConfigurationTypeApi is set to Static.
No
 
SubnetMask
The subnet mask for the VRA network when VraIPConfigurationTypeApi is set to Static.
No
 
VraIPAddress
The IP address for the VRA when VraIPConfigurationTypeApi is set to Static.
No
 
VraIPConfigurationTypeApi
The IP configuration used for the VRA. Possible values are:
Dhcp: The VRA IP address is allocated via a DHCP server.
Static: The VRA is installed with a static IP that was assigned when the VRA was installed.
No
 
Note: If a value is not specified in the request, a null value is used. Nulls are specified in Json as null, all lowercase.
Json Response Format
The following is an example response Json body for https://zvm_ip:port/v1/vras/{vraIdentifier}.
{
  "TaskIdentifier": "String content"
}
XML Response Format
For the XML response format, see “VRAs API PUT Method Request and Response Formats”, on page 268.
Response Values
Parameter
Description
TaskIdentifier
The identifier of the task. The task identifier can be used with the Tasks API to monitor the delete action.