openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
15f7be9a526d209fb7f0940cbf6b8e7cc481c0dd
deb-python-pyvmomi/docs/vim/vApp/IpPool/IpPoolConfigInfo.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
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
2014-06-17 14:07:42 -04:00

1.9 KiB
Raw Blame History

vim.vApp.IpPool.IpPoolConfigInfo

Specifications of either IPv4 or IPv6 configuration to be used on this network. This is a part of network configuration.IPv4 addresses are in dot-decimal notation, e.g.: 192.0.2.235IPv6 addresses are in colon-hexadecimal notation, e.g.: 2001:0db8:85a3::0370:7334

extends

vmodl.DynamicData

since

vSphere API 4.0

Attributes:

subnetAddress (str, optional):

Address of the subnet.For example:
  • IPv4: 192.168.5.0
  • IPv6: 2001:0db8:85a3:

netmask (str, optional):

NetmaskFor example:
  • IPv4: 255.255.255.0
  • IPv6: ffff:ffff:ffff:

gateway (str, optional):

Gateway. This can be an empty string - if no gateway is configured.Examples:
  • IPv4: 192.168.5.1
  • IPv6: 2001:0db8:85a3::1

range (str, optional):

IP range. This is specified as a set of ranges separated with commas. One range is given by a start address, a hash (#), and the length of the range.For example:
  • 192.0.2.235 # 20 is the IPv4 range from 192.0.2.235 to 192.0.2.254
  • 2001::7334 # 20 is the IPv6 range from 2001::7334 to 2001::7347

dns (str, optional):

DNS serversFor example:
  • IPv4: ["10.20.0.1", "10.20.0.2"]
  • IPv6: ["2001:0db8:85a3::0370:7334", "2001:0db8:85a3::0370:7335"]If an empty list is passed, the existing value remains unchanged. To clear this list, pass an array containing the empty string as it's only element.

dhcpServerAvailable (bool, optional):

Whether a DHCP server is available on this network.

ipPoolEnabled (bool, optional):

IP addresses can only be allocated from the range if the IP pool is enabled.