vcenter vm guest networking interfaces: ip config info

The ip_config_info structure describes the protocol version independent address reporting data object for network interfaces. This structure was added in vSphere API 7.0.0.

Representation:

{
    "ip_addresses"[
        {
            "origin""OTHER",
            "ip_address""string",
            "prefix_length"1,
            "state""PREFERRED"
        },
        {
            "origin""OTHER",
            "ip_address""string",
            "prefix_length"1,
            "state""PREFERRED"
        }
    ],
    "dhcp"{
        "ipv6_enabled"true,
        "ipv4_enabled"true
    }
}

Attributes:

Name Type Description
Required
ip_addresses ip_address_info[] IP addresses configured on the interface. This attribute was added in vSphere API 7.0.0.

ip_addresses[].ip_address string IPv4 address is specified using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses specified using eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of the symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373. This attribute was added in vSphere API 7.0.0.

ip_addresses[].prefix_length long Denotes the length of a generic Internet network address prefix. Prefix length: the valid range of values is 0-32 for IPv4, and 0-128 for IPv6. A value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB), with all other bits set to 0. A value of zero is valid only if the calling context defines it. This attribute was added in vSphere API 7.0.0.

ip_addresses[].state string The state of this ipAddress. This attribute was added in vSphere API 7.0.0.

Defines the present status of an address on an interface. See RFC 4293 IpAddressStatusTC. This enumeration was added in vSphere API 7.0.0. Value is one of:
PREFERRED: Indicates that this is a valid address. This constant was added in vSphere API 7.0.0.
DEPRECATED: Indicates that this is a valid but deprecated address that should no longer be used as a source address. This constant was added in vSphere API 7.0.0.
INVALID: Indicates that this isn't a valid address. This constant was added in vSphere API 7.0.0.
INACCESSIBLE: Indicates that the address is not accessible because interface is not operational. This constant was added in vSphere API 7.0.0.
UNKNOWN: Indicates that the status cannot be determined. This constant was added in vSphere API 7.0.0.
TENTATIVE: Indicates that the uniqueness of the address on the link is presently being verified. This constant was added in vSphere API 7.0.0.
DUPLICATE: Indicates the address has been determined to be non-unique on the link, this address will not be reachable. This constant was added in vSphere API 7.0.0.

dhcp.ipv4_enabled boolean True if IPv4 DHCP is enabled, false otherwise. This attribute was added in vSphere API 7.0.0.

dhcp.ipv6_enabled boolean True if IPv6 DHCP is enabled, false otherwise. This attribute was added in vSphere API 7.0.0.

Optional
ip_addresses[].origin string How this address was configured. This attribute was added in vSphere API 7.0.0.

Optional. If unset the data was not available.

dhcp dhcp_config_info Client side DHCP for an interface. This attribute was added in vSphere API 7.0.0.

Optional. If unset the IP was not configured by DHCP.