network bgp peer-group create
Create a new BGP peer group
Availability: This command is available to cluster administrators at the admin privilege level.
Description
The network bgp peer-group create
command is used to create a border gateway protocol (BGP) peer group. A BGP peer group will advertise VIP routes for the list of vservers in the peer group's vserver-list
using the BGP LIF of the peer group. A BGP peer group will advertise VIP routes to a peer router using the border gateway protocol. The address of the peer router is identified by the peer-address
value.
Parameters
-ipspace <IPspace>
- IPspace Name-
This parameter specifies the IPspace of the peer group being created.
-peer-group <text>
- Peer Group Name-
This parameter specifies the name of the peer group being created.
-bgp-lif <lif-name>
- BGP LIF-
This parameter specifies the BGP interface (BGP LIF) of the peer group being created.
-peer-address <IP Address>
- Peer Router Address-
This parameter specifies the IP address of the peer router for the peer group being created.
[-peer-asn <integer>]
- Peer Router Autonomous number-
This parameter specifies the peer router autonomous system number (ASN) in the peer group being created. The default value is the value of the local node's ASN.
-route-preference <integer>
- Route Preference-
This parameter specifies the preference field in BGP update messages for VIP routes. If a router receives multiple VIP route announcements for the same VIP LIF from different BGP LIFs, it will install the one that has the highest preference value. The default route preference value is 100.
[-asn-prepend-type <ASN Prepend type>]
- ASN prepend type (privilege: advanced)-
This parameter specifies the ASN that will be prepended in the BGP attributes. The possible values are
local-asn
andpeer-asn
. The default behavior is not to prepend any ASN. [-asn-prepend-count <integer>]
- ASN prepend count (privilege: advanced)-
This parameter specifies the number of times ASN, as specified in
asn-prepend-type
will be prepended in the BGP path attributes. The default behavior is not to prepend any ASN. [-community <BGP community>,…]
- BGP Community (privilege: advanced)-
This parameter specifies the communities that will be included in the BGP path attributes. The default behavior is not to include any community in BGP path attributes.
[-med <integer>]
- Multi Exit Discriminator (privilege: advanced)-
This parameter specifies the Multi Exit Discriminator (MED) attribute of BGP update messages, which can be used by routers for best path selection, in cases where more than one peer advertises the same route with similar attributes.
[-use-peer-as-next-hop {true|false}]
- Use Peer Address As Next Hop-
This parameter specifies whether the peer group uses the peer address as a next hop route. When the value is true, the peer address is used as the next hop router for packets sent from VIP LIFs via the port on which
bgp-lif
is configured. Internally, a default route with a gateway configured as thepeer-address
is added automatically on the node for all the Vservers in this peer group's IPspace. The route will be added for a Vserver only if it has a VIP LIF hosted on the current node ofbgp-lif
. Note that these automatically installed default routes are for VIP traffic; however, they can be used for non-VIP traffic as well if a Vserver hosts both VIP and non-VIP LIFs in the same subnet asbgp-lif
. This route will have metric of 20 and will be used to forward traffic through the current port ofbgp-lif
. The default value of this parameter is false. [-md5-enabled {true|false}]
- TCP MD5 Enabled (privilege: advanced)-
This parameter specifies whether the peer group configuration uses TCP MD5 authentication to communicate with its peer router. When the value is true, an
md5-secret
must be specified for the peer group being created. The default value is false. [-md5-secret <text>]
- TCP MD5 Secret Key (privilege: advanced)-
This parameter specifies TCP MD5 secret key. The value for
md5-secret
may be specified as either a string of printable ASCII characters or as a hexadecimal string. If a string of ASCII characters is specified, the string should be enclosed in quotes and be from 1-79 characters in length. If a hexadecimal string is specified, the string of hexadecimal bytes should be prefaced with 0x (e.g., 0x893785c6) and contain from 2-160 hexadecimal characters. Themd5-secret
should match the MD5 secret configured on the peer router.
Examples
cluster1::> network bgp peer-group create -peer-group group1 -ipspace Default -bgp-lif bgp_lif -peer-address 10.0.1.112