NetworkingInterfacesIpv4Info

The Ipv4.Info structure defines current IPv4 configuration state of a network interface.


Properties

boolean
configurable Required

The specified network interface is configurable or not.


mode Required

The Ipv4.Mode enumerated type defines different IPv4 address assignment modes.
DHCP : The IPv4 address is automatically assigned by a DHCP server.
STATIC : The IPv4 address is static.
UNCONFIGURED : The IPv4 protocol is not configured.

Possible values are: DHCPSTATICUNCONFIGURED


string
address Optional

The IPv4 address, for example, “10.20.80.191”. This field is optional and it is only relevant when the value of Ipv4.Info.mode is one of STATIC or DHCP.


string
default_gateway Optional

The IPv4 address of the default gateway. This configures the global default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces. This field is optional and it is only relevant when the value of Ipv4.Info.mode is one of STATIC or DHCP.


integer as int64
prefix Optional

The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. This field is optional and it is only relevant when the value of Ipv4.Info.mode is one of STATIC or DHCP.

JSON Example

{
	"configurable": false,
	"mode": "DHCP"
}

Feedback

Was this page helpful?