15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
62 lines
2.6 KiB
ReStructuredText
62 lines
2.6 KiB
ReStructuredText
.. _int: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _CreateIpPool: ../../vim/IpPoolManager.rst#createIpPool
|
|
|
|
.. _vSphere API 4.0: ../../vim/version.rst#vimversionversion5
|
|
|
|
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
|
|
|
|
.. _vim.vApp.IpPool.Association: ../../vim/vApp/IpPool/Association.rst
|
|
|
|
.. _vim.vApp.IpPool.IpPoolConfigInfo: ../../vim/vApp/IpPool/IpPoolConfigInfo.rst
|
|
|
|
|
|
vim.vApp.IpPool
|
|
===============
|
|
Specifications of the network configuration to be used on a network. This is used to generate IP addresses and for self-customization of vApps.
|
|
:extends: vmodl.DynamicData_
|
|
:since: `vSphere API 4.0`_
|
|
|
|
Attributes:
|
|
id (`int`_, optional):
|
|
|
|
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.
|
|
name (`str`_, optional):
|
|
|
|
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.
|
|
ipv4Config (`vim.vApp.IpPool.IpPoolConfigInfo`_, optional):
|
|
|
|
IPv4 configuration.This configuration is always present on the pool. To disable allocation, set the ipPoolEnabled flag of the config to false.
|
|
ipv6Config (`vim.vApp.IpPool.IpPoolConfigInfo`_, optional):
|
|
|
|
IPv6 configuration.This configuration is always present on the pool. To disable allocation, set the ipPoolEnabled flag of the config to false.
|
|
dnsDomain (`str`_, optional):
|
|
|
|
DNS Domain. For example, vmware.com. This can be an empty string if no domain is configured.
|
|
dnsSearchPath (`str`_, optional):
|
|
|
|
DNS Search Path. For example, eng.vmware.com;vmware.com
|
|
hostPrefix (`str`_, optional):
|
|
|
|
Prefix for hostnames.
|
|
httpProxy (`str`_, optional):
|
|
|
|
The HTTP proxy to use on this network, e.g.,:
|
|
networkAssociation (`vim.vApp.IpPool.Association`_, optional):
|
|
|
|
The networks that are associated with this IP pool
|
|
availableIpv4Addresses (`int`_, optional):
|
|
|
|
The number of IPv4 addresses available for allocation.
|
|
availableIpv6Addresses (`int`_, optional):
|
|
|
|
The number of IPv6 addresses available for allocation.
|
|
allocatedIpv4Addresses (`int`_, optional):
|
|
|
|
The number of allocated IPv4 addresses.
|
|
allocatedIpv6Addresses (`int`_, optional):
|
|
|
|
The number of allocated IPv6 addresses.
|