The Interfaces.IpAddressInfo structure describes a specific IP Address.


ip_address Required

IPv4 address is specified using dotted decimal notation. For example, “”. 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.

origin Optional

The Interfaces.IpAddressOrigin enumerated type specifies how an IP address was obtained for an interface. See RFC 4293 IpAddressOriginTC.
OTHER : Any other type of address configuration other than the below mentioned ones will fall under this category. For e.g., automatic address configuration for the link local address falls under this type.
MANUAL : The address is configured manually.
DHCP : The address is configured through dhcp.
LINKLAYER : The address is obtained through stateless autoconfiguration (autoconf). See RFC 4862, IPv6 Stateless Address Autoconfiguration.
RANDOM : The address is chosen by the system at random e.g., an IPv4 address within 169.25416, or an RFC 3041 privacy address.


integer as int64
prefix_length Required

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.

state Required

The Interfaces.IpAddressStatus enumerated type defines the present status of an address on an interface. See RFC 4293 IpAddressStatusTC.
PREFERRED : Indicates that this is a valid address.
DEPRECATED : Indicates that this is a valid but deprecated address that should no longer be used as a source address.
INVALID : Indicates that this isn’t a valid address.
INACCESSIBLE : Indicates that the address is not accessible because interface is not operational.
UNKNOWN : Indicates that the status cannot be determined.
TENTATIVE : Indicates that the uniqueness of the address on the link is presently being verified.
DUPLICATE : Indicates the address has been determined to be non-unique on the link, this address will not be reachable.


JSON Example

    "ip_address": "string",
    "prefix_length": 0,
    "state": "PREFERRED"


Was this page helpful?