Get Manual Ip Reservations For Network

Get Manual Ip Reservations For Network

Retrieves all Manual IP Reservations. "networkRef.id" filter is required. Based on the specified networkRef filter, VCD will return all the Manual IP Reservations for the network. Filter examples:(filter=networkRef.id==URN)

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/manualIpReservations
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
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NetworkManualIpReservations of type(s) application/json;version=39.1
This response body class contains all of the following: InlineNetworkManualIpReservations0 , InlineNetworkManualIpReservations1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "status": "string",
            "id": "urn:vcloud:networkManualIpReservation:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "name": "string",
            "description": "string",
            "networkRef": {
                "name": "string",
                "id": "string"
            },
            "ipAddresses": "string",
            "ipQuantity": 0,
            "subnet": "string",
            "expirationType": "string",
            "expirationDate": "string",
            "expirationVAppRef": {
                "name": "string",
                "id": "string"
            },
            "expirationVAppVdcRef": {
                "name": "string",
                "id": "string"
            },
            "allowIpUsageByServiceOrVm": false,
            "removeIpAfterUsage": false,
            "createdBy": "string",
            "updatedBy": "string",
            "orgRef": {
                "name": "string",
                "id": "string"
            },
            "creationDate": "string"
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/manualIpReservations?page=value&pageSize=v
Availability
Added in 39.0
On This Page
Network Manual Ip Reservations Operations
GET
Get Manual Ip Reservations For Network
POST
Create Manual Ip Reservation
GET
Get Manual Ip Reservation
PUT
Update Manual Ip Reservation
DELETE
Delete Manual Ip Reservation
POST
Sync Manual Ip Reservations For Vdc Network