interface management

Configure the out-of-band management interface

management Specification

Type Configuration Resource
Element Name management
Element URI /axapi/v3/interface/management
Element Attributes management_attributes
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

broadcast-rate-limit

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

Type: Object

duplexity

Description: Sets the duplex mode.

  • Full – Full-duplex mode.
  • Half – Half-duplex mode.
  • Auto – The mode is negotiated based on the mode of the other end of the link.

Type: string

Supported Values: Full, Half, auto

Default: auto

flow-control

Description: Enables 802.3x flow control on a full-duplex interface.

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

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

Type: Object

lldp

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

Type: Object

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

speed

Description: Specify the maximum speed on the interface.

Type: string

Supported Values: 10, 100, 1000, auto

Default: auto

uuid

Description: uuid of the object

Type: string

lldp

Specification
Type object

enable-cfg

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

Type: Object

notification-cfg

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

Type: Object

tx-dot1-cfg

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

Type: Object

tx-tlvs-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

lldp.tx-dot1-cfg

Specification
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
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
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
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
Type object

bcast-rate-limit-enable

Description: Enables a rate limit on layer 2 broadcast packets on the management interface.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rate

Description: Specify the rate limit on layer 2 broadcast packets on the management interface

Type: number

Range: 50-5000

Default: 500

ipv6

Specification
Type object

address-type

Description: Configure the address as the link-local IPv6 address for the interface, instead of a global address. Otherwise, the address is a global address.

Type: string

Supported Values: link-local

default-ipv6-gateway

Description: Specify the default gateway for the out-of-band management interface.

Type: string

Format: ipv6-address

inbound

Description: Specifies that the ACL will apply to incoming packets on the interface.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6-addr

Description: Set the IPv6 address of the management interface.

Type: string

Format: ipv6-address-plen

v6-acl-name

Description: Applies ACL rules to the management interface.

Type: string

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

ip

Specification
Type object

control-apps-use-mgmt-port

Description: Enable use of the management interface as the source interface for automated management traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

default-gateway

Description: Specify the default gateway for the out-of-band management interface.

Type: string

Format: ipv4-address

dhcp

Description: Enable Dynamic Host Configuration Protocol (DHCP) to configure multiple IP addresses on an Ethernet data interface.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: dhcp and ipv4-address are mutually exclusive

ipv4-address

Description: Set the IPv4 address of the management interface

Type: string

Format: ipv4-address

Mutual Exclusion: ipv4-address and dhcp are mutually exclusive

ipv4-netmask

Description: Set the IPv4 subnet mask

Type: string

Format: ipv4-netmask

access-list

Specification
Type object

acl-id

Description: Specify the ID of a configured ACL

Type: number

Range: 1-199

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

acl-name

Description: Specify the name of a configured ACL

Type: string