.. _network_spanning_tree:

network spanning-tree
=====================

spanning tree protocol config


spanning-tree Specification
---------------------------

	===================================== ==============================================================
	 **Parameter**                         **Value** 

	===================================== ==============================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      spanning-tree

	 **Element URI**                       /axapi/v3/network/spanning-tree

	 **Element Attributes**                spanning-tree_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`spanning-tree schema <network-spanning-tree/network-spanning-tree.txt>`
	===================================== ==============================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/network/spanning-tree



.. raw:: html

   </td><td valign = 'top'>


spanning-tree_attributes



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _2347_spanning-tree_attributes:

spanning-tree attributes
------------------------

    **mode**

        **Description:** mode is a **JSON Block**.  Please see below for :ref:`2347_mode` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode <network_spanning_tree_mode>`

.. _2347_mode:

mode
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **info**

        **Description:** info is a **JSON Block**.  Please see below for :ref:`2347_mode_info` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/info <network_spanning_tree_mode_info>`

    **interface**

        **Description:** interface is a **JSON Block**.  Please see below for :ref:`2347_mode_interface` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/interface <network_spanning_tree_mode_interface>`

    **mstp**

        **Description:** mstp is a **JSON Block**.  Please see below for :ref:`2347_mode_mstp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/mstp <network_spanning_tree_mode_mstp>`

    **rstp**

        **Description:** rstp is a **JSON Block**.  Please see below for :ref:`2347_mode_rstp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/rstp <network_spanning_tree_mode_rstp>`

    **stp**

        **Description:** stp is a **JSON Block**.  Please see below for :ref:`2347_mode_stp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/spanning-tree/mode/stp <network_spanning_tree_mode_stp>`

.. _2347_mode_info:

mode_info
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2347_mode_interface:

mode_interface
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2347_mode_stp:

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

.. _2347_mode_rstp:

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

.. _2347_mode_mstp:

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} <network_spanning_tree_mode_mstp_instance>`

    **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:`2347_mode_mstp_revision-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2347_mode_mstp_revision-cfg:

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

.. _2347_mode_mstp_instance-list:

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

.. _2347_mode_mstp_instance-list_vlan-list:

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 <network_vlan>`

    **vlan-start**

        **Description** VLAN ID

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/network/vlan <network_vlan>`