Managed Object - IpPoolManager

Property of
ServiceContent
See also
Datacenter, IpPool, IpPoolManagerIpAllocation
Since
vSphere API 4.0


Managed Object Description

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
AllocateIpv4Address, AllocateIpv6Address, CreateIpPool, DestroyIpPool, QueryIPAllocations, QueryIpPools, ReleaseIpAllocation, UpdateIpPool

AllocateIpv4Address

Required Privileges
None
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IpPoolManager used to make the method call.
dc PManagedObjectReference
to a Datacenter

Since vSphere API 5.1
poolId Pxsd:int

Since vSphere API 5.1
allocationId Pxsd:string

Since vSphere API 5.1
PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



AllocateIpv6Address

Required Privileges
None
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IpPoolManager used to make the method call.
dc PManagedObjectReference
to a Datacenter

Since vSphere API 5.1
poolId Pxsd:int

Since vSphere API 5.1
allocationId Pxsd:string

Since vSphere API 5.1
PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CreateIpPool

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IpPoolManager used to make the method call.
dc PManagedObjectReference
to a Datacenter

Since vSphere API 4.0
pool PIpPool

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:int

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



DestroyIpPool

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IpPoolManager used to make the method call.
dc PManagedObjectReference
to a Datacenter

Since vSphere API 4.0
id Pxsd:int

Since vSphere API 4.0
force Pxsd:boolean

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryIPAllocations

Required Privileges
None
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IpPoolManager used to make the method call.
dc PManagedObjectReference
to a Datacenter

Since vSphere API 5.1
poolId Pxsd:int

Since vSphere API 5.1
extensionKey Pxsd:string

Since vSphere API 5.1
PRequired privilege - see tooltip for details

Return Value

Type Description
IpPoolManagerIpAllocation[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryIpPools

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IpPoolManager used to make the method call.
dc PManagedObjectReference
to a Datacenter

Since vSphere API 4.0
P Required privilege: dc

Return Value

Type Description
IpPool[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ReleaseIpAllocation

Required Privileges
None
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IpPoolManager used to make the method call.
dc PManagedObjectReference
to a Datacenter

Since vSphere API 5.1
poolId Pxsd:int

Since vSphere API 5.1
allocationId Pxsd:string

Since vSphere API 5.1
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



UpdateIpPool

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IpPoolManager used to make the method call.
dc PManagedObjectReference
to a Datacenter

Since vSphere API 4.0
pool PIpPool

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None