.. _interface_ethernet_isis:

interface ethernet isis
=======================

ISIS


isis Specification
------------------

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

	===================================== ========================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      isis

	 **Element URI**                       /axapi/v3/interface/ethernet/{ifnum}/isis

	 **Element Attributes**                isis_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`isis schema <interface-ethernet-isis/interface-ethernet-isis.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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/interface/ethernet/{ifnum}/isis



.. raw:: html

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


:ref:`1923_isis_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/interface_ethernet_isis_POST.txt
   :literal:




.. raw:: html

   </div></td></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/interface/ethernet/{ifnum}/isis



.. raw:: html

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


:ref:`1923_isis_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/interface_ethernet_isis_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/interface/ethernet/{ifnum}/isis



.. raw:: html

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


:ref:`1923_isis_attributes`



.. raw:: html

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




.. raw:: html

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


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/interface/ethernet/{ifnum}/isis



.. raw:: html

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


:ref:`1923_isis_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/interface_ethernet_isis_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/interface/ethernet/{ifnum}/isis



.. raw:: html

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


:ref:`1923_isis_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/interface_ethernet_isis_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1923_isis_attributes:

isis attributes
---------------

    **authentication**

        **Description:** authentication is a **JSON Block**.  Please see below for :ref:`1923_authentication` 

        **Type:** Object

    **bfd-cfg**

        **Description:** bfd-cfg is a **JSON Block**.  Please see below for :ref:`1923_bfd-cfg` 

        **Type:** Object

    **circuit-type**

        **Description** 'level-1': Level-1 only adjacencies are formed; 'level-1-2': Level-1-2 adjacencies are formed; 'level-2-only': Level-2 only adjacencies are formed; 

        **Type:** string

        **Supported Values:** level-1, level-1-2, level-2-only

        **Default:** level-1-2

    **csnp-interval-list**

        **Type:** List

    **hello-interval-list**

        **Type:** List

    **hello-interval-minimal-list**

        **Type:** List

    **hello-multiplier-list**

        **Type:** List

    **lsp-interval**

        **Description** Set LSP transmission interval (LSP transmission interval (milliseconds))

        **Type:** number

        **Range:** 1-4294967295

        **Default:** 33

    **mesh-group**

        **Description:** mesh-group is a **JSON Block**.  Please see below for :ref:`1923_mesh-group` 

        **Type:** Object

    **metric-list**

        **Type:** List

    **network**

        **Description** 'broadcast': Specify IS-IS broadcast multi-access network; 'point-to-point': Specify IS-IS point-to-point network; 

        **Type:** string

        **Supported Values:** broadcast, point-to-point

    **padding**

        **Description** Add padding to IS-IS hello packets

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 1

    **password-list**

        **Type:** List

    **priority-list**

        **Type:** List

    **retransmit-interval**

        **Description** Set per-LSP retransmission interval (Interval between retransmissions of the same LSP (seconds))

        **Type:** number

        **Range:** 0-65535

        **Default:** 5

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **wide-metric-list**

        **Type:** List

.. _1923_priority-list:

priority-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **level**

        **Description** 'level-1': Specify priority for level-1 routing; 'level-2': Specify priority for level-2 routing; 

        **Type:** string

        **Supported Values:** level-1, level-2

    **priority**

        **Description** Set priority for Designated Router election (Priority value)

        **Type:** number

        **Range:** 0-127

        **Default:** 64

.. _1923_hello-interval-minimal-list:

hello-interval-minimal-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **hello-interval-minimal**

        **Description** Set Hello holdtime 1 second, interval depends on multiplier

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **level**

        **Description** 'level-1': Specify hello-interval for level-1 IIHs; 'level-2': Specify hello-interval for level-2 IIHs; 

        **Type:** string

        **Supported Values:** level-1, level-2

.. _1923_mesh-group:

mesh-group
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **blocked**

        **Description** Block LSPs on this interface

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** blocked and value are mutually exclusive

    **value**

        **Description** Mesh group number

        **Type:** number

        **Range:** 1-4294967295

        **Mutual Exclusion:** value and blocked are mutually exclusive

.. _1923_bfd-cfg:

bfd-cfg
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bfd**

        **Description** Bidirectional Forwarding Detection (BFD)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **disable**

        **Description** Disable BFD

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1923_password-list:

password-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **level**

        **Description** 'level-1': Specify password for level-1 PDUs; 'level-2': Specify password for level-2 PDUs; 

        **Type:** string

        **Supported Values:** level-1, level-2

    **password**

        **Description** Configure the authentication password for interface

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 254 characters

        **Maximum Length:** 1 characters

.. _1923_authentication:

authentication
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **key-chain-list**

        **Type:** List

    **mode-list**

        **Type:** List

    **send-only-list**

        **Type:** List

.. _1923_authentication_key-chain-list:

authentication_key-chain-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **key-chain**

        **Description** Authentication key-chain (Name of key-chain)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **level**

        **Description** 'level-1': Specify authentication key-chain for level-1 PDUs; 'level-2': Specify authentication key-chain for level-2 PDUs; 

        **Type:** string

        **Supported Values:** level-1, level-2

.. _1923_authentication_mode-list:

authentication_mode-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **level**

        **Description** 'level-1': Specify authentication mode for level-1 PDUs; 'level-2': Specify authentication mode for level-2 PDUs; 

        **Type:** string

        **Supported Values:** level-1, level-2

    **mode**

        **Description** 'md5': Keyed message digest; 

        **Type:** string

        **Supported Values:** md5

.. _1923_authentication_send-only-list:

authentication_send-only-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **level**

        **Description** 'level-1': Specify authentication send-only for level-1 PDUs; 'level-2': Specify authentication send-only for level-2 PDUs; 

        **Type:** string

        **Supported Values:** level-1, level-2

    **send-only**

        **Description** Authentication send-only

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1923_wide-metric-list:

wide-metric-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **level**

        **Description** 'level-1': Apply metric to level-1 links; 'level-2': Apply metric to level-2 links; 

        **Type:** string

        **Supported Values:** level-1, level-2

    **wide-metric**

        **Description** Configure the wide metric for interface

        **Type:** number

        **Range:** 1-16777214

        **Default:** 10

.. _1923_hello-interval-list:

hello-interval-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **hello-interval**

        **Description** Set Hello interval in seconds (Hello interval value)

        **Type:** number

        **Range:** 1-65535

        **Default:** 10

    **level**

        **Description** 'level-1': Specify hello-interval for level-1 IIHs; 'level-2': Specify hello-interval for level-2 IIHs; 

        **Type:** string

        **Supported Values:** level-1, level-2

.. _1923_hello-multiplier-list:

hello-multiplier-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **hello-multiplier**

        **Description** Set multiplier for Hello holding time (Hello multiplier value)

        **Type:** number

        **Range:** 2-100

        **Default:** 3

    **level**

        **Description** 'level-1': Specify hello multiplier for level-1 IIHs; 'level-2': Specify hello multiplier for level-2 IIHs; 

        **Type:** string

        **Supported Values:** level-1, level-2

.. _1923_metric-list:

metric-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **level**

        **Description** 'level-1': Apply metric to level-1 links; 'level-2': Apply metric to level-2 links; 

        **Type:** string

        **Supported Values:** level-1, level-2

    **metric**

        **Description** Configure the metric for interface (Default metric)

        **Type:** number

        **Range:** 1-63

        **Default:** 10

.. _1923_csnp-interval-list:

csnp-interval-list
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **csnp-interval**

        **Description** Set CSNP interval in seconds (CSNP interval value)

        **Type:** number

        **Range:** 1-65535

        **Default:** 10

    **level**

        **Description** 'level-1': Speficy interval for level-1 CSNPs; 'level-2': Specify interval for level-2 CSNPs; 

        **Type:** string

        **Supported Values:** level-1, level-2