Ip Pool Manager Query Ip Pools

Return the list of IP pools for a datacenter.

Request

URI

POST

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

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 8.0.2.0 APIs.

Request Body

QueryIpPoolsRequestType of type(s) application/json

Required

{
    "dc": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

MoRefDatacenter

Required

Reference to an instance of the Datacenter managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The resulting list of pools.

Returns Array of IpPool of type(s) application/json

[
    {
        "_typeName": "string",
        "id": 0,
        "name": "string",
        "ipv4Config": {
            "_typeName": "string",
            "subnetAddress": "string",
            "netmask": "string",
            "gateway": "string",
            "range": "string",
            "dns": [
                "string"
            ],
            "dhcpServerAvailable": false,
            "ipPoolEnabled": false
        },
        "ipv6Config": {
            "_typeName": "string",
            "subnetAddress": "string",
            "netmask": "string",
            "gateway": "string",
            "range": "string",
            "dns": [
                "string"
            ],
            "dhcpServerAvailable": false,
            "ipPoolEnabled": false
        },
        "dnsDomain": "string",
        "dnsSearchPath": "string",
        "hostPrefix": "string",
        "httpProxy": "string",
        "networkAssociation": [
            {
                "_typeName": "string",
                "network": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "networkName": "string"
            }
        ],
        "availableIpv4Addresses": 0,
        "availableIpv6Addresses": 0,
        "allocatedIpv4Addresses": 0,
        "allocatedIpv6Addresses": 0
    }
]

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Ip Pool Manager Operations

POST

Ip Pool Manager Allocate Ipv4 Address

POST