.. _object_network:

object network
==============

Configure Network Object


network Specification
---------------------

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

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

	 **Object Key(s)**                     *net-name*

	 **Collection Name**                   :ref:`2398_network_list`

	 **Collection URI**                    /axapi/v3/object/network

	                                       

	 **Element Name**                      network

	 **Element URI**                       /axapi/v3/object/network/{net-name}

	 **Element Attributes**                network_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2398_network_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/object_network_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/object/network



.. raw:: html

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


:ref:`2398_network_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/object/network/{net-name}



.. raw:: html

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


:ref:`2398_network_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/object_network_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/object/network



.. raw:: html

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


:ref:`2398_network_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/object/network/{net-name}



.. raw:: html

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


:ref:`2398_network_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/object/network/{net-name}



.. raw:: html

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


:ref:`2398_network_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/object_network_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/object/network



.. raw:: html

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


:ref:`2398_network_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/object/network/{net-name}



.. raw:: html

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


:ref:`2398_network_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/object_network_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2398_network_list:

network-list
------------


    network-list is **JSON List** of :ref:`2398_network_attributes` 

        network-list : [

             { :ref:`2398_network_attributes` },

             { :ref:`2398_network_attributes` },

             ...

         ]

.. _2398_network_attributes:

network attributes
------------------

    **description**

        **Description** Description of the object instance

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **ip-range-end**

        **Description** IPV4 Host address end

        **Type:** string

        **Format:** ipv4-address

    **ip-range-start**

        **Description** IPv4 Host Address start

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ip-range-start,ipv6-range-start,  subnet, and ipv6-subnet are mutually exclusive

    **ipv6-range-end**

        **Description** IPV6 Host address end

        **Type:** string

        **Format:** ipv6-address

    **ipv6-range-start**

        **Description** IPv6 Host Address start

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6-range-start,ip-range-start,  subnet, and ipv6-subnet are mutually exclusive

    **ipv6-subnet**

        **Description** IPv6 Network Address

        **Type:** string

        **Format:** ipv6-address-plen

        **Mutual Exclusion:** ipv6-subnet,ip-range-start,  ipv6-range-start, and subnet are mutually exclusive

    **net-name**

        **Description** Network Object Name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **subnet**

        **Description** IPv4 Network Address

        **Type:** string

        **Format:** ipv4-cidr

        **Mutual Exclusion:** subnet,ip-range-start,  ipv6-range-start, and ipv6-subnet are mutually exclusive

    **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