Ip Pool Manager Query IP Allocations

Query IP allocations by IP pool and extension key.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/IpPoolManager/{moId}/QueryIPAllocations

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case IpPoolManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.

Request Body

QueryIPAllocationsRequestType of type(s) application/json

Required

Show optional properties

{
    "dc": {},
    "poolId": 0,
    "extensionKey": "string"
}

{
    "dc": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "poolId": 0,
    "extensionKey": "string"
}

Required

The datacenter on which to find the pool

Required privileges: Datacenter.IpPoolQueryAllocations

integer As int32 As int32

poolId

Required

The unique ID of the pool

string

extensionKey

Required

The key of the extension

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The resulting list of IpPoolManagerIpAllocation.

[
    {
        "_typeName": "string",
        "ipAddress": "string",
        "allocationId": "string"
    }
]

array of object

Optional

Describes an IP allocation.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"dc":"{}","poolId":"integer","extensionKey":"string"}' https://{api_host}/sdk/vim25/{release}/IpPoolManager/{moId}/QueryIPAllocations

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations

POST

Ip Pool Manager Allocate Ipv4 Address

POST