Get Network Settings

Get Network Settings

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

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

Cloud vApp-level replication identifier

replicationId example 
C4VAPP-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.
Responses
200

OK

Returns VAppReplicationNetworkSettings of type(s) application/vnd.vmware.h4-v4.7+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"
                    }
                }
            ],
            "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"
        }
    }
}
VAppReplicationNetworkSettings_FailoverNetworkSettings
failoverSettings
Optional

failoverSettings

VAppReplicationNetworkSettings_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.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
Vapp Replications Operations
POST
Apply Storage Profile
PATCH
Chown
DELETE
Cleanup Failover Test
POST
Failover
POST
Failover Test
GET
Get Effective Guest Customization Settings
GET
Get Network Settings
POST
Migrate
POST
Pause
PATCH
Reconfigure
PATCH
Reconfigure Disks
PUT
Replace Guest Customization Settings
PUT
Replace Network Settings
GET
Replication
GET
Replications
POST
Resume
POST
Reverse
POST
Start
DELETE
Stop
POST
Sync