Managed Object - IpPoolManager

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

Managed Object Description

Singleton Managed Object used to manage IP Pools.

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

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
CreateIpPool, DestroyIpPool, QueryIpPools, UpdateIpPool

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.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the IpPoolManager used to make the method call.
dc P	ManagedObjectReference to a Datacenter	The datacenter on which to create the pool.
pool	IpPool	The IP pool to create on the server

P Required privilege: Datacenter.IpPoolConfig

Return Value

Type	Description
xsd:int	The generated ID for the pool

Faults

Type	Description
InvalidArgument	Thrown if the name of the pool already exists on the datacenter.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateIpPool" type="vim25:CreateIpPoolRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateIpPoolResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:int"/>
               </sequence>
            </complexType>
         </element>

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.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the IpPoolManager used to make the method call.
dc P	ManagedObjectReference to a Datacenter	The datacenter on which to find the pool
id	xsd:int	The unique ID of the pool
force	xsd:boolean	If true, the pool will be destroyed even if it is in use

P Required privilege: Datacenter.IpPoolConfig

Return Value

Type	Description
None

Faults

Type	Description
InvalidState	Thrown if the pool is in use and the force flag is false
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DestroyIpPool" type="vim25:DestroyIpPoolRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DestroyIpPoolResponse">
            <complexType/>
         </element>

QueryIpPools

Return the list of IP pools for a datacenter.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the IpPoolManager used to make the method call.
dc P	ManagedObjectReference to a Datacenter	The datacenter for which to look up the IP pools.

P Required privilege: System.Read

Return Value

Type	Description
IpPool[]	The resulting list of pools.

Faults

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryIpPools" type="vim25:QueryIpPoolsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryIpPoolsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:IpPool" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the IpPoolManager used to make the method call.
dc P	ManagedObjectReference to a Datacenter	The datacenter on which to look up the pool.
pool	IpPool	The IP pool to update on the server

P Required privilege: Datacenter.IpPoolConfig

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if the name of the pool already exists on the datacenter.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateIpPool" type="vim25:UpdateIpPoolRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateIpPoolResponse">
            <complexType/>
         </element>