Ip Pool Manager Allocate Ipv4 Address

Allocates an IPv4 address from an IP pool.

Allocated IP addresses are reserved in the IP pool until released by calling ReleaseIpAllocation, or until the IP pool is configured to have an IP range that does not contain the IP address, or until the IP pool is destroyed.

The caller must be a vCenter extension. Refer to ExtensionManager for details on vCenter extensions.

The caller specifies a per extension unique allocation ID. Calling this function twice with the same allocation ID for the same pool yields the same IP address. This makes it possible to do idempotent allocations.

Request

URI

POST

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

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

AllocateIpv4AddressRequestType of type(s) application/json

Required

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

MoRefDatacenter

Required

Reference to an instance of the Datacenter managed object.

integer As int32 As int32

poolId

Required

The unique ID of the pool

string

allocationId

Required

The unique ID for this allocation

Authentication