HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

/system/interfaces

post
https://switch-ip/rest/v10.16/system/interfaces
Body Params
aaa_auth_precedence
object

Precedence order for Port Access Authentication: dot1x: IEEE 802.1X Authentication Protocol mac-auth: MAC Authentication Protocol. If empty, the default precedence order of dot1x followed by mac-auth will be used.

aaa_auth_priority
object

Priority order for Port Access Authentication: dot1x: IEEE 802.1X Authentication Protocol mac-auth: MAC Authentication Protocol. If not set, priority will follow the 'aaa_auth_precedence' order.

boolean

Disables caching authenticated clients and their associated role information. When not set, the globally configured port_access_cached_critical_role configuration will be used.

boolean

Enables RADIUS override support. With this enabled, RADIUS attributes received from server will override corresponding client role attributes.

string

Reference Resource: ACL
Ingress MAC ACL, potentially in flight, desired to be applied to this port, as identified in the ACL. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclmac_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclmac_in_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
Egress MAC ACL, potentially in flight, desired to be applied to this port, as identified in the ACL. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclmac_out_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclmac_out_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
Ingress IPv4 ACL, potentially in flight, desired to be applied to this port, as identified in the ACL. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv4_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclv4_in_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
Egress IPv4 ACL, potentially in flight, desired to be applied to this port, as identified in the ACL. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv4_out_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclv4_out_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
IPv4 ACL for routed ingress traffic, potentially in flight desired to be applied to this VLAN interface, as identified in the ACL. This configuration is applicable only when the port is a VLAN interface. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv4_routed_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclv4_routed_in_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
IPv4 ACL for routed egress traffic, potentially in flight desired to be applied to this VLAN interface, as identified in the ACL. This configuration is applicable only when the port is a VLAN interface. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the currently configured routed egress IPv4 ACL that corresponds to this configuration version value. This value is changed to a random value each time any management interface modifies the configured routed egress IPv4 ACL value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
Ingress IPv6 ACL, potentially in flight, desired to be applied to this port, as identified in the ACL. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv6_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclv6_in_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
Egress IPv6 ACL, potentially in flight, desired to be applied to this port, as identified in the ACL. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv6_out_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclv6_out_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
IPv6 ACL for routed ingress traffic, potentially in flight desired to be applied to this VLAN interface, as identified in the ACL. This configuration is applicable only when the port is a VLAN interface. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv6_routed_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclv6_routed_in_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
IPv6 ACL for routed egress traffic, potentially in flight desired to be applied to this VLAN interface, as identified in the ACL. This configuration is applicable only when the port is a VLAN interface. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the currently configured routed egress IPv6 ACL that corresponds to this configuration version vlaue. This value is changed to a random value each time any management interface modifies the configured routed egress IPv6 ACL value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string
enum

The administrative state of the Interface. If not configured, the default behavior depends on the 'type': 'mgmt': 'up' 'lag': 'down' 'vlan': 'up' 'gre_ipv4 tunnel': 'down' 'ipv6_in_ipv4 tunnel': 'down' 'ipv6_in_ipv6 tunnel': 'down' 'loopback': 'up' 'system': 'down' 'vxlan': 'down' 'ubt': 'down' When not set, the admin value will be based on the default behavior for the type of interface.

Allowed:
integer
30 to 28800

Determines the time interval in seconds till when a neighbor entry is valid.

integer
1 to 5

The number of negotiated min_rx_intervals that can occur before the BFD session is considered to be down. If not set, BFD detect-multiplier value configured at the system level will be used.

integer
100 to 20000

The shortest interval, in milliseconds, at which BFD sessions can receive BFD control messages. Remote endpoints may send messages at a slower rate. If not present, the system value is used.

integer
50 to 20000

The shortest interval, in milliseconds, at which BFD sessions can transmit BFD control messages. Messages will actually be transmitted at a slower rate if the remote endpoints cannot receive them as quickly as specified. If not present, the system value is used.

string

When configured, this represents the MAC address of the active member of LAG.

string
enum

The type of bonding used for a bonded port. Bond mode controls the selection of a interface from a group of aggregate interfaces with which to transmit a frame. This selection is performed with a hash function using either source and destination mac addresses (l2), ip addresses (l3) or tcp/udp ports (l4) as parameters. Defaults to l3-src-dst-hash if not assigned.

Allowed:
boolean

Disables reception and transmission of CDP packets on the interface, regardless of the system level configuration.

string
enum

Sets CDP pre standard mode in the interface : 'rx_only':If CDP voice VLAN query packet is received on this interface, the switch responds with the voice VLAN TLV included in its advertisements. 'tx_rx' :The switch includes voice VLAN TLV in its advertisements on this interface regardless of whether it has received a query packet from the peer. 'disable':If CDP voice VLAN query packet is received on this interface, switch updates CDP neighbor information received from the peer, but doesn't send any CDP advertisements to it.

Allowed:
string
length ≤ 64

Description for the 'system' interfaces This column value can be empty.

device_profile
object
dhcpv4_snooping_configuration
object
string

Reference Resource: DHCPv4_Snooping_Guard_Policy
DHCPv4 Guard Policy for Port.

dhcpv6_snooping_configuration
object
string

Reference Resource: DHCPv6_Snooping_Guard_Policy
DHCPv6 Guard Policy for Port.

diagnostic_config
object

Key-value pairs used to perform interface diagnostics. Normally, this map is empty. When an interface diagnostic is to be run, this column is used to configure the interface in the correct mode and override any user-configured settings that would affect the test.

boolean

Enable 802.1X supplicant on the port.

boolean

Enable MACsec via EAP for 802.1X supplicant.

string

Reference Resource: Dot1X_Supplicant_Policy
The 802.1X supplicant policy associated with the port. If a policy is not configured, the default policy will be used on the port.

boolean

Disables ICMPv4 and ICMPv6 redirect messages. For the specific port, takes precedence over the same System configuration.

boolean

Disables ICMPv4 and ICMPv6 unreachable messages. For the specific port, takes precedence over the same System configuration.

int64
1 to 4294967295

Rate limit (in milliseconds per message), that should be used for ICMP Unreachable messages. For the specific port, takes precedence over the same System configuration.

boolean

Enable IGMP router-alert checking on this interface. This is only applicable to L3 interfaces.

interfaces
array of strings
length ≤ 16

Reference Resource: Interface
The port's interfaces. If there is more than one, this is a bonded Port. A maximum of 16 interfaces can be assigned to a port.

interfaces
string
length ≤ 18

The IPv4 address and subnet mask in the address/mask format. This is the primary IP address.

ip4_address_secondary
array of strings
length ≤ 9223372036854776000

This is a list of secondary IPv4 addresses and subnet mask in the address/mask format.

ip4_address_secondary
ip6_address_custom_link_local
object

Reference Resource: IP6_Address
References user configured link-local IPv6 address of the port.

integer
68 to 9198

The user configured IP MTU of a port. This would be applicable for both IPv4 and IPv6.

ip_tcp_mss
object

TCP Maximum Segment Size (TCP MSS) specifies the largest amount of data, in bytes, that can be transmitted in a single TCP segment without fragmentation.

boolean

Enables IP Lockdown feature on the port. When set, IPv4 packets received from the clients on this port are forwarded only if there is an associated IP binding entry.

boolean

Enable automatic configuration of the IPv6 addresses.

boolean

Enables IPV6 link-local address when global unicast address is not configured.

integer
0 to 15

The number of Neighbor discovery packets to be sent for duplicate address detection.

boolean

Enable sending ICMPv6 redirect messages.

integer
1280 to 65535

The MTU option is used in router advertisement messages to ensure that all nodes on a link use the same MTU value.

integer
1000 to 3600000

The interval (in milliseconds) between neighbor solicitation messages.

ipv6_nd_prefix_default
object
ipv6_nd_ra_dnssl
object

Key-value pairs that maps DNS prefixes to their lifetime in seconds.

integer
0 to 255

The default value that will be used in RA message. If this value is not set, then global ipv6 hoplimit value will be used in RA message.

integer
0 to 9000

The lifetime associated with the default router in units of seconds.

boolean

When set it indicates that addresses are available via DHCPV6.

integer
4 to 1800

The maximum interval (in seconds) between sending router advertisements.

integer
3 to 1350

The minimum interval (in seconds) between sending router advertisements.

boolean

When set it indicates that other configuration information(DNS) is available via DHCPV6.

ipv6_nd_ra_rdnss
object

Key-value pairs that maps RDNS server addresses to their lifetime in seconds.

integer
0 to 3600000

The time, in milliseconds, that a node assumes a neighbor is reachable after having received a reachability confirmation.

int64
0 to 4294967295

The value to be placed in retransmission timer field in router advertisement messages sent by router.

string
enum

The preference associated with the default router.

Allowed:
ipv6_nd_suppress_ra
object
integer
10 to 28800

Determines the time interval in seconds till when an IPv6 neighbor entry is valid.

boolean

Enables IP Lockdown feature on the port. When set, IPv6 packets received from the clients on this port are forwarded only if there is an associated IP binding entry.

boolean
l3_counters_enable
object

Indicates which L3 counters are enabled for this Port

string
enum

Configures LACP on this port. LACP allows directly connected switches to negotiate which links may be bonded. LACP may be enabled on non-bonded ports for the benefit of any switches they may be connected to. active ports are allowed to initiate LACP negotiations. passive ports are allowed to participate in LACP negotiations initiated by a remote switch, but not allowed to initiate such negotiations themselves. If LACP is enabled on a port whose partner switch does not support LACP, the bond will be disabled. Defaults to off if unset.

Allowed:
lldp_auto_flush
object

Automatic flushing of LLDP neighbors on an interface.

lldp_if_mgmt_config
object
lldp_med_loc_civic_ca_info
object

Set of civic address elements.

string
length between 1 and 4

The civic info which includes 'country code' and 'what number' for advertisements specific to LLDP-MED. This column value can be empty.If not set civic info will not be advertise specific to LLDP-MED.

string
length between 1 and 25

LLDP-MED Elin Location configured for this interface. This column value can be empty. If not set LLDP_MED Elin will not be configured for the interface

integer
1 to 2

Specifies the pool used for arriving packets, only applicable for link-level flow-control modes 'Tx' and 'RxTx'.

string
enum

This determines action for the Loop-protect feature.The value is set to "tx- port-disable" for disabling the sending port on detecting a loop, "tx-rx- disable" disables both sending and receiving ports when loop is detected and "do-not-disable" will not disable any port. Default value is tx-port-disable.

Allowed:
boolean

When set to true, Loop-protect is enabled on this port. Default value is false.

int64
≥ 0

This determines the number of loop protect PDUs to be received before taking a receiver action.

loop_protect_vlan
array of strings
length ≤ 4094

Reference Resource: VLAN

loop_protect_vlan
string

The MAC address to use for this port for the purpose of choosing the bridge's MAC address. This column does not necessarily reflect the port's actual MAC address, nor will setting it change the port's actual MAC address.

mac_notify_type
array of strings
length ≤ 4

Define the four events that the SNMP Trap will monitor 1 - learned (On this port a MAC learn occured) 2 - removed (On the enabled port a MAC was removed) 3 - aged (On the enabled port a MAC has aged out) 4 - moved (On the enabled port a MAC has moved) empty - Empty value will be treated as invalid

mac_notify_type
string

Reference Resource: MACsec_Policy
MACsec policy associated with the port. When not set, MACsec is not operational on the port even if there is a MKA policy associated with it.

int64
0 to 4294967295

The number of times a request was made by the user to run MACsec selftest for this interface. When MACsec selftest is enabled globally, incrementing this column will initiate a new selftest that will cause a loss of link for several seconds.

mgmd_acl
object

Reference Resource: ACL
Ingress ACL to filter processing of MGMD reports and leave messages received from hosts. When this is not configured, all MGMD reports and leave messages will be processed.

mgmd_enable
object

Enable or disable IGMP/MLD on the L3 Port. By default, IGMP/MLD is disabled on the L3 Port.

mgmd_igmp_static_groups
array of strings
length ≤ 9223372036854776000

List of IGMP static group and source IP addresses. The entries are stored in the Source_Group format.Source is the Source IP Address and Group is the Group IP Address.

mgmd_igmp_static_groups
integer
2 to 3

The IGMP protocol version to use. When IGMP is disabled, this field would be empty. If there is a version mismatch between L2 and L3 VLAN, it will pick the lowest version.

mgmd_last_member_query_interval
object

The time interval that the querier waits to receive a response from members to a group-specific query message. It also specifies the amount of time between successive group-specific query messages. The default value is 1 second.

mgmd_mld_static_groups
array of strings
length ≤ 9223372036854776000

List of MLD static group and source IP addresses. The entries are stored in the Source_Group format. Source is the Source IP Address and Group is the Group IP Address.

mgmd_mld_static_groups
integer
1 to 2

The MLD protocol version to use. When MLD is disabled, this field would be empty. If there is a version mismatch between L2 and L3 VLAN, it will pick the lowest version.

mgmd_querier_enable
object

Enable/Disable the IGMP/MLD Querier Functionality on the L3 Port. The default value is disabled.

mgmd_querier_interval
object

Interval between successive IGMP/MLD All Host Queries that will be sent. The default value is 125 sec.

mgmd_querier_max_response_time
object

The time interval to wait for a response to a IGMP/MLD query. The default value is 10 seconds.

mgmd_querier_wait_time
object

The interval in seconds a device will wait to hear from a Querier before assuming Querier role. The default is 260 seconds.

mgmd_robustness
object

The number of times to retry a query. The default value is 2.

mgmd_snoop_fastlearn_enable
object

Set this value to true to enable IGMP/MLD fastlearn for the port and false to disable IGMP/MLD fastlearn. By default the feature is disabled for IGMP/MLD.

mgmd_strict_version_enable
object

Process only the configured version packets. When a key-value is not specified, strict version is disabled.

string

Reference Resource: MKA_Policy
MKA policy associated with the port.

string
enum

The administrative state of MPLS in the Interface.

Allowed:
string
enum

The administrative state of MPLS LDP in the Interface.

Allowed:
integer
15 to 65535

MPLS LDP discovery hold time is duration (in seconds). LSR will keep the peer in the discovered list without receiving a Hello message. An empty entry indicates the interface is configued with the global LDP table discovery hold time value. A non-zero entry indicates the user wants to override the global discovery hold time. This column value can be empty.

string
length ≤ 18

IP address to be advertised as the transport address in discovery hello messages. This column value can be empty.

boolean

The value true indicates Explicit Null label will be advertised in situations where it would normally advertise an Implicit Null label.

integer
15 to 65535

MPLS LDP session hold time is duration (in seconds) an LDP session will not be torn down in the absence of a keep alive message. An empty entry indicates the interface is configued with the global LDP table session hold time value. A non-zero entry indicates the user wants to override the global session hold time. This column value can be empty.

multicast_boundary_acl_in
object

Reference Resource: ACL
Ingress multicast boundary ACL desired to be applied on the current interface to filter all the multicast data and control packets.

multicast_boundary_acl_out
object

Reference Resource: ACL
Egress multicast boundary ACL desired to be applied on the current interface to filter IGMP and PIM control packets. This is used to control if the current interface can be added as an outgoing interface in a multicast route or not. If the ACL denies IGMP and PIM joins, this interface will not be added as an outgoing interface.

boolean

The value true indicates MVRP is enabled on this port.

mvrp_forbidden_vlans
array of integers
length ≤ 4094

Specifies the VLANs that should not be learned on the port. If the registration mode of the port is "forbidden" and there are no VLANs in the forbidden list , then none of the VLANs are learned on this port.

mvrp_forbidden_vlans
string
enum

Defines the mode of operation of all the registrar state machines associated with the port. The different mode of operations are In "normal" mode, the Registrar responds to incoming MRP messages. In "fixed" mode, the Registrar ignores all MRP messages, and remains in the registered state. In "forbidden" mode, the Registrar ignores all MRP messages, and remains in the unregistered state.

Allowed:
mvrp_timers
object

Specifies the different timers and their corresponding intervals in centiseconds. The MVRP standard defines all timer intervals in centiseconds(cs). 100 cs is 1 second.

string
required

Reference Resource: Interface
The interface name. For non-bonded ports, the interface name is the same as the associated port name. The name must otherwise be unique across all ports and interfaces of the system.

nd_snooping_configuration
object
options
object
string
enum

Indicator of whether the interface is built-in (system-defined) or configured. Built-in interface cannot be modified or deleted by users.

Allowed:
string

Reference Resource: Keychain
The "Keychain" used for cryptographic authentication. Supports MD5, SHA-1, SHA-256, SHA-384 and SHA-512 algorithms. If not set, keychain authentication is not operational on that port.

ospf_auth_md5_keys
object

The authentication keys for OSPFv2 authentication type "md5".

ospf_auth_sha_keys
object

The authentication keys for OSPFv2 authentication type "sha".

string
length ≥ 1

The authentication key for OSPFv2 authentication type "text". If not set, OSPFv2 authentication is not operational on that port.

string
enum

The type of OSPFv2 authentication. If not set, then parent area level authentication holds for the port.

string
enum

Specifies whether OSPF router global BFD mode should be overridden for this particular interface: 'enable': Enables BFD, regardless of OSPF router bfd_all_interfaces_enable. 'disable': Disables BFD, regardless of OSPF router bfd_all_interfaces_enable. 'default': Keeps BFD disabled or enabled according to OSPF router bfd_all_interfaces_enable.

Allowed:
integer
1 to 65535

The output cost configured on the corresponding OSPFv2 interface. If not set, OSPF will calculate cost for this interface based on link speed and reference bandwidth. Any configured value will override the automatic cost calculation.

boolean

Shut OSPF down on this interface.

string
enum

The type of the OSPFv2 network interface. The default value is the type of the interface from the Interface table. If not set, OSPFv2 interface is not up or not configured on that interface.

Allowed:
ospf_intervals
object
integer
0 to 255

The router with the highest priority will be more eligible to become Designated Router. Setting the value to 0, makes the router ineligible to become Designated Router.

ospfv3_af_ipsec_ah
object

IPsec Authentication Header (AH) configuration. Specifies Security Parameters Index (SPI), authentication type and key to use. IPsec AH is preferred over IPsec Encapsulating Security Payload (ESP) if ospfv3_af_ipsec_ah and ospfv3_af_ipsec_esp both are configured.

ospfv3_af_ipsec_esp
object

IPsec Encapsulating Security Payload (ESP) configuration. Specifies Security Parameters Index (SPI), encryption/authentication type and key to use. IPsec Authentication Header (AH) is preferred over IPsec ESP if ospfv3_af_ipsec_ah and ospfv3_af_ipsec_esp both are configured.

string
enum

Specifies whether OSPFv3 AF router global BFD mode should be overridden for this particular interface: 'enable': Enables BFD, regardless of OSPFv3 AF router bfd_all_interfaces_enable. 'disable': Disables BFD, regardless of OSPFv3 AF router bfd_all_interfaces_enable. 'default': Keeps BFD disabled or enabled according to OSPFv3 AF router bfd_all_interfaces_enable.

Allowed:
integer
1 to 65535

The time duration, in seconds, that a neighbor should wait for a Hello packet before tearing down adjacencies with the local router.

integer
1 to 65535

The Hello packet will be sent every hello interval timer value seconds. This value must be the same for all routers attached to a common network.

integer
1 to 65535

The output cost configured on the corresponding OSPFv3 interface. If not set, OSPFv3 will calculate cost for this interface based on link speed and reference bandwidth. Any configured value will override the automatic cost calculation.

integer
0 to 255

The router with the highest priority will be more eligible to become Designated Router. Setting the value to 0, makes the router ineligible to become Designated Router.

boolean

Shutdown OSPFv3 IPv4 Address family on this interface.

string
enum

The type of the OSPFv3 network interface. The default value is the type of the interface from the Interface table. If not set, OSPFv3 interface is not up or not configured on that interface.

Allowed:
integer
1 to 1800

The number of seconds between LSA retransmissions. It is also used when retransmitting Database Description and Link State Request Packets.

integer
1 to 1800

The estimated time in seconds to transmit an LSA to a neighbor. The transmit delay timer increments the age of LSAs in the update packets to accommodate transmission and propagation delays for the interface. The timer is more important on very low speed links where the transmission delay is more significant.

string
enum

Specifies whether OSPFv3 AF router global BFD mode should be overridden for this particular interface: 'enable': Enables BFD, regardless of OSPFv3 AF router bfd_all_interfaces_enable. 'disable': Disables BFD, regardless of OSPFv3 AF router bfd_all_interfaces_enable. 'default': Keeps BFD disabled or enabled according to OSPFv3 router bfd_all_interfaces_enable.

Allowed:
integer
1 to 65535

The time duration, in seconds, that a neighbor should wait for a Hello packet before tearing down adjacencies with the local router.

integer
1 to 65535

The Hello packet will be sent every hello interval timer value seconds. This value must be the same for all routers attached to a common network.

integer
1 to 65535

The output cost configured on the corresponding OSPFv3 interface. If not set, OSPFv3 will calculate cost for this interface based on link speed and reference bandwidth. Any configured value will override the automatic cost calculation.

integer
0 to 255

The router with the highest priority will be more eligible to become Designated Router. Setting the value to 0, makes the router ineligible to become Designated Router.

boolean

Shutdown OSPFv3 IPv6 Address Family on this interface.

string
enum

The type of the OSPFv3 network interface. The default value is the type of the interface from the Interface table. If not set, OSPFv3 interface is not up or not configured on that interface.

Allowed:
integer
1 to 1800

The number of seconds between LSA retransmissions. It is also used when retransmitting Database Description and Link State Request Packets.

integer
1 to 1800

The estimated time in seconds to transmit an LSA to a neighbor. The transmit delay timer increments the age of LSAs in the update packets to accommodate transmission and propagation delays for the interface. The timer is more important on very low speed links where the transmission delay is more significant.

string
enum

Specifies whether OSPFv3 router global BFD mode should be overridden for this particular interface: 'enable': Enables BFD, regardless of OSPFv3 router bfd_all_interfaces_enable. 'disable': Disables BFD, regardless of OSPFv3 router bfd_all_interfaces_enable. 'default': Keeps BFD disabled or enabled according to OSPFv3 router bfd_all_interfaces_enable.

Allowed:
integer
1 to 65535

The time duration, in seconds, that a neighbor should wait for a Hello packet before tearing down adjacencies with the local router.

integer
1 to 65535

The Hello packet will be sent every hello interval timer value seconds. This value must be the same for all routers attached to a common network.

integer
1 to 65535

The output cost configured on the corresponding OSPFv3 interface. If not set, OSPFv3 will calculate cost for this interface based on link speed and reference bandwidth. Any configured value will override the automatic cost calculation.

integer
0 to 255

The router with the highest priority will be more eligible to become Designated Router. Setting the value to 0, makes the router ineligible to become Designated Router.

boolean

Shutdown OSPFv3 on this interface.

string
enum

The type of the OSPFv3 network interface. The default value is the type of the interface from the Interface table. If not set, OSPFv3 interface is not up or not configured on that interface.

Allowed:
ospfv3_ipsec_ah
object

IPsec Authentication Header (AH) configuration. Specifies Security Parameters Index (SPI), authentication type and key to use. IPsec AH is preferred over IPsec Encapsulating Security Payload (ESP) if ospfv3_ipsec_ah and ospfv3_ipsec_esp both are configured.

ospfv3_ipsec_esp
object

IPsec Encapsulating Security Payload (ESP) configuration. Specifies Security Parameters Index (SPI), encryption/authentication type and key to use. IPsec Authentication Header (AH) is preferred over IPsec ESP if ospfv3_ipsec_ah and ospfv3_ipsec_esp both are configured.

integer
1 to 1800

The number of seconds between LSA retransmissions. It is also used when retransmitting Database Description and Link State Request Packets.

integer
1 to 1800

The estimated time in seconds to transmit an LSA to a neighbor. The transmit delay timer increments the age of LSAs in the update packets to accommodate transmission and propagation delays for the interface. The timer is more important on very low speed links where the transmission delay is more significant.

other_config
object
persona
object
pfc_priorities_config
object

The user configured priorities for priority-based flow control. This field is only valid when interface_flowcontrol_pfc capability is present and the "pause" key of the user_config is set to "pfc".

pim_bfd
object

'enable': Enables BFD on this interface overriding the PIM router BFD configuration bfd_all_interfaces_enable in PIM_Router. 'disable': Disables BFD on this interface overriding the PIM router BFD configuration bfd_all_interfaces_enable in PIM_Router. 'default': Keeps BFD enabled or disabled on this interface based on the PIM router BFD configuration bfd_all_interfaces_enable in PIM_Router.

pim_bsr_boundary
object
pim_datapath_auto_include
object
pim_dense_graft_retry_interval
object

Time (in seconds) that this port waits for a PIM graft acknowledgement from its peer before it retransmit another graft datagram.

pim_dense_max_graft_retries
object

Number of times the port will re-transmit PIM graft datagrams.

pim_dense_ttl_threshold
object

This is the minimum TTL value that state refresh messages received from a peer must have, to be eligible for forwarding to other peers.

pim_dr_priority
object

Designated Router(DR) Priority for this port.

pim_hello_interval
object

Interval (in seconds) at which PIM Hello messages are transmitted on this port.

pim_lan_prune_delay_disable
object

This entry specifies whether LAN prune delay option is enabled on this port.

pim_mode
object
pim_override_interval
object

Override Interval (in milliseconds) on this port.

pim_propagation_delay
object

Propagation Delay (in milliseconds) on this port.

pim_source_address
object

IP address used as the source address for the PIM protocol packets outbound on this port. If the value is not specified or empty then the primary IP of the port will be used as the source IP.

pim_trig_hello_interval
object

Maximum time (in seconds) before this port transmits the initial PIM hello message on bootup or a triggered Hello message to a rebooting neighbor.

string

Reference Resource: Policy
Ingress Classifier Policy, potentially in flight, desired to be applied to this port, as identified in the policy. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of 'policy_in_cfg'. This value is changed to a random value each time any management interface modifies the 'policy_in_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

string
enum

Persistence of Port, i.e how the Port is provisioned: persistent : Port is created by CLI or REST that will be retained over system reboot. volatile : Port typically created by Aruba Central that will not be retained over system reboot.

Allowed:
string

Reference Resource: Policy
Classifier policy for routed ingress traffic, potentially in flight, desired to be applied to this port, as identified in the policy. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of 'policy_routed_in_cfg'. This value is changed to a random value each time any management interface modifies the 'policy_routed_in_cfg' value. An empty column value will indicate that the user does not want the system to process this configuration yet.

port_access_allow_bpdu
array of strings
length ≤ 2

Enables LLDP and/or CDP BPDU to be accepted before authentication.

port_access_allow_bpdu
boolean

Enables transmission of flood-traffic (broadcast, multicast and unknown unicast) out ports that are security blocked. A port is security blocked when authentication is enabled for that port and no client has yet been authenticated on this port.

string
enum

Proxy logoff the client based on port status in protocol packet. Switch will clear authentication session of the host, if switch receives port down status in protocol packet. When not configured, no action is taken. This is only applicable when port-access authentication is enabled for this port.

Allowed:
port_access_auth_configurations
object

Reference Resource: Port_Access_Auth_Configuration
Authentication method specific port-access configurations on this interface.

string
enum

Indicates, whether each individual client on the port needs to be authenticated separately to gain access to the network. client-mode: every client needs to be authenticated to be granted network access. device-mode: only one of the attached clients must be authenticated for all clients to be granted network access. multi-domain:limit the number of authenticated clients to one 'voice' client and a configured number of 'data' clients. By default allowed 'data' client is also one.

Allowed:
string

Reference Resource: Port_Access_Role
The role to be applied for clients that have been authenticated but not received any specific role or attribute from the authentication server. When not set, no role is applied for clients that successfully authenticated without a role assigned from the RADIUS server.

integer
1 to 256

Maximum number of clients that can be authenticated on this port.

boolean

Enable authentication methods to start concurrently for faster onboarding. If not set, clients are onboarded based on the order specified by port_access_onboarding_precedence.

string

Reference Resource: Port_Access_Role
The role to be applied for clients, that failed authentication due to unreachable authentication servers. When not set, no role is applied for clients that could not complete authentication due to RADIUS server being unreachable.

string

Reference Resource: Port_Access_Role
The role to be applied to 'voice' client that have failed re-authentication due to servers being unreachable. When not set, no role will be applied for voice clients when they fail re-authentication due to server being unreachable.

boolean

Disable BPDU triggered authentication for CDP. This is only applicable when port access authentication is enabled for this port.

boolean

Disable BPDU triggered authentication for LLDP. This is only applicable when port access authentication is enabled for this port.

port_access_enable_client_auto_logoff
object

Configure port-access client automatic log-off.

string

Reference Resource: Port_Access_Role
The role that will be applied to clients that have not been assigned a role via any of the onboarding methods. When not set, no role is applied for the client.

string
enum

MAC address to use when authentication is triggered by an LLDP frame. chassis-mac: Use the chassis MAC in LLDP TLV source-mac: Use the source MAC in LLDP frame This is only applicable when port access authentication is enabled on this port.

Allowed:
integer
1 to 5

Maximum number of 'data' clients that can be authenticated on this port when multi-domain is enabled. If the number of 'data' clients on this port exceeds this client limit, it will be considered as a port-access violation and the configured threshold-violation action will be performed.

port_access_onboarding_precedence
object

Precedence order for Port Access Authentication: aaa: Onboard clients based on AAA authentication. device-profile: Onboard clients based on device-profile configuration. If empty, the default precedence order of aaa followed by device-profile will be used.

string

Reference Resource: Port_Access_Role
The role to be applied for clients that are yet to be authenticated. When not set, no role is applied for clients while the authentication is in progress for the client.

string

Reference Resource: Port_Access_Role
The role to be applied for clients that failed authentication When not set, no role is applied for clients that fail authentication.

port_access_security_violation
object
string

Reference Resource: Port_Access_Role
The role that will be applied to clients when corresponding UBT zone is not reachable. When not set, no role is applied for the client when the UBT zone is not reachable.

port_security
object
port_security_static_client_mac_addr
array of strings
length ≤ 64

MAC addresses of the clients that should be authorized on this port.

port_security_static_client_mac_addr
port_security_static_sticky_client_mac_addr
object

MAC addresses of the sticky clients that should be authorized on this port.

portfilter
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
Set of ports that must not egress packets that were received on this port.

portfilter
boolean

Disable processing gratituous ARP packets received on this port. This is only applicable to Layer-3 interfaces (SVIs, Routed ports or L3 LAG).

string
enum

Specifies the port's type in the context of Private VLANS. When not set, the port functions as an Inter Switch Link if it is carrying traffic for PVLANs.

Allowed:
string
length between 1 and 64

References queue profile for this port. If this is unspecified, then the queue profile referenced in System) table q_profile will be used.

string
length between 1 and 64

References schedule profile for this port. If this is unspecified, then the schedule profile referenced in System) table qos will be used.

qos_config
object
string

Reference Resource: RA_Guard_Policy
RA Guard policy associated with this Port. RR/RA packets received on this port will be inspected and permitted per the policy specification if the port is untrusted.

integer
5 to 300

Interval in seconds to calculate interface rate statistics.

rate_limits
object
boolean

Specifies whether router advertisements should be sent using broadcast, 255.255.255.255 address. If the value is false (which is a default) the packets would be sent to multicast 224.0.0.1 address.

boolean

When set to true, IRDP is enabled on the port. The default value is false.

int64
-4294967296 to 4294967295

Specifies the preference level of this routing switch. Higher value indicates higher router preference. The default preference value is 0.

rdisc_irdp_timers
object
boolean

Indicates whether the interface is routing or Layer 2. For routing interfaces, 'vrf' has to be properly populated. If not configured, default behavior depends on interface 'type': 'vlan': 'true' 'gre_ipv4 tunnel': 'true' 'ipv6_in_ipv4 tunnel': 'true' 'ipv6_in_ipv6 tunnel': 'true' 'loopback': 'true' 'system': 'true' 'lag': 'true' 'vxlan': 'false' 'ubt': 'false'

boolean

Specify true to disable and false to enable for the respective interface

ssm_map_acl
object

Reference Resource: ACL
ACL to maintain group-source mapping for SSM group addresses. IGMPv1/IGMPv2/MLDv1 join and leave packets destined to SSM group address in the SSM map will be converted to (source, group) channels, for all the sources part of respective SSM map.

static_ip6_addresses
object

Reference Resource: IP6_Address
Stores the statically configured IPv6 addresses and prefixes.

stp_config
object

This represents information regarding stp port level configuration.

string

Reference Resource: Port
The parent interface associated with a subinterface. This is only applicable when the port's type is vlansubint. A subinterface will remain in down state until a parent port is associated with it.

integer
1 to 4094

Specifies VLAN ID for the subinterface. This VLAN ID is used to send and receive 802.1Q tagged packets on a subinterface. Without an associated VLAN ID, a subinterface will remain in down state.

string

Reference Resource: Threshold_Profile
Specifies the threshold-profile name for this port. If it is unspecified, the name (if present) of the threshold_profile_default column in System table will be used.

string
string
enum
required

The interface type, one of: system: Regular, physical interface of the system. internal_bridge: A simulated network device that represents the bridge and is used. for providing L3 traffic to the control plane. vlan: Generally represents SVI - L3 Vlan interfaces. vlansubint: A sub-interface created for a physical interface based on dot1q encapsulation. loopback: A loopback interface is a virtual interface, supporting ipv4/ipv6 address configuration, that remains up until it is deleted by administrator. Loopback interface ip address is used as router-id and source address by many protocols. gre_ipv4: ipv4 GRE tunnel. ipv6_in_ipv4: IPv6 in IPv4 tunnel. ipv6_in_ipv6: IPv6 in IPv6 tunnel. vxlan: VXLAN interface vxlan_ipv6: IPv6 VXLAN interface ubt: User Based Tunnel L2GRE interface internal_l3vni: L3VNI interface.

string
enum

UDLD compatibility mode.

Allowed:
boolean

UDLD protocol is enabled or not on this interface.

string
enum

Configured UDLD operation mode for HPE ANW. In verify_then_forward the interface starts out blocked and will not forward traffic until UDLD determines that the interface is bidirectional. With forward_then_verify the interface starts out unblocked.

Allowed:
integer
10 to 90000

The time interval in milliseconds to send UDLD packets. If 'udld_compatibility' value is 'rfc5171' and time interval is below valid range for RFC 5171 (7000 - 90000), then it will be forced to 7000.

integer
3 to 10

Number of retries before changing the UDLD interface status to block.

string
enum

Configured UDLD operation mode for RFC5171. In normal mode, once the link is determined to be in unidirectional state (after it was deemed bidireccional), and no "Echo" is received, it is set to "undetermined" state. However, if a a UDLD packet with an empty "Echo" is received the interface will be set to "errDisabled". In aggressive , once a link is determined to be in unidirectional state (after it was deemed bidirectional), and no "Echo" is received, it is set to "errDisabled" state. The interface will also be set to "errDisabled" if a UDLD packet with an empty "Echo" is received.

Allowed:
unnumbered
object

Reference Resource: Port
Enables IP-unnumbered support for this port. Once set, this port will borrow the user-configured 'primary' IPv4 address from an 'owner' interface and use in its L3 control plane exchange. This is only applicable when the borrowing interface is a routed port or a layer-3 LAG.

string
enum

Mode of unicast reverse path forwarding verification: 'loose': drop packets that are destined to the device itself and that have source IP that is not reachable. 'strict': drop packets that are destined to the device and that have source IP that is not reachable through the interface that the packet arrived on. 'disable': no reverse path verification.

Allowed:
user_config
object

Key-value pairs that stores the user configuration of Interface.

boolean

Enables the interface to use the virtual gateway MAC address as the source MAC for routed traffic. This is only applicable for SVI interfaces.

virtual_ip4_routers
object

Reference Resource: VRRP
The port's VRRP groups (or VR instances) for IPv4 address family. A maximum of 32 VRRP groups can be assigned to a port.

virtual_ip6_routers
object

Reference Resource: VRRP
The port's VRRP groups (or VR instances) for IPv6 address family. A maximum of 32 VRRP groups can be assigned to a port.

string
enum

VLAN mode for ports with 'routing' being 'false'. For those ports, it has to be set, otherwise the port will be held down. When vlan_mode is not set, it indicates that the port is in access mode. access: Port can carry traffic for only one VLAN and the VLAN is specified as part of vlan_tag. Packets ingressing and egressing this port will not have an 802.1Q VLAN tag. When the port is trunked, mode must be either native-tagged or native-untagged, value contained in vlan_trunks refers to the list of VLANs which have to be trunked, if it is empty then all VLANs have to be trunked. native-tagged: Port can carry traffic for multiple VLANs. One of the VLANs is designated as native and is specified as part of vlan_tag. Traffic for all VLANs on this port including the native VLAN will be 802.1Q VLAN tagged. native-untagged: Port can carry traffic for multiple VLANs. One of the VLANs is designated as native and the VLAN ID is specified as part of vlan_tag. Traffic for all VLANs except the native VLAN will be 802.1Q VLAN tagged Traffic for the native VLAN will not have an 802.1Q tag.

Allowed:
string

Reference Resource: VLAN
Specifies the Access or Native VLAN for this port. When vlan_tag is not set, it indicates that VLAN-1 is the Access or Native VLAN. For a non-SVI, 'routing' interface, the value must be kept empty. For SVI, the value must reference the VLAN of the SVI.

vlan_trunks
array of strings
length ≤ 4096

Reference Resource: VLAN
List of VLANs that this port is allowed to pass traffic for. When the list is empty, it means that the port will be allowed to pass traffic for all VLANs configured on the device. This is only relevant if 'vlan_mode' is 'native-tagged' or 'native-untagged' and ignored for 'access'. 'native-tagged' or 'native-untagged' port always trunks its native ('vlan_tag') VLAN, regardless of whether it's included in 'vlan_trunks'.

vlan_trunks
vlans_per_protocol
object

Reference Resource: VLAN
The list of protocol VLANs configured on the port.

string

Reference Resource: VRF
Indicates the VRF to which the port belongs if the port is routing. If not configured and if the port is routing, the port belongs to 'default' vrf.

boolean

Determines whether this port has VSX active-forwarding enabled or not. This should be set on Upstream SVIs only and not on downstream SVIs that have active-gateway enabled.

boolean

A value of 'true' disables vsx linkup delay timer for this port.

boolean

Determines whether the port will be shutdown when VSX split occurs. This is only applicable to the ports that are not configured as MCLAG and SVIs that do not have any MCLAGs as members.

vsx_sync
array of strings
length ≤ 9223372036854776000

Controls which attributes should be synchronized between VSX peers. '^acl.' : all attributes that control the association with the ACLs will be synchronized. '.irdp.' : all attributes that control the IRDP will be synchronized. '^qos.' : all attributes that control the Quality of Service will be synchronized. 'rate_limits' : all attributes that control rate-limits will be synchronized. '^vlan.' : all attributes that control the association with the VLANs will be synchronized. '^vsx_virtual.': all attributes that control the association with the VSX active-gateways will be synchronized. 'virtual_gw_l3_src_mac_enable': attribute that controls the active-gateways l3 source MAC will be synchronized '^policy.' : all attributes that control the association with the Policies will be synchronized. 'portfilter' : attribute that controls static portfiltering will be synchronized. 'client_ip_track_configuration' : attribute that controls the client track ip will be synchronized. 'device_fingerprint_configuration' : attribute controls device fingerprinting will be synchronized. 'mgmd_acl' : Attribute that associates ACL with IGMP/MLD will be synchroized. 'mgmd_enable' : Attribute that controls the multicast IGMP/MLD will be synchroized. 'mgmd_robustness' : Attribute that controls number of retries for query will be synchronized. 'mgmd_querier_max_response_time' : Attribute that controls time interval for response of IGMP/MLD query will be synchronized. 'mgmd_mld_version' : Attribute that controls mld version will be synchronized. 'mgmd_querier_interval' : Attribute that controls interval between IGMP/MLD queries will be synchronized. 'mgmd_last_member_query_interval' : Attributes that control time interval that querier waits to receive response will be synchronized. 'mgmd_querier_enable' : Attribute that controls querier enable/disable will be synchronized. 'mgmd_mld_static_groups' : Attribute that controls list of static MLD groups will be synchronized. 'mgmd_igmp_static_groups' : Attribute that controls list of static IGMP groups will be synchronized. 'mgmd_igmp_version' : Attribute that controls IGMP L3 Interface Version will be synchronized. 'mgmd_querier_wait_timer' : Attribute that controls wait time before querier role will be synchronized. 'macsec_policy' : Attribute that controls the MACsec policy association to a port will be synchronized. 'mka_policy' : Attribute that controls the MKA policy association to a port will be synchronized. 'pvlan_port_type' : Attribute that specifies the port's type in pvlan context will be synchronized. 'pim_mode' : Attribute that controls the multicast PIM will be synchroized. 'pim_trig_hello_interval' : Attribute that controls the multicast PIM hello delay will be synchroized. 'pim_hello_interval' : Attribute that controls the multicast PIM hello interval will be synchroized. 'pim_lan_prune_delay_disable' : Attribute that controls the multicast PIM lan prune delay will be synchroized. 'pim_override_interval' : Attribute that controls the multicast PIM override interval will be synchroized. 'pim_propagation_delay' : Attribute that controls the multicast PIM propagation delay will be synchroized. 'pim_vsx_virtual_neighbor' : Attribute that controls the multicast PIM vsx virtual neighbor will be synchroized. 'pim_source_address': Attribute that controls the multicast PIM source ip will be synchroized. 'pim_bfd' : Attribute that controls the multicast PIM bfd will be synchroized. 'dhcp-snooping' : Attribute that controls the dhcp-snooping on a port will be synchronized. 'pim_bsr_boundary' : Attribute that controls PIM Bootstrap messages on boundary interface 'multicast_boundary_acl_in' : Attribute that controls Ingress multicast boundary as per ACL 'multicast_boundary_acl_out' : Attribute that controls Egress multicast boundary as per ACL 'ssm_map_acl' : Attribute that associates ssm-map ACL with IGMP/MLD will be synchroized.

vsx_sync
string
length between 17 and 17

VSX virtual gateway MAC address for the corresponding virtual gateway IPv4 addresses. If virtual gateway MAC is not configured, then device system MAC will be used as the gateway MAC.

string
length between 17 and 17

VSX virtual gateway MAC address for the corresponding virtual gateway IPv6 addresses. If virtual gateway MAC is not configured, then device system MAC will be used as the gateway MAC.

vsx_virtual_ip4
array of strings
length ≤ 9223372036854776000

List of active gateway IPv4 addresses.

vsx_virtual_ip4
vsx_virtual_ip6
array of strings
length ≤ 9223372036854776000

List of active gateway IPv6 addresses.

vsx_virtual_ip6
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Updated over 4 years ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated over 4 years ago