Get Org Vdc Network

Get Org Vdc Network

Retrieves a specific Org vDC network.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/orgVdcNetworks/{vdcNetworkId}
COPY
Path Parameters
string
vdcNetworkId
Required

vdcNetworkId

string
vdcNetworkId
Required

vdcNetworkId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VdcNetwork of type(s) application/json;version=36.3
This response body class contains all of the following: Network , InlineVdcNetwork1 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "subnets": {
        "values": [
            {
                "gateway": "string",
                "prefixLength": 0,
                "dnsSuffix": "string",
                "dnsServer1": "string",
                "dnsServer2": "string",
                "ipRanges": {
                    "values": [
                        {
                            "startAddress": "string",
                            "endAddress": "string"
                        }
                    ]
                },
                "enabled": false,
                "totalIpCount": 0,
                "usedIpCount": 0
            }
        ]
    },
    "backingNetworkId": "string",
    "parentNetworkId": {
        "name": "string",
        "id": "string"
    },
    "orgVdc": {
        "name": "string",
        "id": "string"
    },
    "ownerRef": {
        "name": "string",
        "id": "string"
    },
    "orgVdcIsNsxTBacked": false,
    "orgRef": {
        "name": "string",
        "id": "string"
    },
    "connection": {
        "routerRef": {
            "name": "string",
            "id": "string"
        },
        "connectionTypeValue": "string",
        "connected": false
    },
    "isDefaultNetwork": false,
    "shared": false,
    "enableDualSubnetNetwork": false,
    "lastTaskFailureMessage": "string",
    "guestVlanTaggingAllowed": false,
    "retainNicResources": false,
    "crossVdcNetworkId": "string",
    "crossVdcNetworkLocationId": "string",
    "overlayId": 0,
    "totalIpCount": 0,
    "usedIpCount": 0,
    "routeAdvertised": false,
    "securityGroups": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "segmentProfileTemplateRef": {
        "name": "string",
        "id": "string"
    }
}

404

The specified resource was not found

Returns Error of type(s) application/json;version=36.3 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 31.0
On This Page
Org Vdc Network Operations
DELETE
Delete Network
GET
Get Additional Properties
GET
Get Allocated Ip Addresses
GET
Get Network Segment Profiles
GET
Get Org Vdc Network
GET
Get Secondary Allocated Ip Addresses
POST
Reset Network
POST
Sync Org Vdc Network
POST
Sync Syslog Settings Of Network
PUT
Update Network
PUT
Update Network Segment Profiles