Ip Pool Manager Destroy Ip Pool

Ip Pool Manager Destroy Ip Pool

Destroys an IP pool on the given datacenter.

Looks up the pool on the datacenter by ID and deletes it. If the pool is in use, the method throws InvalidState unless the force flag is true.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/IpPoolManager/{moId}/DestroyIpPool
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.3.0 APIs.

Request Body
DestroyIpPoolRequestType of type(s) application/json
Required

Show optional properties

{
    "dc": {},
    "id": 0,
    "force": false
}
{
    "dc": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "id": 0,
    "force": false
}
MoRefDatacenter
dc
Required

Reference to an instance of the Datacenter managed object.

integer As int32 As int32
id
Required

The unique ID of the pool

boolean
force
Required

If true, the pool will be destroyed even if it is in use

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

InvalidState: if the pool is in use and the force flag is false

Returns InvalidState of type(s) application/json
This response body class contains all of the following: VimFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Virtual Infrastructure Operations
POST
Ip Pool Manager Allocate Ipv4 Address
POST
Ip Pool Manager Allocate Ipv6 Address
POST
Ip Pool Manager Create Ip Pool
POST
Ip Pool Manager Destroy Ip Pool
POST
Ip Pool Manager Query IP Allocations
POST
Ip Pool Manager Query Ip Pools
POST
Ip Pool Manager Release Ip Allocation
POST
Ip Pool Manager Update Ip Pool