network¶
Configure Network Command
network Specification¶
Parameter Value Type Intermediate Resource Element Name network Element URI /axapi/v3/network Element Attributes network_attributes Partition Visibility None Schema network schemaOperations 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
available-trunk-list
Description: available-trunk-list is a JSON Block. Please see below for available-trunk-list
Type: Object
Reference Object: /axapi/v3/network/available-trunk-list
bfd
Description: bfd is a JSON Block. Please see below for bfd
Type: Object
Reference Object: /axapi/v3/network/bfd
bpdu-fwd-group-list
Type: List
Reference Object: /axapi/v3/network/bpdu-fwd-group/{bpdu-fwd-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
Type: List
Reference Object: /axapi/v3/network/lacp-passthrough/{peer-from}+{peer-to}
lif-stats
Description: lif-stats is a JSON Block. Please see below for lif-stats
Type: Object
Reference Object: /axapi/v3/network/lif-stats
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
trunk
Description: trunk is a JSON Block. Please see below for trunk
Type: Object
Reference Object: /axapi/v3/network/trunk
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-group-list
Type: List
Reference Object: /axapi/v3/network/vlan-group/{vlan-num-start}+{vlan-num-end}
vlan-list
Type: List
Reference Object: /axapi/v3/network/vlan/{vlan-num}
arp¶
Specification Value Type object dynamic
Description: dynamic is a JSON Block. Please see below for arp_dynamic
Type: Object
Reference Object: /axapi/v3/network/arp/dynamic
static-list
Type: List
Reference Object: /axapi/v3/network/arp/static/{ip-addr}+{vlan}
arp_dynamic¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
arp_static-list¶
Specification Value Type list Block object keys ethernet
Description Ethernet port (Port Value)
Type: number
Format: interface
Range: 3-32
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
Maximum Length: 64 characters
Maximum Length: 1 characters
vlan
vlan-list¶
Specification Value Type list Block object keys name
Description VLAN name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
tagged-eth-list
Type: Listtagged-trunk-list
Type: Listuntagged-eth-list
Type: Listuntagged-lif
Description Logical tunnel interface (Logical tunnel interface name)
Type: string
Maximum Length: 15 characters
Maximum Length: 1 characters
untagged-trunk-list
Type: Listuser-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
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 Value 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 Value Type list Block object keys untagged-ethernet-end
Description Ethernet port
Type: number
Format: interface
Reference Object: /axapi/v3/interface/ethernet
untagged-ethernet-start
Description Ethernet port (Interface number)
Type: number
Format: interface
Reference Object: /axapi/v3/interface/ethernet
vlan-list_tagged-eth-list¶
Specification Value 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_tagged-trunk-list¶
Specification Value 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 Value Type list Block object keys peer-from
Description Peer member to forward received LACP packets
Type: number
Format: interface
Range: 0-160
peer-to
Description Peer member to forward received LACP packets
Type: number
Format: interface
Range: 0-160
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
bpdu-fwd-group-list¶
Specification Value Type list Block object keys bpdu-fwd-group-number
Description
Type: number
Range: 1-8
ethernet-list
Type: Listuser-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
bpdu-fwd-group-list_ethernet-list¶
Specification Value 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 Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-stats¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
available-trunk-list¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
mac-age-time¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
icmpv6-rate-limit¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
mac-address¶
Specification Value Type object dynamic
Description: dynamic is a JSON Block. Please see below for mac-address_dynamic
Type: Object
Reference Object: /axapi/v3/network/mac-address/dynamic
static-list
Type: List
Reference Object: /axapi/v3/network/mac-address/static/{mac}+{vlan}
mac-address_dynamic¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
mac-address_static-list¶
Specification Value 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
Range: 3-144
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vlan
lacp¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
arp-timeout¶
Specification Value Type object timeout
Description ARP entry timeout
Type: number
Range: 60-86400
Default: 300
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
bfd¶
Specification Value 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 bfd_interval-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
bfd_interval-cfg¶
Specification Value 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
lif-stats¶
Specification Value Type object enable
Description Enable LIF interface stats generation
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp-rate-limit¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
vlan-group-list¶
Specification Value Type list Block object keys eth-list
Type: Listtrunk-list
Type: Listuser-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vlan-num-end
Description End of VLAN range
Type: number
Range: 2-4094
vlan-num-start
Description Start of VLAN range
Type: number
Range: 2-4094
vlan-group-list_eth-list¶
Specification Value Type list Block object keys ethernet-end
Description Ethernet port (Interface number)
Type: number
Format: interface
ethernet-start
Description Ethernet port (Interface number)
Type: number
Format: interface
Reference Object: /axapi/v3/interface/ethernet
vlan-group-list_trunk-list¶
Specification Value Type list Block object keys trunk-end
trunk-start
lldp¶
Specification Value Type object enable-cfg
Description: enable-cfg is a JSON Block. Please see below for lldp_enable-cfg
Type: Object
management-address
Description: management-address is a JSON Block. Please see below for lldp_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 lldp_notification-cfg
Type: Object
system-description
Description Configure lldp system description
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
system-name
Description Configure lldp system name
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
tx-set
Description: tx-set is a JSON Block. Please see below for lldp_tx-set
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lldp_management-address¶
Specification Value Type object dns-list
Type: List
Reference Object: /axapi/v3/network/lldp/management-address/dns/{dns}
ipv4-addr-list
Type: List
Reference Object: /axapi/v3/network/lldp/management-address/ipv4-addr/{ipv4}
ipv6-addr-list
Type: List
Reference Object: /axapi/v3/network/lldp/management-address/ipv6-addr/{ipv6}
lldp_management-address_ipv6-addr-list¶
Specification Value Type list Block object keys interface-ipv6
Description: interface-ipv6 is a JSON Block. Please see below for lldp_management-address_ipv6-addr-list_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
Maximum Length: 64 characters
Maximum Length: 1 characters
lldp_management-address_ipv6-addr-list_interface-ipv6¶
Specification Value Type object ipv6-eth
Description configure lldp management-address interface ethernet (lldp management-address interface port number)
Type: number
Format: interface
Range: 70-1
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 Value Type list Block object keys interface-ipv4
Description: interface-ipv4 is a JSON Block. Please see below for lldp_management-address_ipv4-addr-list_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
Maximum Length: 64 characters
Maximum Length: 1 characters
lldp_management-address_ipv4-addr-list_interface-ipv4¶
Specification Value Type object ipv4-eth
Description configure lldp management-address interface ethernet (lldp management-address interface port number)
Type: number
Format: interface
Range: 3-128
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 Value Type list Block object keys dns
Description Configure lldp management-address, subtype is dns (lldp management-address dns address)
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
interface
Description: interface is a JSON Block. Please see below for lldp_management-address_dns-list_interface
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lldp_management-address_dns-list_interface¶
Specification Value Type object ethernet
Description configure lldp management-address interface ethernet (lldp management-address interface port number)
Type: number
Format: interface
Range: 3-112
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 Value 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 Value 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 Value 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