Get Network Settings Vm Replication

This request returns the network settings of the failover and the test failover for the specified VM replication.

Request

URI

GET

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

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns VmReplicationNetworkSettings of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8

{
    "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"
                    }
                }
            ]
        },
        "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
                }
            ],
            "primaryNicIndex": 0
        }
    },
    "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"
                    }
                }
            ]
        },
        "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
                }
            ],
            "primaryNicIndex": 0
        }
    }
}

VmReplicationNetworkSettings_FailoverNetworkSettings

failoverSettings

Optional

failoverSettings

VmReplicationNetworkSettings_FailoverNetworkSettings

failoverTestSettings

Optional

failoverTestSettings

401

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

Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+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.5+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.