.. _network: 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** shared **Schema** :download:`network schema ` ===================================== ================================================ **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/network .. raw:: html network_attributes .. raw:: html
.. _2373_network_attributes: network attributes ------------------ **arp** **Description:** arp is a **JSON Block**. Please see below for :ref:`2373_arp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/arp ` **arp-timeout** **Description:** arp-timeout is a **JSON Block**. Please see below for :ref:`2373_arp-timeout` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/arp-timeout ` **available-trunk-list** **Description:** available-trunk-list is a **JSON Block**. Please see below for :ref:`2373_available-trunk-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/available-trunk-list ` **bfd** **Description:** bfd is a **JSON Block**. Please see below for :ref:`2373_bfd` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/bfd ` **bpdu-fwd-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/bpdu-fwd-group/{bpdu-fwd-group-number} ` **bridge-vlan-group-list** **Type:** List **Reference Object:** :doc:`/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 :ref:`2373_icmp-rate-limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/icmp-rate-limit ` **icmpv6-rate-limit** **Description:** icmpv6-rate-limit is a **JSON Block**. Please see below for :ref:`2373_icmpv6-rate-limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/icmpv6-rate-limit ` **l2-bfd** **Description:** l2-bfd is a **JSON Block**. Please see below for :ref:`2373_l2-bfd` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/l2-bfd ` **lacp** **Description:** lacp is a **JSON Block**. Please see below for :ref:`2373_lacp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/lacp ` **lacp-passthrough-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/lacp-passthrough/{peer-from}+{peer-to} ` **lif-stats** **Description:** lif-stats is a **JSON Block**. Please see below for :ref:`2373_lif-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/lif-stats ` **lldp** **Description:** lldp is a **JSON Block**. Please see below for :ref:`2373_lldp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/lldp ` **mac-address** **Description:** mac-address is a **JSON Block**. Please see below for :ref:`2373_mac-address` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/mac-address ` **mac-age-time** **Description:** mac-age-time is a **JSON Block**. Please see below for :ref:`2373_mac-age-time` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/mac-age-time ` **spanning-tree** **Description:** spanning-tree is a **JSON Block**. Please see below for :ref:`2373_spanning-tree` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/spanning-tree ` **trunk** **Description:** trunk is a **JSON Block**. Please see below for :ref:`2373_trunk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/trunk ` **twamp** **Description:** twamp is a **JSON Block**. Please see below for :ref:`2373_twamp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/twamp ` **ve-stats** **Description:** ve-stats is a **JSON Block**. Please see below for :ref:`2373_ve-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/ve-stats ` **virtual-wire-ethernet-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/virtual-wire-ethernet-group/{group-id} ` **virtual-wire-global** **Description:** virtual-wire-global is a **JSON Block**. Please see below for :ref:`2373_virtual-wire-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/virtual-wire-global ` **virtual-wire-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/virtual-wire/{virtual-wire-id} ` **virtual-wire-vlan-pair-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/virtual-wire-vlan-pair/{pair-id} ` **virtual-wire-vlan-pair-set-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/virtual-wire-vlan-pair-set/{set-id} ` **vlan-global** **Description:** vlan-global is a **JSON Block**. Please see below for :ref:`2373_vlan-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/vlan-global ` **vlan-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/vlan-group/{vlan-num-start}+{vlan-num-end} ` **vlan-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/vlan/{vlan-num} ` .. _2373_arp: arp ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dynamic** **Description:** dynamic is a **JSON Block**. Please see below for :ref:`2373_arp_dynamic` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/arp/dynamic ` **static-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/arp/static/{ip-addr}+{vlan} ` .. _2373_arp_dynamic: arp_dynamic ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_arp_static-list: arp_static-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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-4096 **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** **Description** VLAN ID **Type:** number **Range:** 2-4094 **Reference Object:** :doc:`/axapi/v3/network/vlan ` .. _2373_bpdu-fwd-group-list: bpdu-fwd-group-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bpdu-fwd-group-number** **Description** **Type:** number **Range:** 1-8 **ethernet-list** **Type:** List **user-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 .. _2373_bpdu-fwd-group-list_ethernet-list: 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 .. _2373_vlan-global: 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 **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_vlan-global_sampling-enable: vlan-global_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'xparent_vlan_list_err': Transparent Mode VLAN List Errors; **Type:** string **Supported Values:** all, xparent_vlan_list_err .. _2373_lacp: 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 .. _2373_twamp: twamp ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **responder** **Description:** responder is a **JSON Block**. Please see below for :ref:`2373_twamp_responder` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/twamp/responder ` .. _2373_twamp_responder: twamp_responder ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable-both-ip-ipv6** **Description** Enable both IP and IPv6 TWAMP packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** enable-both-ip-ipv6, enable-ip, and enable-ipv6 are mutually exclusive **enable-ip** **Description** Enable IP TWAMP packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** enable-ip, enable-ipv6, and enable-both-ip-ipv6 are mutually exclusive **enable-ipv6** **Description** Enable IPv6 TWAMP packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** enable-ipv6, enable-ip, and enable-both-ip-ipv6 are mutually exclusive **ip** **Description:** ip is a **JSON Block**. Please see below for :ref:`2373_twamp_responder_ip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/twamp/responder/ip ` **ipv6** **Description:** ipv6 is a **JSON Block**. Please see below for :ref:`2373_twamp_responder_ipv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/twamp/responder/ipv6 ` **port** **Description** Port number **Type:** number **Range:** 1024-65535 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_twamp_responder_ip: twamp_responder_ip ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **acl-id** **Description** ACL id **Type:** number **Range:** 1-199 **Mutual Exclusion:** acl-id and acl-name are mutually exclusive **acl-name** **Description** Apply a named access list (Access List name) **Type:** string **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Mutual Exclusion:** acl-name and acl-id are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ip/access-list ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_twamp_responder_ipv6: twamp_responder_ipv6 ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **v6-acl-name** **Description** Apply an access list (Named Access List) **Type:** string **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/ipv6/access-list ` .. _2373_lif-stats: 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 .. _2373_virtual-wire-vlan-pair-list: virtual-wire-vlan-pair-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **pair-id** **Description** virtual wire vlan pair id **Type:** number **Range:** 1-16 **user-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 **vlan1** **Description** first vlan in the pair **Type:** number **Range:** 2-4094 **vlan2** **Description** second vlan in the pair **Type:** number **Range:** 2-4094 .. _2373_arp-timeout: 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 .. _2373_bfd: 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 :ref:`2373_bfd_interval-cfg` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_bfd_interval-cfg: bfd_interval-cfg ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **interval** **Description** Transmit interval between BFD packets (Milliseconds (default: 800)) **Type:** number **Range:** 48-1000 **Default:** 800 **min-rx** **Description** Minimum receive interval capability (Milliseconds (default: 800)) **Type:** number **Range:** 48-1000 **Default:** 800 **multiplier** **Description** Multiplier value used to compute holddown (value used to multiply the interval (default: 4)) **Type:** number **Range:** 3-50 **Default:** 4 .. _2373_mac-age-time: 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 .. _2373_virtual-wire-vlan-pair-set-list: virtual-wire-vlan-pair-set-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **set-cfg** **Type:** List **set-id** **Description** virtual wire vlan set id **Type:** number **Range:** 1-8 **user-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 .. _2373_virtual-wire-vlan-pair-set-list_set-cfg: virtual-wire-vlan-pair-set-list_set-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **virtual-wire-vlan-pair** **Description** virtual wire vlan pair id **Type:** number **Range:** 1-16 **Reference Object:** :doc:`/axapi/v3/network/virtual-wire-vlan-pair ` .. _2373_virtual-wire-list: virtual-wire-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **eth1** **Description** **Type:** number **Format:** interface **Reference Object:** :doc:`/axapi/v3/interface/ethernet ` **eth2** **Description** **Type:** number **Format:** interface **Reference Object:** :doc:`/axapi/v3/interface/ethernet ` **group1** **Description** **Type:** number **Range:** 1-16 **Reference Object:** :doc:`/axapi/v3/network/virtual-wire-ethernet-group ` **group2** **Description** **Type:** number **Range:** 1-16 **Reference Object:** :doc:`/axapi/v3/network/virtual-wire-ethernet-group ` **trunk1** **Description** **Type:** number **Range:** 1-4096 **Reference Object:** :doc:`/axapi/v3/interface/trunk ` **trunk2** **Description** **Type:** number **Range:** 1-4096 **Reference Object:** :doc:`/axapi/v3/interface/trunk ` **user-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 **virtual-wire-id** **Description** virtual wire id **Type:** number **Range:** 1-32 .. _2373_bridge-vlan-group-list: bridge-vlan-group-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 63 characters **Maximum Length:** 1 characters **user-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** Virtual Ethernet Port (Virtual Ethernet Port number) **Type:** number **Range:** 2-4094 **Reference Object:** :doc:`/axapi/v3/network/vlan ` **vlan-list** **Type:** List .. _2373_bridge-vlan-group-list_vlan-list: bridge-vlan-group-list_vlan-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **vlan-end** **Description** VLAN id **Type:** number **Reference Object:** :doc:`/axapi/v3/network/vlan ` **vlan-start** **Description** VLAN id **Type:** number **Reference Object:** :doc:`/axapi/v3/network/vlan ` .. _2373_mac-address: mac-address ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dynamic** **Description:** dynamic is a **JSON Block**. Please see below for :ref:`2373_mac-address_dynamic` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/mac-address/dynamic ` **static-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/mac-address/static/{mac}+{vlan} ` .. _2373_mac-address_dynamic: mac-address_dynamic ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_mac-address_static-list: 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) **Type:** number **Format:** interface **redirect-dummy-mac** **Description** Dummy for redirect use **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 **vlan** **Description** VLAN Id **Type:** number **Range:** 2-4094 **Reference Object:** :doc:`/axapi/v3/network/vlan ` .. _2373_spanning-tree: spanning-tree ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **mode** **Description:** mode is a **JSON Block**. Please see below for :ref:`2373_spanning-tree_mode` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode ` .. _2373_spanning-tree_mode: spanning-tree_mode ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **info** **Description:** info is a **JSON Block**. Please see below for :ref:`2373_spanning-tree_mode_info` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/info ` **interface** **Description:** interface is a **JSON Block**. Please see below for :ref:`2373_spanning-tree_mode_interface` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/interface ` **mstp** **Description:** mstp is a **JSON Block**. Please see below for :ref:`2373_spanning-tree_mode_mstp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/mstp ` **rstp** **Description:** rstp is a **JSON Block**. Please see below for :ref:`2373_spanning-tree_mode_rstp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/rstp ` **stp** **Description:** stp is a **JSON Block**. Please see below for :ref:`2373_spanning-tree_mode_stp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/stp ` .. _2373_spanning-tree_mode_info: spanning-tree_mode_info ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_spanning-tree_mode_interface: spanning-tree_mode_interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_spanning-tree_mode_stp: spanning-tree_mode_stp ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** enable spanning tree RSTP mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **priority** **Description** set bridge priority **Type:** number **Range:** 0-61440 **Default:** 32768 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vlan-start** **Description** VLAN ID **Type:** number **Range:** 2-4094 .. _2373_spanning-tree_mode_rstp: spanning-tree_mode_rstp ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** enable spanning tree RSTP mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **priority** **Description** set bridge priority **Type:** number **Range:** 0-61440 **Default:** 32768 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vlan-start** **Description** VLAN ID **Type:** number **Range:** 2-4094 .. _2373_spanning-tree_mode_mstp: spanning-tree_mode_mstp ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** Enable spanning tree MSTP mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **instance-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/mstp/instance/{instance-start} ` **priority** **Description** Set bridge priority **Type:** number **Range:** 0-61440 **Default:** 32768 **revision-cfg** **Description:** revision-cfg is a **JSON Block**. Please see below for :ref:`2373_spanning-tree_mode_mstp_revision-cfg` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_spanning-tree_mode_mstp_revision-cfg: spanning-tree_mode_mstp_revision-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **name** **Description** Set MSTP revision name **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **revision** **Description** Set MSTP revision level and name **Type:** number **Range:** 0-65535 .. _2373_spanning-tree_mode_mstp_instance-list: spanning-tree_mode_mstp_instance-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **instance-start** **Description** Instance ID **Type:** number **Range:** 1-4094 **priority** **Description** Set instance priority **Type:** number **Range:** 0-2147483647 **Default:** 32768 **user-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-list** **Type:** List .. _2373_spanning-tree_mode_mstp_instance-list_vlan-list: spanning-tree_mode_mstp_instance-list_vlan-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **vlan-end** **Description** **Type:** number **Reference Object:** :doc:`/axapi/v3/network/vlan ` **vlan-start** **Description** VLAN ID **Type:** number **Reference Object:** :doc:`/axapi/v3/network/vlan ` .. _2373_lldp: lldp ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable-cfg** **Description:** enable-cfg is a **JSON Block**. Please see below for :ref:`2373_lldp_enable-cfg` **Type:** Object **management-address** **Description:** management-address is a **JSON Block**. Please see below for :ref:`2373_lldp_management-address` **Type:** Object **Reference Object:** :doc:`/axapi/v3/network/lldp/management-address ` **notification-cfg** **Description:** notification-cfg is a **JSON Block**. Please see below for :ref:`2373_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 :ref:`2373_lldp_tx-set` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_lldp_management-address: lldp_management-address ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dns-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/lldp/management-address/dns/{dns} ` **ipv4-addr-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/lldp/management-address/ipv4-addr/{ipv4} ` **ipv6-addr-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/network/lldp/management-address/ipv6-addr/{ipv6} ` .. _2373_lldp_management-address_ipv6-addr-list: 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 :ref:`2373_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 .. _2373_lldp_management-address_ipv6-addr-list_interface-ipv6: 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 **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 .. _2373_lldp_management-address_ipv4-addr-list: 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 :ref:`2373_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 .. _2373_lldp_management-address_ipv4-addr-list_interface-ipv4: 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 **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 .. _2373_lldp_management-address_dns-list: 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 :ref:`2373_lldp_management-address_dns-list_interface` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_lldp_management-address_dns-list_interface: 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 **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 .. _2373_lldp_notification-cfg: 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 .. _2373_lldp_tx-set: 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 .. _2373_lldp_enable-cfg: 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 .. _2373_l2-bfd: l2-bfd ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ether-type** **Description** Ethernet paylaod type for L2BFD packets, help-val 16 bit hex value, default is hex 88B6 **Type:** string **Format:** time-hh:mm **Maximum Length:** 4 characters **Maximum Length:** 1 characters **multiplier** **Description** Multiplier value used to compute holddown (value used to multiply the interval (default: 4)) **Type:** number **Range:** 3-50 **Default:** 4 **rx-interval** **Description** Minimum receive interval capability (Milliseconds (default: 800)) **Type:** number **Range:** 48-1000 **Default:** 800 **tx-interval** **Description** Transmit interval between BFD packets (Milliseconds (default: 800)) **Type:** number **Range:** 48-1000 **Default:** 800 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_ve-stats: 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 .. _2373_virtual-wire-global: virtual-wire-global ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **src-mac-learning** **Description** Update source mac information for all interfaces **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **update-active-vlan** **Description** 'all': all; 'l3-packet': l3-packet(default); **Type:** string **Supported Values:** all, l3-packet **Default:** l3-packet **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vlan-update-period** **Description** Update period in second (default is 30) **Type:** number **Range:** 1-255 **Default:** 30 .. _2373_virtual-wire-global_sampling-enable: virtual-wire-global_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'vlan-update': VLAN update; 'mac-update': MAC update; **Type:** string **Supported Values:** all, vlan-update, mac-update, vlan-pair-update .. _2373_virtual-wire-ethernet-group-list: virtual-wire-ethernet-group-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **eth-list** **Type:** List **group-id** **Description** **Type:** number **Range:** 1-16 **trunk-list** **Type:** List **user-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 .. _2373_virtual-wire-ethernet-group-list_eth-list: virtual-wire-ethernet-group-list_eth-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **eth-end** **Description** **Type:** number **Format:** interface **Reference Object:** :doc:`/axapi/v3/interface/ethernet ` **eth-start** **Description** **Type:** number **Format:** interface **Reference Object:** :doc:`/axapi/v3/interface/ethernet ` .. _2373_virtual-wire-ethernet-group-list_trunk-list: virtual-wire-ethernet-group-list_trunk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **trunk-end** **Description** **Type:** number **Reference Object:** :doc:`/axapi/v3/interface/trunk ` **trunk-start** **Description** **Type:** number **Reference Object:** :doc:`/axapi/v3/interface/trunk ` .. _2373_trunk: trunk ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_vlan-list: 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 **sampling-enable** **Type:** List **shared-vlan** **Description** Configure VLAN as a shared VLAN **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tagged-eth-list** **Type:** List **tagged-trunk-list** **Type:** List **traffic-distribution-mode** **Description** 'sip': sip; 'dip': dip; 'primary': primary; 'blade': blade; 'l4-src-port': l4-src-port; 'l4-dst-port': l4-dst-port; **Type:** string **Supported Values:** sip, dip, primary, blade, l4-src-port, l4-dst-port **untagged-eth-list** **Type:** List **untagged-lif** **Description** Logical tunnel interface (Logical tunnel interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **untagged-trunk-list** **Type:** List **user-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 .. _2373_vlan-list_untagged-trunk-list: 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 .. _2373_vlan-list_untagged-eth-list: vlan-list_untagged-eth-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **untagged-ethernet-end** **Description** Ethernet port **Type:** number **Format:** interface **Reference Object:** :doc:`/axapi/v3/interface/ethernet ` **untagged-ethernet-start** **Description** Ethernet port (Interface number) **Type:** number **Format:** interface **Reference Object:** :doc:`/axapi/v3/interface/ethernet ` .. _2373_vlan-list_tagged-eth-list: 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 .. _2373_vlan-list_sampling-enable: vlan-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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; 'shared_vlan_partition_switched_counter': SVLAN Partition switched counter; **Type:** string **Supported Values:** all, broadcast_count, multicast_count, ip_multicast_count, unknown_unicast_count, mac_movement_count, shared_vlan_partition_switched_counter .. _2373_vlan-list_tagged-trunk-list: 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 .. _2373_icmp-rate-limit: 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 .. _2373_available-trunk-list: available-trunk-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_icmpv6-rate-limit: 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 .. _2373_lacp-passthrough-list: lacp-passthrough-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2373_vlan-group-list: vlan-group-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **eth-list** **Type:** List **trunk-list** **Type:** List **user-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 .. _2373_vlan-group-list_eth-list: 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:** :doc:`/axapi/v3/interface/ethernet ` .. _2373_vlan-group-list_trunk-list: vlan-group-list_trunk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **trunk-end** **Description** **Type:** number **Reference Object:** :doc:`/axapi/v3/interface/trunk ` **trunk-start** **Description** **Type:** number **Reference Object:** :doc:`/axapi/v3/interface/trunk `