.. _banner:

banner
======

Define a login banner


banner Specification
--------------------

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

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

	 **Element Name**                      banner

	 **Element URI**                       /axapi/v3/banner

	 **Element Attributes**                banner_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`224_banner_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/banner_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/banner



.. raw:: html

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


:ref:`224_banner_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/banner_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/banner



.. raw:: html

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


:ref:`224_banner_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/banner



.. raw:: html

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


:ref:`224_banner_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/banner_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/banner



.. raw:: html

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


:ref:`224_banner_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/banner_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _224_banner_attributes:

banner attributes
-----------------

    **exec-banner-cfg**

        **Description:** exec-banner-cfg is a **JSON Block**.  Please see below for :ref:`224_exec-banner-cfg` 

        **Type:** Object

    **login-banner-cfg**

        **Description:** login-banner-cfg is a **JSON Block**.  Please see below for :ref:`224_login-banner-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _224_exec-banner-cfg:

exec-banner-cfg
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **exec**

        **Description** Set EXEC process creation banner

        **Type:** boolean

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

        **Default:** 0

    **exec-banner**

        **Description** Banner text, string \n is taken as line break of multi-line banner text, use \\n for \n, \077 for ? and \011 for tab

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 2048 characters

        **Maximum Length:** 1 characters

.. _224_login-banner-cfg:

login-banner-cfg
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **login**

        **Description** Set login banner

        **Type:** boolean

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

        **Default:** 0

    **login-banner**

        **Description** Banner text, string \n is taken as line break of multi-line banner text, use \\n to indicate \n

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 2048 characters

        **Maximum Length:** 1 characters