.. _router_bgp_network:

router bgp network
==================

Specify a network to announce via BGP


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

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

	===================================== =======================================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      network

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

	 **Element Attributes**                network_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`network schema <router-bgp-network/router-bgp-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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/router/bgp/{as-number}/network



.. raw:: html

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


network_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2512_network_attributes:

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

    **ip-cidr-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/network/ip-cidr/{network-ipv4-cidr} <router_bgp>`

    **monitor**

        **Description:** monitor is a **JSON Block**.  Please see below for :ref:`2512_monitor` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/network/monitor <router_bgp>`

    **synchronization**

        **Description:** synchronization is a **JSON Block**.  Please see below for :ref:`2512_synchronization` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/network/synchronization <router_bgp>`

.. _2512_synchronization:

synchronization
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **network-synchronization**

        **Description** Perform IGP synchronization

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2512_monitor:

monitor
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **default**

        **Description:** default is a **JSON Block**.  Please see below for :ref:`2512_monitor_default` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/network/monitor/default <router_bgp>`

.. _2512_monitor_default:

monitor_default
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **network-monitor-default**

        **Description** default route monitoring

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2512_ip-cidr-list:

ip-cidr-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

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