interface management¶

Management interface

management Specification¶

Parameter Value

Type Configuration Resource

Element Name management

Element URI /axapi/v3/interface/management

Element Attributes management_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/interface/management/stats

Operational Data URI /axapi/v3/interface/management/oper

Schema management schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/interface/management	management attributes
Get Object	GET	/axapi/v3/interface/management	management attributes
Modify Object	POST	/axapi/v3/interface/management	management attributes
Replace Object	PUT	/axapi/v3/interface/management	management attributes

management attributes¶

access-list

Description: access-list is a JSON Block. Please see below for access-list

Type: Object

action

Description ‘enable’: Enable Management Port; ‘disable’: Disable Management Port;

Type: string

Supported Values: enable, disable

Default: enable

broadcast-rate-limit

Description: broadcast-rate-limit is a JSON Block. Please see below for broadcast-rate-limit

Type: Object

duplexity

Description ‘Full’: Full; ‘Half’: Half; ‘auto’: Auto;

Type: string

Supported Values: Full, Half, auto

Default: auto

flow-control

Description Enable 802.3x flow control on full duplex port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip

Description: ip is a JSON Block. Please see below for ip

Type: Object

ipv6

Type: List

lldp

Description: lldp is a JSON Block. Please see below for lldp

Type: Object

Reference Object: /axapi/v3/interface/management/lldp

mtu

Description Interface mtu (Interface MTU, default 1 (min MTU is 1280 for IPv6))

Type: number

sampling-enable

Type: List

secondary-ip

Description: secondary-ip is a JSON Block. Please see below for secondary-ip

Type: Object

speed

Description ‘10’: 10 Mbs/sec; ‘100’: 100 Mbs/sec; ‘1000’: 1 Gb/sec; ‘auto’: Auto Negotiate Speed; (Interface Speed)

Type: string

Supported Values: 10, 100, 1000, auto

Default: auto

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

lldp¶

Specification Value

Type object

enable-cfg

Description: enable-cfg is a JSON Block. Please see below for lldp_enable-cfg

Type: Object

notification-cfg

Description: notification-cfg is a JSON Block. Please see below for lldp_notification-cfg

Type: Object

tx-dot1-cfg

Description: tx-dot1-cfg is a JSON Block. Please see below for lldp_tx-dot1-cfg

Type: Object

tx-tlvs-cfg

Description: tx-tlvs-cfg is a JSON Block. Please see below for lldp_tx-tlvs-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

lldp_tx-dot1-cfg¶

Specification Value

Type object

link-aggregation

Description Interface link aggregation information

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tx-dot1-tlvs

Description Interface lldp tx IEEE 802.1 Organizationally specific TLVs configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vlan

Description Interface vlan information

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lldp_notification-cfg¶

Specification Value

Type object

notif-enable

Description Interface lldp notification enable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

notification

Description Interface lldp notification configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lldp_tx-tlvs-cfg¶

Specification Value

Type object

exclude

Description Configure which TLVs excluded. All basic TLVs will be included by default

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

management-address

Description Interface lldp management address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-description

Description Interface lldp port description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

system-capabilities

Description Interface lldp system capabilities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

system-description

Description Interface lldp system description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

system-name

Description Interface lldp system name

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tx-tlvs

Description Interface lldp tx TLVs configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lldp_enable-cfg¶

Specification Value

Type object

rt-enable

Description Interface lldp enable/disable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rx

Description Enable lldp rx

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tx

Description Enable lldp tx

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

broadcast-rate-limit¶

Specification Value

Type object

bcast-rate-limit-enable

Description Rate limit the l2 broadcast packet on mgmt port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rate

Description packets per second. Default is 500. (packets per second. Please specify an even number. Default is 500)

Type: number

Range: 50-5000

Default: 500

ipv6¶

Specification Value

Type list

Block object keys

address-type

Description ‘link-local’: Configure an IPv6 link local address;

Type: string

Supported Values: link-local

default-ipv6-gateway

Description Set default gateway (Default gateway address)

Type: string

Format: ipv6-address

inbound

Description ACL applied on incoming packets to this interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6-addr

Description Set the IPv6 address of an interface

Type: string

Format: ipv6-address-plen

v6-acl-name

Description Apply ACL rules to incoming packets on this interface (Named Access List)

Type: string

Maximum Length: 16 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ipv6/access-list

secondary-ip¶

Specification Value

Type object

control-apps-use-mgmt-port

Description Control applications use management port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

default-gateway

Description Set default gateway (Default gateway address)

Type: string

Format: ipv4-address

dhcp

Description Use DHCP to configure IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: dhcp and ipv4-address are mutually exclusive

ipv4-address

Description IP address

Type: string

Format: ipv4-address

Mutual Exclusion: ipv4-address and dhcp are mutually exclusive

ipv4-netmask

Description IP subnet mask

Type: string

Format: ipv4-netmask

secondary-ip

Description Global IP configuration subcommands

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘packets_input’: Input packets; ‘bytes_input’: Input bytes; ‘received_broadcasts’: Received broadcasts; ‘received_multicasts’: Received multicasts; ‘received_unicasts’: Received unicasts; ‘input_errors’: Input errors; ‘crc’: CRC; ‘frame’: Frames; ‘input_err_short’: Runts; ‘input_err_long’: Giants; ‘packets_output’: Output packets; ‘bytes_output’: Output bytes; ‘transmitted_broadcasts’: Transmitted broadcasts; ‘transmitted_multicasts’: Transmitted multicasts; ‘transmitted_unicasts’: Transmitted unicasts; ‘output_errors’: Output errors; ‘collisions’: Collisions;

Type: string

Supported Values: all, packets_input, bytes_input, received_broadcasts, received_multicasts, received_unicasts, input_errors, crc, frame, input_err_short, input_err_long, packets_output, bytes_output, transmitted_broadcasts, transmitted_multicasts, transmitted_unicasts, output_errors, collisions

ip¶

Specification Value

Type object

control-apps-use-mgmt-port

Description Control applications use management port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

default-gateway

Description Set default gateway (Default gateway address)

Type: string

Format: ipv4-address

dhcp

Description Use DHCP to configure IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: dhcp and ipv4-address are mutually exclusive

ipv4-address

Description IP address

Type: string

Format: ipv4-address

Mutual Exclusion: ipv4-address and dhcp are mutually exclusive

ipv4-netmask

Description IP subnet mask

Type: string

Format: ipv4-netmask

access-list¶

Specification Value

Type object

acl-id

Description ACL id

Type: number

Range: 1-199

Reference Object: /axapi/v3/access-list/standard

acl-name

Description Apply an access list (Named Access List)

Type: string

Maximum Length: 16 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ip/access-list