Scripting Object - VcIpPoolManager

Scripting-object corresponding to
IpPoolManager
Attribute of
VcSdkConnection, VcServiceContent

Scripting Object Description

Singleton Managed Object used to manage IP Pools.

IP Pools are used to allocate IPv4 and IPv6 addresses to vApps.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, allocateIpv4Address, allocateIpv6Address, createIpPool, createTrigger, destroyIpPool, queryIPAllocations, queryIpPools, releaseIpAllocation, updateIpPool

destroyIpPool

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. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcDatacenter

arg1Number

arg2Boolean


Return Value

Type Description
None

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

createIpPool

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. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcDatacenter

arg1VcIpPool


Return Value

Type Description
Number

queryIpPools

Return the list of IP pools for a datacenter. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcDatacenter


Return Value

Type Description
VcIpPool []

queryIPAllocations

Query IP allocations by IP pool and extension key. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcDatacenter

arg1Number

arg2String


Return Value

Type Description
VcIpPoolManagerIpAllocation []

releaseIpAllocation

Releases an IP allocation back to it's IP pool.

Attempting to release an IP allocation that is not allocated from the specified IP pool with the specified allocation ID silently fails. This makes it possible to release IP allocations idempotently.

All IP addresses allocated by an extension are automatically released if the extension is unregistered from vCenter. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcDatacenter

arg1Number

arg2String


Return Value

Type Description
None

allocateIpv6Address

Allocates an IPv6 address from an IP pool.

Allocated IP addresses are reserved in the IP pool until released by calling {@link #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 {@link 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. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcDatacenter

arg1Number

arg2String


Return Value

Type Description
String

allocateIpv4Address

Allocates an IPv4 address from an IP pool.

Allocated IP addresses are reserved in the IP pool until released by calling {@link #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 {@link 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. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcDatacenter

arg1Number

arg2String


Return Value

Type Description
String

updateIpPool

Update an IP pool on a datacenter.

The pool to update is looked up from the value of the id field.

All fields in the pool except the id are optional. Only defined values are stored on the server. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcDatacenter

arg1VcIpPool


Return Value

Type Description
None