Get Allocated Ip Addresses

Get Allocated Ip Addresses

Get all the allocated IPs for a given Org vDC network. This returns all the IP addresses of network which are allocated to a vApp VM, an edge gateway interface and the addresses being used in a NAT routed environment. In a dual stack network, this will return the IP addresses of the first subnet, which will only be IPv4 addresses. Results can be filtered by IP address.

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

vdcNetworkId

string
vdcNetworkId
Required

vdcNetworkId

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 AllocatedIpAddresses of type(s) application/json;version=38.1
This response body class contains all of the following: Page , InlineAllocatedIpAddresses1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "entityId": "string",
            "entityName": "string",
            "vAppName": "string",
            "ipAddress": "string",
            "deployed": false,
            "allocationTypeValue": "string",
            "networkRef": {
                "name": "string",
                "id": "string"
            },
            "orgRef": {
                "name": "string",
                "id": "string"
            }
        }
    ]
}

404

The specified resource was not found

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

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 32.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