Ip Pool Manager Create Ip Pool

Create a new IP pool.

The name field must be defined, all other fields are optional. If unset, they will be given default values.

The ID for the pool is generated by the server and should not be defined on the pool object passed to this method.

Request

URI

POST

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

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

CreateIpPoolRequestType of type(s) application/json

Required

{
    "dc": {
        "type": "string",
        "value": "string"
    },
    "pool": {
        "id": 0,
        "name": "string",
        "ipv4Config": {
            "subnetAddress": "string",
            "netmask": "string",
            "gateway": "string",
            "range": "string",
            "dns": [
                "string"
            ],
            "dhcpServerAvailable": false,
            "ipPoolEnabled": false
        },
        "ipv6Config": {
            "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": {
                    "type": "string",
                    "value": "string"
                },
                "networkName": "string"
            }
        ],
        "availableIpv4Addresses": 0,
        "availableIpv6Addresses": 0,
        "allocatedIpv4Addresses": 0,
        "allocatedIpv6Addresses": 0
    }
}

MoRefDatacenter

Required

Reference to an instance of the Datacenter managed object.

IpPool

pool

Required

Specifications of the network configuration to be used on a network.

This is used to generate IP addresses and for self-customization of vApps.

Authentication

This operation uses the following authentication methods.

Session

Responses