.. _router_bgp_network_ip_cidr:

router bgp network ip-cidr
==========================

Specify a ip network to announce via BGP


ip-cidr Specification
---------------------

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

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

	 **Object Key(s)**                     *network-ipv4-cidr*

	 **Collection Name**                   :ref:`2508_ip-cidr_list`

	 **Collection URI**                    /axapi/v3/router/bgp/{as-number}/network/ip-cidr

	                                       

	 **Element Name**                      ip-cidr

	 **Element URI**                       /axapi/v3/router/bgp/{as-number}/network/ip-cidr/{network-ipv4-cidr}

	 **Element Attributes**                ip-cidr_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ip-cidr schema <router-bgp-network-ip-cidr/router-bgp-network-ip-cidr.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/router/bgp/{as-number}/network/ip-cidr



.. raw:: html

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


:ref:`2508_ip-cidr_attributes`



.. raw:: html

   </td><td></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/router/bgp/{as-number}/network/ip-cidr



.. raw:: html

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


:ref:`2508_ip-cidr_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/router/bgp/{as-number}/network/ip-cidr/{network-ipv4-cidr}



.. raw:: html

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


:ref:`2508_ip-cidr_attributes`



.. raw:: html

   </td><td></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/router/bgp/{as-number}/network/ip-cidr



.. raw:: html

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


:ref:`2508_ip-cidr_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/router/bgp/{as-number}/network/ip-cidr/{network-ipv4-cidr}



.. raw:: html

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


:ref:`2508_ip-cidr_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/router/bgp/{as-number}/network/ip-cidr/{network-ipv4-cidr}



.. raw:: html

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


:ref:`2508_ip-cidr_attributes`



.. raw:: html

   </td><td></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/router/bgp/{as-number}/network/ip-cidr



.. raw:: html

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


:ref:`2508_ip-cidr_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/router/bgp/{as-number}/network/ip-cidr/{network-ipv4-cidr}



.. raw:: html

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


:ref:`2508_ip-cidr_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2508_ip-cidr_list:

ip-cidr-list
------------


    ip-cidr-list is **JSON List** of :ref:`2508_ip-cidr_attributes` 

        ip-cidr-list : [

             { :ref:`2508_ip-cidr_attributes` },

             { :ref:`2508_ip-cidr_attributes` },

             ...

         ]

.. _2508_ip-cidr_attributes:

ip-cidr attributes
------------------

    **backdoor**

        **Description** Specify a BGP backdoor route

        **Type:** boolean

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

        **Default:** 0

    **comm-value**

        **Description** community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export

        **Type:** string

        **Format:** string-rlx

    **description**

        **Description** Network specific description (Up to 80 characters describing this network)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 80 characters

        **Maximum Length:** 1 characters

    **lcomm-value**

        **Description** Large community value in the format XX:YY:ZZ

        **Type:** string

        **Format:** string-rlx

    **network-ipv4-cidr**

        **Description** Specify network mask

        **Type:** string

        **Format:** ipv4-cidr

    **route-map**

        **Description** Route-map to modify the attributes (Name of the route map)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters