Get All Vdc Networks

Get All Vdc Networks

Get all Org vDC networks. If "ownerRef" property is not specified in the filter, then user must have the rights to view all the vDCs within an organization in order to see all the networks in the organization. Results can be filtered by ownerRef or combination of ownerRef and _context. (_context==includeAccessible) can be used to get all the networks which are available to an Org vDC. In order to return only those networks which are eligible as an uplink to a vApp network, add an additional filter, (vAppUplinkEligible==true). This filter must be used in conjunction with either the "orgVdc.id" filter, or the "ownerRef.id" filter with a value corresponding to an Org vDC.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/orgVdcNetworks
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VdcNetworks of type(s) application/json;version=37.1
This response body class contains all of the following: Page , InlineVdcNetworks1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "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"
            }
        }
    ]
}

Availability
Added in 31.0
On This Page
Org Vdc Networks Operations
POST
Create Network
GET
Get All Vdc Networks