Replace Network Settings Vm Replication
This request updates/replaces the network settings of the failover and the test failover for the specified VM replication.
The result of this API call is a task which must be polled by using the respective APIs for task polling. If the task succeeds, then the result can be obtained from the result field. If the task fails, there is no result. The failure reason is in the error field.
Request
URI
PUT
https://{api_host}/vm-replications/{replicationId}/network-settings
COPY
Path Parameters
string
replicationId
Required
Cloud VM-level replication identifier
replicationId example
C4-ec991bd5-af9d-446a-8599-5b693842c4a3
Query Parameters
string
site
Optional
Optional site to run the operation on. When omitted, defaults to the local site.
site example
site1
Header Parameters
string
operationID
Optional
Operation ID for correlating logs across multiple services
Request Body
VmReplicationNetworkSettings of type(s) application/json
Required
{
"failoverSettings": {
"vAppNetworkSettings": {
"bridgeOrgVdcNetworks": [
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
],
"bulkConnectVmNics": true,
"copySourceNetworks": true,
"networkMappings": [
{
"destinationOrgVdcNetwork": {
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
},
"sourceNetworkName": "ext_net_vdc_s1Org",
"sourceOrgVdcNetwork": {
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
}
],
"resolutionType": "EXPLICIT"
},
"vmNetworkSettings": {
"copySourceNicSettings": false,
"nics": [
{
"externalIpAddress": "64.71.222.37",
"ipAddress": "192.0.0.1",
"ipAddressAllocationMode": "string",
"isConnected": false,
"macAddress": "00:0a:95:9d:68:17",
"needsCustomization": true,
"network": "network1",
"networkAdapterType": "VMXNET 3",
"nicIndex": 0,
"resetMacAddress": true,
"resolutionType": "EXPLICIT"
}
],
"primaryNicIndex": 0,
"resolutionType": "EXPLICIT"
}
},
"failoverTestSettings": {
"vAppNetworkSettings": {
"bridgeOrgVdcNetworks": [
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
],
"bulkConnectVmNics": true,
"copySourceNetworks": true,
"networkMappings": [
{
"destinationOrgVdcNetwork": {
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
},
"sourceNetworkName": "ext_net_vdc_s1Org",
"sourceOrgVdcNetwork": {
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
}
],
"resolutionType": "EXPLICIT"
},
"vmNetworkSettings": {
"copySourceNicSettings": false,
"nics": [
{
"externalIpAddress": "64.71.222.37",
"ipAddress": "192.0.0.1",
"ipAddressAllocationMode": "string",
"isConnected": false,
"macAddress": "00:0a:95:9d:68:17",
"needsCustomization": true,
"network": "network1",
"networkAdapterType": "VMXNET 3",
"nicIndex": 0,
"resetMacAddress": true,
"resolutionType": "EXPLICIT"
}
],
"primaryNicIndex": 0,
"resolutionType": "EXPLICIT"
}
}
}
failoverTestSettings
Optional
failoverTestSettings
Responses
202
Accepted
Returns C4ApiTask_of_VmReplicationNetworkSettings of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"endTime": 1499929558827,
"error": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"result": {
"failoverSettings": {
"vAppNetworkSettings": {
"bridgeOrgVdcNetworks": [
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
],
"bulkConnectVmNics": true,
"copySourceNetworks": true,
"networkMappings": [
{
"destinationOrgVdcNetwork": {
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
},
"sourceNetworkName": "ext_net_vdc_s1Org",
"sourceOrgVdcNetwork": {
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
}
],
"resolutionType": "EXPLICIT"
},
"vmNetworkSettings": {
"copySourceNicSettings": false,
"nics": [
{
"externalIpAddress": "64.71.222.37",
"ipAddress": "192.0.0.1",
"ipAddressAllocationMode": "string",
"isConnected": false,
"macAddress": "00:0a:95:9d:68:17",
"needsCustomization": true,
"network": "network1",
"networkAdapterType": "VMXNET 3",
"nicIndex": 0,
"resetMacAddress": true,
"resolutionType": "EXPLICIT"
}
],
"primaryNicIndex": 0,
"resolutionType": "EXPLICIT"
}
},
"failoverTestSettings": {
"vAppNetworkSettings": {
"bridgeOrgVdcNetworks": [
{
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
],
"bulkConnectVmNics": true,
"copySourceNetworks": true,
"networkMappings": [
{
"destinationOrgVdcNetwork": {
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
},
"sourceNetworkName": "ext_net_vdc_s1Org",
"sourceOrgVdcNetwork": {
"id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
"name": "network1"
}
}
],
"resolutionType": "EXPLICIT"
},
"vmNetworkSettings": {
"copySourceNicSettings": false,
"nics": [
{
"externalIpAddress": "64.71.222.37",
"ipAddress": "192.0.0.1",
"ipAddressAllocationMode": "string",
"isConnected": false,
"macAddress": "00:0a:95:9d:68:17",
"needsCustomization": true,
"network": "network1",
"networkAdapterType": "VMXNET 3",
"nicIndex": 0,
"resetMacAddress": true,
"resolutionType": "EXPLICIT"
}
],
"primaryNicIndex": 0,
"resolutionType": "EXPLICIT"
}
}
},
"resultType": "string",
"site": "site2",
"startTime": 1499929548951,
"state": "string",
"user": "root",
"warnings": [],
"workflowInfo": {}
}integer As int64 As int64
endTime
Optional
Timestamp in msec of the completion time of the task. -1 indicates that the task did not complete yet.
string As uuid As uuid
id
Optional
The unique identifier of the long-running task. It is unique and can be used for monitoring.
integer As int64 As int64
lastUpdated
Optional
Timestamp in msec of the last task status update.
integer As int32 As int32
progress
Optional
Percentage-based progress of the task.
string
resultType
Optional
Indicates the type of the task result. Populates only when the execution succeeds.
string
site
Optional
Site on which the task runs.
integer As int64 As int64
startTime
Optional
Timestamp in msec of the creation time of the task.
string
user
Optional
The user who started the task.
401
The returned error codes include (but are not limited to): NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
500
The returned error codes include (but are not limited to): GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
On This Page
Vm Replications Operations
POST
Apply Storage Profile Vm Replication
PATCH
Chown Vm Replication
DELETE
Cleanup Failover Test Vm Replication
GET
Disk Samples Vm Replication
POST
Failover Test Vm Replication
POST
Failover Vm Replication
GET
Get Effective Guest Customization Vm Replication
GET
Get Network Settings Vm Replication
GET
Get Virtual Hardware
GET
Get Vm Replication
GET
Instance Vm Replication
GET
Instances Vm Replication
POST
Migrate Vm Replication
POST
Pause Vm Replication
PATCH
Reconfigure Disks Vm Replication
PATCH
Reconfigure Vm Replication
PUT
Replace Guest Customization Vm Replication
PUT
Replace Network Settings Vm Replication
POST
Resume Vm Replication
POST
Reverse Vm Replication
POST
Start Vm Replication
DELETE
Stop Vm Replication
POST
Sync Vm Replication
GET
Traffic Samples Vm Replication
GET
Vm Replications