network

Configure Network Command.

network Specification

Type Intermediate Resource
Element Name network
Element URI /axapi/v3/network
Element Attributes network_attributes
Schema network schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/network

network_attributes

network Attributes

arp

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

Type: Object

Reference Object: /axapi/v3/network/arp

arp-timeout

Description: arp-timeout is a JSON Block . Please see below for arp-timeout

Type: Object

Reference Object: /axapi/v3/network/arp-timeout

bfd

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

Type: Object

Reference Object: /axapi/v3/network/bfd

bpdu-fwd-group-list

Description: bpdu-fwd-group-list is a JSON List . Please see below for bpdu-fwd-group-list

Type: List

Reference Object: /axapi/v3/network/bpdu-fwd-group/{bpdu-fwd-group-number}

bridge-vlan-group-list

Description: bridge-vlan-group-list is a JSON List . Please see below for bridge-vlan-group-list

Type: List

Reference Object: /axapi/v3/network/bridge-vlan-group/{bridge-vlan-group-number}

icmp-rate-limit

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

Type: Object

Reference Object: /axapi/v3/network/icmp-rate-limit

icmpv6-rate-limit

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

Type: Object

Reference Object: /axapi/v3/network/icmpv6-rate-limit

lacp

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

Type: Object

Reference Object: /axapi/v3/network/lacp

lacp-passthrough-list

Description: lacp-passthrough-list is a JSON List . Please see below for lacp-passthrough-list

Type: List

Reference Object: /axapi/v3/network/lacp-passthrough/{peer-from}+{peer-to}

lldp

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

Type: Object

Reference Object: /axapi/v3/network/lldp

mac-address

Description: mac-address is a JSON Block . Please see below for mac-address

Type: Object

Reference Object: /axapi/v3/network/mac-address

mac-age-time

Description: mac-age-time is a JSON Block . Please see below for mac-age-time

Type: Object

Reference Object: /axapi/v3/network/mac-age-time

ve-stats

Description: ve-stats is a JSON Block . Please see below for ve-stats

Type: Object

Reference Object: /axapi/v3/network/ve-stats

vlan-global

Description: vlan-global is a JSON Block . Please see below for vlan-global

Type: Object

Reference Object: /axapi/v3/network/vlan-global

vlan-list

Description: vlan-list is a JSON List . Please see below for vlan-list

Type: List

Reference Object: /axapi/v3/network/vlan/{vlan-num}

arp

Specification
Type object

static-list

Description: static-list is a JSON List . Please see below for l283_static-list

Type: List

Reference Object: /axapi/v3/network/arp/static/{ip-addr}+{vlan}

arp.static-list

Specification
Type list
Block object keys

ethernet

Description: Ethernet port (Port Value)

Type: number

Format: interface

Mutual Exclusion: ethernet and trunk are mutually exclusive

ip-addr

Description: IP address

Type: string

Format: ipv4-address

mac-addr

Description: MAC address

Type: string

Format: mac-address

trunk

Description: Trunk group

Type: number

Range: 1-16

Mutual Exclusion: trunk and ethernet are mutually exclusive

uuid

Description: uuid of the object

Type: string

vlan

Description: VLAN ID

Type: number

Range: 2-4094

Reference Object: /axapi/v3/network/vlan

vlan-list

Specification
Type list
Block object keys

name

Description: VLAN name

Type: string

Format: string-rlx

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l283_sampling-enable

Type: List

tagged-eth-list

Description: tagged-eth-list is a JSON List . Please see below for l283_tagged-eth-list

Type: List

tagged-trunk-list

Description: tagged-trunk-list is a JSON List . Please see below for l283_tagged-trunk-list

Type: List

untagged-eth-list

Description: untagged-eth-list is a JSON List . Please see below for l283_untagged-eth-list

Type: List

untagged-lif

Description: Logical tunnel interface (Logical tunnel interface number)

Type: number

Range: 1-128

untagged-trunk-list

Description: untagged-trunk-list is a JSON List . Please see below for l283_untagged-trunk-list

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

ve

Description: ve number

Type: number

Range: 2-4094

vlan-num

Description: VLAN number

Type: number

Range: 2-4094

vlan-list.untagged-trunk-list

Specification
Type list
Block object keys

untagged-trunk-end

Description: Trunk Group

Type: number

untagged-trunk-start

Description: Trunk groups

Type: number

vlan-list.untagged-eth-list

Specification
Type list
Block object keys

untagged-ethernet-end

Description: Ethernet port

Type: number

Format: interface

untagged-ethernet-start

Description: Ethernet port (Interface number)

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

vlan-list.tagged-eth-list

Specification
Type list
Block object keys

tagged-ethernet-end

Description: Ethernet port

Type: number

Format: interface

tagged-ethernet-start

Description: Ethernet port (Interface number)

Type: number

Format: interface

vlan-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘broadcast_count’: Broadcast counter; ‘multicast_count’: Multicast counter; ‘ip_multicast_count’: IP Multicast counter; ‘unknown_unicast_count’: Unknown Unicast counter; ‘mac_movement_count’: Mac Movement counter;

Type: string

Supported Values: all, broadcast_count, multicast_count, ip_multicast_count, unknown_unicast_count, mac_movement_count

vlan-list.tagged-trunk-list

Specification
Type list
Block object keys

tagged-trunk-end

Description: Trunk Group

Type: number

tagged-trunk-start

Description: Trunk groups

Type: number

lacp-passthrough-list

Specification
Type list
Block object keys

peer-from

Description: Peer member to forward received LACP packets

Type: number

Format: interface

peer-to

Description: Peer member to forward received LACP packets

Type: number

Format: interface

uuid

Description: uuid of the object

Type: string

bpdu-fwd-group-list

Specification
Type list
Block object keys

bpdu-fwd-group-number

Description:

Type: number

Range: 1-8

ethernet-list

Description: ethernet-list is a JSON List . Please see below for l283_ethernet-list

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

bpdu-fwd-group-list.ethernet-list

Specification
Type list
Block object keys

ethernet-end

Description: Ethernet Port

Type: number

Format: interface

ethernet-start

Description: Ethernet Port (Interface number)

Type: number

Format: interface

vlan-global

Specification
Type object

enable-def-vlan-l2-forwarding

Description: Enable layer 2 forwarding on default vlan

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l3-vlan-fwd-disable

Description: Disable L3 forwarding between VLANs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

ve-stats

Specification
Type object

enable

Description: Enable vlan ve interface stats generation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

mac-age-time

Specification
Type object

aging-time

Description: Set aging period in seconds for all MAC interfaces (default 300 seconds)

Type: number

Range: 10-600

Default: 300

uuid

Description: uuid of the object

Type: string

icmpv6-rate-limit

Specification
Type object

icmpv6-lockup

Description: Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)

Type: number

Range: 1-65535

icmpv6-lockup-period

Description: Lockup period (second)

Type: number

Range: 1-16383

icmpv6-normal-rate-limit

Description: Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit

Type: number

Range: 1-65535

uuid

Description: uuid of the object

Type: string

lacp

Specification
Type object

system-priority

Description: LACP system priority (LACP system priority, 1-65535, default 32768)

Type: number

Range: 1-65535

Default: 32768

uuid

Description: uuid of the object

Type: string

arp-timeout

Specification
Type object

timeout

Description: ARP entry timeout

Type: number

Range: 60-86400

Default: 300

uuid

Description: uuid of the object

Type: string

bfd

Specification
Type object

echo

Description: Enable BFD Echo

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable

Description: Enable BFD

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interval-cfg

Description: interval-cfg is a JSON Block . Please see below for l283_interval-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

bfd.interval-cfg

Specification
Type object

interval

Description: Transmit interval between BFD packets (Milliseconds)

Type: number

Range: 48-1000

min-rx

Description: Minimum receive interval capability (Milliseconds)

Type: number

Range: 48-1000

multiplier

Description: Multiplier value used to compute holddown (value used to multiply the interval)

Type: number

Range: 3-50

icmp-rate-limit

Specification
Type object

icmp-lockup

Description: Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)

Type: number

Range: 1-65535

icmp-lockup-period

Description: Lockup period (second)

Type: number

Range: 1-16383

icmp-normal-rate-limit

Description: Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit

Type: number

Range: 1-65535

uuid

Description: uuid of the object

Type: string

bridge-vlan-group-list

Specification
Type list
Block object keys

bridge-vlan-group-number

Description: Bridge VLAN Group Number

Type: number

Range: 1-255

forward-traffic

Description: ‘forward-all-traffic’: Forward all traffic between bridge members; ‘forward-ip-traffic’: Forward only IP traffic between bridge members (default);

Type: string

Supported Values: forward-all-traffic, forward-ip-traffic

Default: forward-ip-traffic

name

Description: Bridge Group Name

Type: string

Format: string-rlx

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

ve

Description: Virtual Ethernet Port (Virtual Ethernet Port number)

Type: number

Range: 2-4094

Reference Object: /axapi/v3/network/vlan

vlan-list

Description: vlan-list is a JSON List . Please see below for vlan-list

Type: List

bridge-vlan-group-list.vlan-list

Specification
Type list
Block object keys

vlan-end

Description: VLAN id

Type: number

Reference Object: /axapi/v3/network/vlan

vlan-start

Description: VLAN id

Type: number

Reference Object: /axapi/v3/network/vlan

mac-address

Specification
Type object

static-list

Description: static-list is a JSON List . Please see below for l283_static-list

Type: List

Reference Object: /axapi/v3/network/mac-address/static/{mac}+{vlan}

mac-address.static-list

Specification
Type list
Block object keys

dest

Description: Trap MAC with this DA to CPU

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mac

Description: Configure a Static MAC address

Type: string

Format: mac-address

port

Description: Ethernet Port on which the Address is applicable (Port Value (Defualt VLAN is 1))

Type: number

Format: interface

uuid

Description: uuid of the object

Type: string

vlan

Description: VLAN Id

Type: number

Range: 2-4094

Reference Object: /axapi/v3/network/vlan

lldp

Specification
Type object

enable-cfg

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

Type: Object

management-address

Description: management-address is a JSON Block . Please see below for l283_management-address

Type: Object

Reference Object: /axapi/v3/network/lldp/management-address

notification-cfg

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

Type: Object

system-description

Description: Configure lldp system description

Type: string

system-name

Description: Configure lldp system name

Type: string

tx-set

Description: tx-set is a JSON Block . Please see below for l283_tx-set

Type: Object

uuid

Description: uuid of the object

Type: string

lldp.management-address

Specification
Type object

dns-list

Description: dns-list is a JSON List . Please see below for l283_dns-list

Type: List

Reference Object: /axapi/v3/network/lldp/management-address/dns/{dns}

ipv4-addr-list

Description: ipv4-addr-list is a JSON List . Please see below for l283_ipv4-addr-list

Type: List

Reference Object: /axapi/v3/network/lldp/management-address/ipv4-addr/{ipv4}

ipv6-addr-list

Description: ipv6-addr-list is a JSON List . Please see below for l283_ipv6-addr-list

Type: List

Reference Object: /axapi/v3/network/lldp/management-address/ipv6-addr/{ipv6}

lldp.management-address.ipv6-addr-list

Specification
Type list
Block object keys

interface-ipv6

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

Type: Object

ipv6

Description: Configure lldp management-address, subtype is ipv6 (lldp management-address ipv6 address)

Type: string

Format: ipv6-address

uuid

Description: uuid of the object

Type: string

lldp.management-address.ipv6-addr-list.interface-ipv6

Specification
Type object

ipv6-eth

Description: configure lldp management-address interface ethernet (lldp management-address interface port number)

Type: number

Format: interface

ipv6-mgmt

Description: configure lldp management-address interface management

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6-ve

Description: configure lldp management-address interface ve (lldp management-address interface port number)

Type: number

Range: 2-4094

lldp.management-address.ipv4-addr-list

Specification
Type list
Block object keys

interface-ipv4

Description: interface-ipv4 is a JSON Block . Please see below for l283_interface-ipv4

Type: Object

ipv4

Description: Configure lldp management-address, subtype is ipv4 (lldp management-address ipv4 address)

Type: string

Format: ipv4-address

uuid

Description: uuid of the object

Type: string

lldp.management-address.ipv4-addr-list.interface-ipv4

Specification
Type object

ipv4-eth

Description: configure lldp management-address interface ethernet (lldp management-address interface port number)

Type: number

Format: interface

ipv4-mgmt

Description: configure lldp management-address interface management

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv4-ve

Description: configure lldp management-address interface ve (lldp management-address interface port number)

Type: number

Range: 2-4094

lldp.management-address.dns-list

Specification
Type list
Block object keys

dns

Description: Configure lldp management-address, subtype is dns (lldp management-address dns address)

Type: string

interface

Description: interface is a JSON Block . Please see below for l283_interface

Type: Object

uuid

Description: uuid of the object

Type: string

lldp.management-address.dns-list.interface

Specification
Type object

ethernet

Description: configure lldp management-address interface ethernet (lldp management-address interface port number)

Type: number

Format: interface

Mutual Exclusion: ethernet ve and management are mutually exclusive

management

Description: configure lldp management-address interface management

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: management ethernet and ve are mutually exclusive

ve

Description: configure lldp management-address interface management (lldp management-address interface port number)

Type: number

Range: 2-4094

Mutual Exclusion: ve ethernet and management are mutually exclusive

lldp.notification-cfg

Specification
Type object

interval

Description: Configure lldp notification interval, default is 30 (The lldp notification interval value, default is 30)

Type: number

Range: 5-3600

Default: 30

notification

Description: Enable lldp notification

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lldp.tx-set

Specification
Type object

fast-count

Description: Configure lldp tx fast count value (The lldp tx fast count value, default is 4)

Type: number

Range: 1-8

Default: 4

fast-interval

Description: Configure lldp tx fast interval value (The lldp tx fast interval value, default is 1)

Type: number

Range: 1-3600

Default: 1

hold

Description: Configure lldp tx hold multiplier (The lldp tx hold value, default is 4)

Type: number

Range: 1-10

Default: 4

reinit-delay

Description: Configure lldp tx reinit delay (The lldp tx reinit_delay value, default is 2)

Type: number

Range: 1-10

Default: 2

tx-interval

Description: Configure lldp tx interval (The lldp tx interval value, default is 30)

Type: number

Range: 1-3600

Default: 30

lldp.enable-cfg

Specification
Type object

enable

Description: Enable lldp

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