.. _snmp_server_view:

snmp-server view
================

Defines named "view" - a subset of the overall OID tree


view Specification
------------------

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

	===================================== ==========================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *viewname, oid*

	 **Collection Name**                   :ref:`3123_view_list`

	 **Collection URI**                    /axapi/v3/snmp-server/view

	                                       

	 **Element Name**                      view

	 **Element URI**                       /axapi/v3/snmp-server/view/{viewname}+{oid}

	 **Element Attributes**                view_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3123_view_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/snmp_server_view_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/snmp-server/view



.. raw:: html

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


:ref:`3123_view_attributes`



.. raw:: html

   </td><td></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/snmp-server/view/{viewname}+{oid}



.. raw:: html

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


:ref:`3123_view_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/snmp_server_view_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/snmp-server/view



.. raw:: html

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


:ref:`3123_view_list`



.. raw:: html

   </td><td></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/snmp-server/view/{viewname}+{oid}



.. raw:: html

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


:ref:`3123_view_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/snmp-server/view/{viewname}+{oid}



.. raw:: html

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


:ref:`3123_view_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/snmp_server_view_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/snmp-server/view



.. raw:: html

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


:ref:`3123_view_list`



.. 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/snmp-server/view/{viewname}+{oid}



.. raw:: html

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


:ref:`3123_view_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/snmp_server_view_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3123_view_list:

view-list
---------


    view-list is **JSON List** of :ref:`3123_view_attributes` 

        view-list : [

             { :ref:`3123_view_attributes` },

             { :ref:`3123_view_attributes` },

             ...

         ]

.. _3123_view_attributes:

view attributes
---------------

    **mask**

        **Description** Hex octets, separated by '.', mask of oid

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** mask and type are mutually exclusive

    **oid**

        **Description** MIB view family name or oid

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **type**

        **Description** 'included': MIB family is included in the view; 'excluded': MIB family is excluded from the view; 

        **Type:** string

        **Supported Values:** included, excluded

        **Mutual Exclusion:** type and mask are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **viewname**

        **Description** Name of the view

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters