# Data Object - IpPool(vim.vApp.IpPool)

Parameter to
  CreateIpPool, UpdateIpPool
Returned by
  QueryIpPools
Extends
  DynamicData
See also
  IpPoolAssociation, IpPoolIpPoolConfigInfo
Since
  vSphere API 4.0

## Data Object Description

Specifications of the network configuration to be used on a network. This is used to generate IP addresses and for self-customization of vApps.

Properties

Name | Type | Description
--- | --- | ---
allocatedIpv4Addresses* | xsd:int | The number of allocated IPv4 addresses. Since vSphere API 5.1
allocatedIpv6Addresses* | xsd:int | The number of allocated IPv6 addresses. Since vSphere API 5.1
availableIpv4Addresses* | xsd:int | The number of IPv4 addresses available for allocation. Since vSphere API 5.1
availableIpv6Addresses* | xsd:int | The number of IPv6 addresses available for allocation. Since vSphere API 5.1
dnsDomain* | xsd:string | DNS Domain. For example, vmware.com. This can be an empty string if no domain is configured.
dnsSearchPath* | xsd:string | DNS Search Path. For example, eng.vmware.com;vmware.com
hostPrefix* | xsd:string | Prefix for hostnames.
httpProxy* | xsd:string | The HTTP proxy to use on this network, e.g., <host>:<port>
id* | xsd:int | Unique ID, generated by the server. This is used to identify the pool in subsequent lookups or updates. The generated value is also returned by the CreateIpPool method.
ipv4Config* | IpPoolIpPoolConfigInfo | IPv4 configuration. This configuration is always present on the pool. To disable allocation, set the ipPoolEnabled flag of the config to false.
ipv6Config* | IpPoolIpPoolConfigInfo | IPv6 configuration. This configuration is always present on the pool. To disable allocation, set the ipPoolEnabled flag of the config to false.
name* | xsd:string | Pool name. The pool name must be unique within the datacenter. Any / (slash), \ (backslash), character used in this name element is escaped. Similarly, any % (percent) character used in this name element is escaped, unless it is used to start an escape sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or %5c, and a percent is escaped as %25.
networkAssociation* | IpPoolAssociation[] | The networks that are associated with this IP pool
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="IpPool"> <complexContent> <extension base="pbm:DynamicData"> <sequence> <element name="id" type="xsd:int" minOccurs="0"/> <element name="name" type="xsd:string" minOccurs="0"/> <element name="ipv4Config" type="pbm:IpPoolIpPoolConfigInfo" minOccurs="0"/> <element name="ipv6Config" type="pbm:IpPoolIpPoolConfigInfo" minOccurs="0"/> <element name="dnsDomain" type="xsd:string" minOccurs="0"/> <element name="dnsSearchPath" type="xsd:string" minOccurs="0"/> <element name="hostPrefix" type="xsd:string" minOccurs="0"/> <element name="httpProxy" type="xsd:string" minOccurs="0"/> <element name="networkAssociation" type="pbm:IpPoolAssociation" minOccurs="0" maxOccurs="unbounded"/> <element name="availableIpv4Addresses" type="xsd:int" minOccurs="0"/> <element name="availableIpv6Addresses" type="xsd:int" minOccurs="0"/> <element name="allocatedIpv4Addresses" type="xsd:int" minOccurs="0"/> <element name="allocatedIpv6Addresses" type="xsd:int" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>