IpPool

IpPool
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.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "id": 0,
    "name": "string",
    "ipv4Config": {
        "_typeName": "string",
        "subnetAddress": "string",
        "netmask": "string",
        "gateway": "string",
        "range": "string",
        "dns": [
            "string"
        ],
        "dhcpServerAvailable": false,
        "ipPoolEnabled": false
    },
    "ipv6Config": {
        "_typeName": "string",
        "subnetAddress": "string",
        "netmask": "string",
        "gateway": "string",
        "range": "string",
        "dns": [
            "string"
        ],
        "dhcpServerAvailable": false,
        "ipPoolEnabled": false
    },
    "dnsDomain": "string",
    "dnsSearchPath": "string",
    "hostPrefix": "string",
    "httpProxy": "string",
    "networkAssociation": [
        {
            "_typeName": "string",
            "network": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "networkName": "string"
        }
    ],
    "availableIpv4Addresses": 0,
    "availableIpv6Addresses": 0,
    "allocatedIpv4Addresses": 0,
    "allocatedIpv6Addresses": 0
}
integer As int32 As int32
id
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 IpPoolManager.CreateIpPool method.

string
name
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.

IpPoolIpPoolConfigInfo
ipv4Config
Optional

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.235

IPv6 addresses are in colon-hexadecimal notation, e.g.: 2001:0db8:85a3::0370:7334

IpPoolIpPoolConfigInfo
ipv6Config
Optional

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.235

IPv6 addresses are in colon-hexadecimal notation, e.g.: 2001:0db8:85a3::0370:7334

string
dnsDomain
Optional

DNS Domain.

For example, vmware.com. This can be an empty string if no domain is configured.

string
dnsSearchPath
Optional

DNS Search Path.

For example, eng.vmware.com;vmware.com

string
hostPrefix
Optional

Prefix for hostnames.

string
httpProxy
Optional

The HTTP proxy to use on this network, e.g., <host>:<port>

array of IpPoolAssociation
networkAssociation
Optional

The networks that are associated with this IP pool

integer As int32 As int32
availableIpv4Addresses
Optional

The number of IPv4 addresses available for allocation.

integer As int32 As int32
availableIpv6Addresses
Optional

The number of IPv6 addresses available for allocation.

integer As int32 As int32
allocatedIpv4Addresses
Optional

The number of allocated IPv4 addresses.

integer As int32 As int32
allocatedIpv6Addresses
Optional

The number of allocated IPv6 addresses.

Property Of
Returned By