Get Orgs.sddcs.networks.edges.vnics

Retrieve all interfaces for the specified management or compute gateway (NSX Edge).

Request

URI

GET

https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/networks/4.0/edges/{edgeId}/vnics

COPY

Path Parameters

string

org

Required

Organization identifier.

string

sddc

Required

Sddc Identifier.

string

edgeId

Required

Edge Identifier.

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

Returns vnics of type(s) application/json

{
    "vnics": [
        {
            "subInterfaces": {
                "subInterfaces": [
                    {
                        "index": 0,
                        "tunnelId": 0,
                        "name": "string",
                        "addressGroups": {
                            "addressGroups": [
                                {
                                    "subnetPrefixLength": "string",
                                    "secondaryAddresses": {
                                        "type": "string",
                                        "ipAddress": [
                                            "string"
                                        ]
                                    },
                                    "primaryAddress": "string",
                                    "subnetMask": "string"
                                }
                            ]
                        },
                        "vlanId": 0,
                        "label": "string",
                        "logicalSwitchName": "string",
                        "isConnected": false,
                        "mtu": 0,
                        "logicalSwitchId": "string",
                        "enableSendRedirects": false
                    }
                ]
            },
            "addressGroups": {
                "addressGroups": [
                    {
                        "subnetPrefixLength": "string",
                        "secondaryAddresses": {
                            "type": "string",
                            "ipAddress": [
                                "string"
                            ]
                        },
                        "primaryAddress": "string",
                        "subnetMask": "string"
                    }
                ]
            },
            "isConnected": false,
            "enableSendRedirects": false,
            "inShapingPolicy": {
                "burstSize": 0,
                "averageBandwidth": 0,
                "peakBandwidth": 0,
                "enabled": false,
                "inherited": false
            },
            "label": "string",
            "enableProxyArp": false,
            "index": 0,
            "name": "string",
            "mtu": 0,
            "fenceParameters": [
                {
                    "value": "string",
                    "key": "string"
                }
            ],
            "macAddresses": [
                {
                    "edgeVmHaIndex": 0,
                    "value": "string"
                }
            ],
            "outShapingPolicy": {
                "burstSize": 0,
                "averageBandwidth": 0,
                "peakBandwidth": 0,
                "enabled": false,
                "inherited": false
            },
            "portgroupName": "string",
            "enableBridgeMode": false,
            "type": "string",
            "portgroupId": "string"
        }
    ]
}

array of vnic

vnics

Optional

Ordered list of NSX Edge vnics.

400

Bad request. Request object passed is invalid.

Operation doesn't return any data structure

403

Forbidden. Authorization header not provided

Operation doesn't return any data structure

404

Not found. Requested object not found.