.. _terminal:

terminal
========

Set Terminal Startup Parameters


terminal Specification
----------------------

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

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

	 **Element Name**                      terminal

	 **Element URI**                       /axapi/v3/terminal

	 **Element Attributes**                terminal_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`terminal schema <terminal/terminal.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/terminal



.. raw:: html

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


:ref:`3495_terminal_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/terminal_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/terminal



.. raw:: html

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


:ref:`3495_terminal_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/terminal_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/terminal



.. raw:: html

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


:ref:`3495_terminal_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/terminal



.. raw:: html

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


:ref:`3495_terminal_attributes`



.. raw:: html

   </td><td></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/terminal



.. raw:: html

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


:ref:`3495_terminal_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3495_terminal_attributes:

terminal attributes
-------------------

    **auto-size**

        **Description** Enable terminal length and width automatically (not work if width or length set to 0)

        **Type:** boolean

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

        **Default:** 1

        **Mutual Exclusion:** auto-size, length, and width are mutually exclusive

    **editing**

        **Description** Enable command line editing

        **Type:** boolean

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

        **Default:** 1

    **gslb-cfg**

        **Description:** gslb-cfg is a **JSON Block**.  Please see below for :ref:`3495_gslb-cfg` 

        **Type:** Object

    **history-cfg**

        **Description:** history-cfg is a **JSON Block**.  Please see below for :ref:`3495_history-cfg` 

        **Type:** Object

    **idle-timeout**

        **Description** Set interval for closing connection when there is no input detected (Timeout in minutes, 0 means never timeout, default is 15)

        **Type:** number

        **Range:** 0-60

        **Default:** 15

    **length**

        **Description** Set number of lines on a screen(0 for no pausing) (Number of lines on screen, 0 for no pausing, default is 24)

        **Type:** number

        **Range:** 0-512

        **Default:** 24

        **Mutual Exclusion:** length and auto-size are mutually exclusive

    **prompt-cfg**

        **Description:** prompt-cfg is a **JSON Block**.  Please see below for :ref:`3495_prompt-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **width**

        **Description** Set width of the display terminal (Number of characters on a screen line, 0 means infinite, default is 80)

        **Type:** number

        **Range:** 0-512

        **Default:** 80

        **Mutual Exclusion:** width and auto-size are mutually exclusive

.. _3495_gslb-cfg:

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

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

    **disable**

        **Description** Group status show disable

        **Type:** boolean

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

        **Default:** 0

    **group-role**

        **Description** Show GSLB group role on CLI prompt

        **Type:** boolean

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

        **Default:** 0

    **gslb-prompt**

        **Description** The gslb status prompt function set

        **Type:** boolean

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

        **Default:** 0

    **symbol**

        **Description** Show "gslb" symbol on CLI prompt

        **Type:** boolean

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

        **Default:** 0

.. _3495_history-cfg:

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

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

    **enable**

        **Description** Enable terminal history

        **Type:** boolean

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

        **Default:** 1

    **size**

        **Description** Set history buffer size (Size of history buffer, default is 256)

        **Type:** number

        **Range:** 0-1000

        **Default:** 256

.. _3495_prompt-cfg:

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

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

    **ha-status**

        **Description** Display HA status in prompt, eg. Active, Standby, ForcedStandby

        **Type:** boolean

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

        **Default:** 0

    **hostname**

        **Description** Display hostname in prompt

        **Type:** boolean

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

        **Default:** 0

    **prompt**

        **Description** Configure the normal prompt format

        **Type:** boolean

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

        **Default:** 0

    **vcs-cfg**

        **Description:** vcs-cfg is a **JSON Block**.  Please see below for :ref:`3495_prompt-cfg_vcs-cfg` 

        **Type:** Object

.. _3495_prompt-cfg_vcs-cfg:

prompt-cfg_vcs-cfg
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **vcs-status**

        **Description** Display VCS status in prompt, eg. vMaster, vBlade

        **Type:** boolean

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

        **Default:** 0