.. _router_bgp_address_family_ipv6_neighbor:

router bgp address-family ipv6 neighbor
=======================================

Specify a neighbor router


neighbor Specification
----------------------

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

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

	 **Element Name**                      neighbor

	 **Element URI**                       /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor

	 **Element Attributes**                neighbor_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`neighbor schema <router-bgp-address-family-ipv6-neighbor/router-bgp-address-family-ipv6-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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor



.. raw:: html

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


neighbor_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2492_neighbor_attributes:

neighbor attributes
-------------------

    **ethernet-neighbor-ipv6-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ethernet-neighbor-ipv6/{ethernet} <router_bgp>`

    **ipv4-neighbor-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ipv4-neighbor/{neighbor-ipv4} <router_bgp>`

    **ipv6-neighbor-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ipv6-neighbor/{neighbor-ipv6} <router_bgp>`

    **peer-group-neighbor-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/peer-group-neighbor/{peer-group} <router_bgp>`

    **trunk-neighbor-ipv6-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/trunk-neighbor-ipv6/{trunk} <router_bgp>`

    **ve-neighbor-ipv6-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ve-neighbor-ipv6/{ve} <router_bgp>`

.. _2492_ethernet-neighbor-ipv6-list:

ethernet-neighbor-ipv6-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet**

        **Description** Ethernet interface number

        **Type:** number

        **Format:** interface

    **peer-group-name**

        **Description** 

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

.. _2492_ipv4-neighbor-list:

ipv4-neighbor-list
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **activate**

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

        **Type:** boolean

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

        **Default:** 0

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

    **default-originate**

        **Description** Originate default route to this neighbor

        **Type:** boolean

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

        **Default:** 0

    **distribute-lists**

        **Type:** List

    **graceful-restart**

        **Description** enable graceful-restart helper for 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

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

    **neighbor-filter-lists**

        **Type:** List

    **neighbor-ipv4**

        **Description** Neighbor address

        **Type:** string

        **Format:** ipv4-address

    **neighbor-prefix-lists**

        **Type:** List

    **neighbor-route-map-lists**

        **Type:** List

    **next-hop-self**

        **Description** Disable the next hop calculation for this neighbor

        **Type:** boolean

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

        **Default:** 0

    **peer-group-name**

        **Description** Configure peer-group (peer-group name)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **prefix-list-direction**

        **Description** 'both': both; 'receive': receive; 'send': send; 

        **Type:** string

        **Supported Values:** both, receive, send

    **remove-private-as**

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

        **Type:** boolean

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

        **Default:** 0

    **restart-min**

        **Description** restart value, 1 to 1440 minutes

        **Type:** number

        **Range:** 1-1440

    **route-map**

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

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **send-community-val**

        **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; 

        **Type:** string

        **Supported Values:** all, both, none, standard, extended, large

        **Default:** both

    **unsuppress-map**

        **Description** Route-map to selectively unsuppress suppressed routes (Name of 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

    **weight**

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

        **Type:** number

        **Range:** 0-65535

        **Default:** 0

.. _2492_ipv4-neighbor-list_distribute-lists:

ipv4-neighbor-list_distribute-lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **distribute-list**

        **Description** Filter updates to/from this neighbor (IP standard/extended/named access list)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **distribute-list-direction**

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

        **Type:** string

        **Supported Values:** in, out

.. _2492_ipv4-neighbor-list_neighbor-route-map-lists:

ipv4-neighbor-list_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

.. _2492_ipv4-neighbor-list_neighbor-filter-lists:

ipv4-neighbor-list_neighbor-filter-lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **filter-list**

        **Description** Establish BGP filters (AS path access-list name)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **filter-list-direction**

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

        **Type:** string

        **Supported Values:** in, out

.. _2492_ipv4-neighbor-list_neighbor-prefix-lists:

ipv4-neighbor-list_neighbor-prefix-lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **nbr-prefix-list**

        **Description** Filter updates to/from this neighbor (Name of a prefix list)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **nbr-prefix-list-direction**

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

        **Type:** string

        **Supported Values:** in, out

.. _2492_peer-group-neighbor-list:

peer-group-neighbor-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **activate**

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

        **Type:** boolean

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

        **Default:** 0

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

    **inbound**

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

        **Type:** boolean

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

        **Default:** 0

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

    **neighbor-route-map-lists**

        **Type:** List

    **next-hop-self**

        **Description** Disable the next hop calculation for 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

    **remove-private-as**

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

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

    **weight**

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

        **Type:** number

        **Range:** 0-65535

        **Default:** 0

.. _2492_peer-group-neighbor-list_neighbor-route-map-lists:

peer-group-neighbor-list_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

.. _2492_ve-neighbor-ipv6-list:

ve-neighbor-ipv6-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **peer-group-name**

        **Description** 

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

    **ve**

        **Description** Virtual ethernet interface number

        **Type:** number

        **Format:** interface

.. _2492_trunk-neighbor-ipv6-list:

trunk-neighbor-ipv6-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **peer-group-name**

        **Description** 

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **trunk**

        **Description** Trunk interface number

        **Type:** number

        **Format:** interface

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2492_ipv6-neighbor-list:

ipv6-neighbor-list
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **activate**

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

        **Type:** boolean

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

        **Default:** 0

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

    **default-originate**

        **Description** Originate default route to this neighbor

        **Type:** boolean

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

        **Default:** 0

    **distribute-lists**

        **Type:** List

    **graceful-restart**

        **Description** enable graceful-restart helper for 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

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

    **neighbor-filter-lists**

        **Type:** List

    **neighbor-ipv6**

        **Description** Neighbor IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **neighbor-prefix-lists**

        **Type:** List

    **neighbor-route-map-lists**

        **Type:** List

    **next-hop-self**

        **Description** Disable the next hop calculation for this neighbor

        **Type:** boolean

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

        **Default:** 0

    **peer-group-name**

        **Description** Configure peer-group (peer-group name)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **prefix-list-direction**

        **Description** 'both': both; 'receive': receive; 'send': send; 

        **Type:** string

        **Supported Values:** both, receive, send

    **remove-private-as**

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

        **Type:** boolean

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

        **Default:** 0

    **restart-min**

        **Description** restart value, 1 to 1440 minutes

        **Type:** number

        **Range:** 1-1440

    **route-map**

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

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **send-community-val**

        **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; 

        **Type:** string

        **Supported Values:** all, both, none, standard, extended, large

        **Default:** both

    **unsuppress-map**

        **Description** Route-map to selectively unsuppress suppressed routes (Name of 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

    **weight**

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

        **Type:** number

        **Range:** 0-65535

        **Default:** 0

.. _2492_ipv6-neighbor-list_distribute-lists:

ipv6-neighbor-list_distribute-lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **distribute-list**

        **Description** Filter updates to/from this neighbor (IP standard/extended/named access list)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **distribute-list-direction**

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

        **Type:** string

        **Supported Values:** in, out

.. _2492_ipv6-neighbor-list_neighbor-route-map-lists:

ipv6-neighbor-list_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

.. _2492_ipv6-neighbor-list_neighbor-filter-lists:

ipv6-neighbor-list_neighbor-filter-lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **filter-list**

        **Description** Establish BGP filters (AS path access-list name)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **filter-list-direction**

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

        **Type:** string

        **Supported Values:** in, out

.. _2492_ipv6-neighbor-list_neighbor-prefix-lists:

ipv6-neighbor-list_neighbor-prefix-lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **nbr-prefix-list**

        **Description** Filter updates to/from this neighbor (Name of a prefix list)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **nbr-prefix-list-direction**

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

        **Type:** string

        **Supported Values:** in, out