Update Network Settings

Update Network Settings

This request updates the network settings of the failover and test failover for the specified vApp replication.

Request
URI
PATCH
https://{api_host}//vapp-replications/{replicationId}/network-settings
COPY
Path Parameters
string
replicationId
Required

The vApp Replication unique identifier

replicationId example 
C4VAPP-d38b426f-dbfa-4ab7-851d-a538c23bd268
Query Parameters
string
site
Optional

site

Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body
VAppReplicationNetworkSettings of type(s) application/json
Optional 
{
    "failoverSettings": {
        "vAppNetworkSettings": {
            "bridgeOrgVdcNetworks": [
                {
                    "id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
                    "name": "network1"
                }
            ],
            "bulkConnectVmNics": true,
            "copySourceNetworks": false,
            "networkMappings": [
                {
                    "destinationOrgVdcNetwork": {
                        "id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
                        "name": "network1"
                    },
                    "sourceNetworkName": "string",
                    "sourceOrgVdcNetwork": {
                        "id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
                        "name": "network1"
                    }
                }
            ]
        },
        "vmNetworkSettings": {
            "computerName": "testpc",
            "copySourceNicSettings": false,
            "enableGuestCustomization": false,
            "nics": [
                {
                    "externalIpAddress": "64.71.222.37",
                    "ipAddress": "192.0.0.1",
                    "ipAddressAllocationMode": "DHCP",
                    "isConnected": false,
                    "macAddress": "00:0a:95:9d:68:17",
                    "needsCustomization": true,
                    "network": "network1",
                    "networkAdapterType": "VMXNET 3",
                    "nicIndex": 0,
                    "resetMacAddress": true
                }
            ],
            "primaryNicIndex": 0
        }
    },
    "failoverTestSettings": {
        "vAppNetworkSettings": {
            "bridgeOrgVdcNetworks": [
                {
                    "id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
                    "name": "network1"
                }
            ],
            "bulkConnectVmNics": true,
            "copySourceNetworks": false,
            "networkMappings": [
                {
                    "destinationOrgVdcNetwork": {
                        "id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
                        "name": "network1"
                    },
                    "sourceNetworkName": "string",
                    "sourceOrgVdcNetwork": {
                        "id": "3d2fe641-28a4-40b4-9b5b-1c0e00ecd92d",
                        "name": "network1"
                    }
                }
            ]
        },
        "vmNetworkSettings": {
            "computerName": "testpc",
            "copySourceNicSettings": false,
            "enableGuestCustomization": false,
            "nics": [
                {
                    "externalIpAddress": "64.71.222.37",
                    "ipAddress": "192.0.0.1",
                    "ipAddressAllocationMode": "DHCP",
                    "isConnected": false,
                    "macAddress": "00:0a:95:9d:68:17",
                    "needsCustomization": true,
                    "network": "network1",
                    "networkAdapterType": "VMXNET 3",
                    "nicIndex": 0,
                    "resetMacAddress": true
                }
            ],
            "primaryNicIndex": 0
        }
    }
}
FailoverNetworkSettings
failoverSettings
Optional

failoverSettings

FailoverNetworkSettings
failoverTestSettings
Optional

failoverTestSettings

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

401

The returned error codes include (but are not limited to):

  • NotAuthenticated
Returns ApiError of type(s) application/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/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
Vapp Replications Operations
POST
Apply Storage Profile
PATCH
Chown
DELETE
Cleanup Failover Test
POST
Failover
POST
Failover Test
GET
Get Network Settings
POST
Migrate
POST
Pause
PATCH
Reconfigure
PATCH
Reconfigure Disks
PUT
Replace Network Settings
GET
Replication
GET
Replications
POST
Resume
POST
Reverse
POST
Start
DELETE
Stop
POST
Sync
PATCH
Update Network Settings