.. _router_bgp_neighbor_peer_group_neighbor:

router bgp neighbor peer-group-neighbor
=======================================

Specify a peer-group neighbor router


peer-group-neighbor Specification
---------------------------------

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

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

	 **Object Key(s)**                     *peer-group*

	 **Collection Name**                   :ref:`2504_peer-group-neighbor_list`

	 **Collection URI**                    /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor

	                                       

	 **Element Name**                      peer-group-neighbor

	 **Element URI**                       /axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group}

	 **Element Attributes**                peer-group-neighbor_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`peer-group-neighbor schema <router-bgp-neighbor-peer-group-neighbor/router-bgp-neighbor-peer-group-neighbor.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}/neighbor/peer-group-neighbor



.. raw:: html

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


:ref:`2504_peer-group-neighbor_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}/neighbor/peer-group-neighbor



.. raw:: html

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


:ref:`2504_peer-group-neighbor_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}/neighbor/peer-group-neighbor/{peer-group}



.. raw:: html

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


:ref:`2504_peer-group-neighbor_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}/neighbor/peer-group-neighbor



.. raw:: html

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


:ref:`2504_peer-group-neighbor_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}/neighbor/peer-group-neighbor/{peer-group}



.. raw:: html

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


:ref:`2504_peer-group-neighbor_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}/neighbor/peer-group-neighbor/{peer-group}



.. raw:: html

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


:ref:`2504_peer-group-neighbor_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}/neighbor/peer-group-neighbor



.. raw:: html

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


:ref:`2504_peer-group-neighbor_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}/neighbor/peer-group-neighbor/{peer-group}



.. raw:: html

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


:ref:`2504_peer-group-neighbor_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2504_peer-group-neighbor_list:

peer-group-neighbor-list
------------------------


    peer-group-neighbor-list is **JSON List** of :ref:`2504_peer-group-neighbor_attributes` 

        peer-group-neighbor-list : [

             { :ref:`2504_peer-group-neighbor_attributes` },

             { :ref:`2504_peer-group-neighbor_attributes` },

             ...

         ]

.. _2504_peer-group-neighbor_attributes:

peer-group-neighbor attributes
------------------------------

    **activate**

        **Description** Enable the Address Family for this Neighbor

        **Type:** boolean

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

        **Default:** 1

    **advertisement-interval**

        **Description** Minimum interval between sending BGP routing updates (time in seconds)

        **Type:** number

        **Range:** 1-600

    **allowas-in**

        **Description** Accept as-path with my AS present in it

        **Type:** boolean

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

        **Default:** 0

    **allowas-in-count**

        **Description** Number of occurrences of AS number

        **Type:** number

        **Range:** 1-10

        **Default:** 3

    **as-origination-interval**

        **Description** Minimum interval between sending AS-origination routing updates (time in seconds)

        **Type:** number

        **Range:** 1-600

    **bfd**

        **Description** Bidirectional Forwarding Detection (BFD)

        **Type:** boolean

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

        **Default:** 0

    **collide-established**

        **Description** Include Neighbor in Established State for Collision Detection

        **Type:** boolean

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

        **Default:** 0

    **connect**

        **Description** BGP connect timer

        **Type:** number

        **Range:** 1-65535

    **default-originate**

        **Description** Originate default route to this neighbor

        **Type:** boolean

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

        **Default:** 0

    **description**

        **Description** Neighbor specific description (Up to 80 characters describing this neighbor)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 80 characters

        **Maximum Length:** 1 characters

    **dont-capability-negotiate**

        **Description** Do not perform capability negotiation

        **Type:** boolean

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

        **Default:** 0

    **dynamic**

        **Description** Advertise dynamic capability to this neighbor

        **Type:** boolean

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

        **Default:** 0

    **ebgp-multihop**

        **Description** Allow EBGP neighbors not on directly connected networks

        **Type:** boolean

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

        **Default:** 0

    **ebgp-multihop-hop-count**

        **Description** maximum hop count

        **Type:** number

        **Range:** 1-255

    **enforce-multihop**

        **Description** Enforce EBGP neighbors to perform multihop

        **Type:** boolean

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

        **Default:** 0

    **ethernet**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

        **Mutual Exclusion:** ethernet,update-source-ip, update-source-ipv6, loopback, ve, trunk,  lif, and tunnel are mutually exclusive

    **extended-nexthop**

        **Description** Advertise extended-nexthop capability to this neighbor

        **Type:** boolean

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

        **Default:** 0

    **inbound**

        **Description** Allow inbound soft reconfiguration for this neighbor

        **Type:** boolean

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

        **Default:** 0

    **lif**

        **Description** Logical interface (Lif interface name)

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** lif,update-source-ip, update-source-ipv6, ethernet, loopback, ve,  trunk, and tunnel are mutually exclusive

    **loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

        **Mutual Exclusion:** loopback,update-source-ip, update-source-ipv6, ethernet, ve, trunk,  lif, and tunnel are mutually exclusive

    **maximum-prefix**

        **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

        **Type:** number

    **maximum-prefix-thres**

        **Description** threshold-value, 1 to 100 percent

        **Type:** number

        **Range:** 1-100

    **multihop**

        **Description** Enable multihop

        **Type:** boolean

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

        **Default:** 0

    **neighbor-route-map-lists**

        **Type:** List

    **override-capability**

        **Description** Override capability negotiation result

        **Type:** boolean

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

        **Default:** 0

    **pass-encrypted**

        **Description** 

    **pass-value**

        **Description** Key String

        **Type:** string

        **Format:** password

        **Maximum Length:** 80 characters

        **Maximum Length:** 1 characters

    **passive**

        **Description** Don't send open messages to this neighbor

        **Type:** boolean

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

        **Default:** 0

    **peer-group**

        **Description** Neighbor tag

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **peer-group-key**

        **Description** Configure peer-group

        **Type:** boolean

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

        **Default:** 0

    **peer-group-remote-as**

        **Description** Specify AS number of BGP neighbor

        **Type:** string

        **Maximum Length:** 11 characters

        **Maximum Length:** 1 characters

    **remove-private-as**

        **Description** Remove private AS number from outbound updates

        **Type:** boolean

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

        **Default:** 0

    **route-map**

        **Description** Route-map to specify criteria to originate default (route-map name)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **route-refresh**

        **Description** Advertise route-refresh capability to this neighbor

        **Type:** boolean

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

        **Default:** 1

    **shutdown**

        **Description** Administratively shut down this neighbor

        **Type:** boolean

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

        **Default:** 0

    **strict-capability-match**

        **Description** Strict capability negotiation match

        **Type:** boolean

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

        **Default:** 0

    **timers-holdtime**

        **Description** Holdtime

        **Type:** number

        **Range:** 0-65535

        **Default:** 90

    **timers-keepalive**

        **Description** Keepalive interval

        **Type:** number

        **Range:** 0-65535

        **Default:** 30

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

        **Mutual Exclusion:** trunk,update-source-ip, update-source-ipv6, ethernet, loopback, ve,  lif, and tunnel are mutually exclusive

    **tunnel**

        **Description** Tunnel interface (Tunnel interface number)

        **Type:** number

        **Format:** interface

        **Mutual Exclusion:** tunnel,update-source-ip, update-source-ipv6, ethernet, loopback, ve,  trunk, and lif are mutually exclusive

    **update-source-ip**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** update-source-ip,update-source-ipv6, ethernet, loopback, ve, trunk,  lif, and tunnel are mutually exclusive

    **update-source-ipv6**

        **Description** IPv6 address

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** update-source-ipv6,update-source-ip, ethernet, loopback, ve, trunk,  lif, and tunnel are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

        **Mutual Exclusion:** ve,update-source-ip, update-source-ipv6, ethernet, loopback, trunk,  lif, and tunnel are mutually exclusive

    **weight**

        **Description** Set default weight for routes from this neighbor

        **Type:** number

        **Range:** 0-65535

        **Default:** 0

.. _2504_neighbor-route-map-lists:

neighbor-route-map-lists
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **nbr-rmap-direction**

        **Description** 'in': in; 'out': out; 

        **Type:** string

        **Supported Values:** in, out

    **nbr-route-map**

        **Description** Apply route map to neighbor (Name of route map)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters