network (bonded interfaces)

The network (bonded interfaces) object contains configuration information for bonded network interfaces on a storage node. You can use the GetConfig and GetNetworkConfig methods to obtain this information for a storage node.

Object members

This object contains the following members:

Name Description Type
address The IPv4 address assigned to this interface on the node. string
addressV6 The IPv6 management address assigned to the Bond1G interface on the node. string
bond-downdelay Time to wait before disabling a slave after a link failure has been detected. string
bond-fail_over_mac The configuration of the MAC address of the network interface. string
bond-miimon How often the MII link state is inspected for link failures. integer
bond-mode The bonding mode. Possible values:
  • ActivePassive (Default)
  • ALB
  • LACP (Recommended)
string
bond-primary_reselect Specifies when the primary bond slave is chosen as the active slave. Possible values:
  • Always
  • Better
  • Failure
string
bond-slaves The list of slave interfaces for the bond. string
bond-lacp_rate When Bond Mode is LACP, the rate may change to one of the following:
  • LACP Fast (Default)
  • LACP Slow
integer
bond-updelay The time to wait before enabling a slave after a link is detected. integer
dns-nameservers A list of addresses used for domain name services, separated by comma or space. string
dns-search A space or comma separated list of DNS search domains. string
family Address family that the interface is configured to use. Currently "inet" for IPv4 is supported. string
gateway The IPv4 router network address used to send traffic from the local network. string
gatewayV6 The IPv6 router network address used to send traffic from the local Bond1G network. string
ipV6PrefixLength The subnet prefix length for static routes of type "net" for IPv6 traffic on the Bond1G network. string
macAddress The actual MAC address assigned to the interface and observed by the network. string
macAddressPermanent The immutable MAC address assigned by the manufacturer to the interface. string
method The method used to configure the interface. Possible values:
  • Loopback: Used to define the IPv4 loopback interface.
  • manual: Used to define interfaces that are not configured automatically.
  • dhcp: Can be used to obtain an IP address via DHCP.
  • static: Used to define Ethernet interfaces with statically allocated IPv4 addresses.
string
mtu The largest packet size (in bytes) that the interface can transmit. Must be greater than or equal to 1500; up to 9000 is supported. string
netmask The bitmask that specifies the subnet for the interface. string
network Indicates where the IP address range begins based on the netmask. string
routes Comma separated array of route strings to apply to the routing table. string array
status The state of the interface. Possible values:
  • Down: The interface is inactive.
  • Up: The interface is ready, but has no link.
  • UpAndRunning: The interface is ready and a link is established.
string
symmetricRouteRules The symmetric routing rules configured on the node. string array
upAndRunning Indicates if the interface is ready and has a link. boolean
virtualNetworkTag The virtual network identifier of the interface (VLAN tag). string

Member modifiability and node states

This table indicates whether or not the object parameters can be modified at each possible node state.

Member name Available state Pending state Active state
address Yes Yes No
addressV6 Yes Yes No
bond-downdelay Configured by the system N/A N/A
bond-fail_over_mac Configured by the system N/A N/A
bond-miimon Configured by the system N/A N/A
bond-mode Yes Yes Yes
bond-primary_reselect Configured by the system N/A N/A
bond-slaves Configured by the system N/A N/A
bond-lacp_rate Yes Yes Yes
bond-updelay Configured by the system N/A N/A
dns-nameservers Yes Yes Yes
dns-search Yes Yes Yes
family No No No
gateway Yes Yes Yes
gatewayV6 Yes Yes Yes
ipV6PrefixLength Yes Yes Yes
macAddress Configured by the system N/A N/A
macAddressPermanent Configured by the system N/A N/A
method No No No
mtu Yes Yes Yes
netmask Yes Yes Yes
network No No No
routes Yes Yes Yes
status Yes Yes Yes
symmetricRouteRules Configured by the system N/A N/A
upAndRunning Configured by the system N/A N/A
virtualNetworkTag Yes Yes Yes