eos_bgp_neighbor

Synopsis

Added in version 1.1.0

This eos_bgp_neighbor module provides stateful management of the neighbor statements for the BGP routing process for Arista EOS nodes

Options

parameter required default choices comments
description no
    		Configures the BGP neighbors description value. The value specifies an arbitrary description to add to the neighbor statement in the nodes running-configuration.
    (added in 1.1.0)
    enable no True
    • True
    • False
    		 Configures the administrative state for the BGP neighbor process. If enable is True then the BGP neighbor process is administartively enabled and if enable is False then the BGP neighbor process is administratively disabled.
    (added in 1.1.0)
    name yes
      		The name of the BGP neighbor to manage. This value can be either an IPv4 address or string (in the case of managing a peer group)
      (added in 1.1.0)
      next_hop_self no
        		Configures the BGP neighbors next-hop-self value. If enabled then the BGP next-hop-self value is enabled. If disabled, then the BGP next-hop-self community value is disabled.
        (added in 1.1.0)
        peer_group no
          		The name of the peer-group value to associate with the neighbor. This argument is only valid if the neighbor is an IPv4 address
          (added in 1.1.0)
          remote_as no
            		Configures the BGP neighbors remote-as value. Valid AS values are in the range of 1 to 65535.
            (added in 1.1.0)
            route_map_in no
              		Configures the BGP neigbhors route-map in value. The value specifies the name of the route-map.
              (added in 1.1.0)
              route_map_out no
                		Configures the BGP neigbhors route-map out value. The value specifies the name of the route-map.
                (added in 1.1.0)
                send_community no
                  		Configures the BGP neighbors send-community value. If enabled then the BGP send-community value is enable. If disabled, then the BGP send-community value is disabled.
                  (added in 1.1.0)

                  Important

                  Requires Arista EOS 4.13.7M or later with command API enable

                  Important

                  Requires Python Client for eAPI 0.3.1 or later

                  Examples


                  - name: add neighbor 172.16.10.1 to BGP
  eos_bgp_neighbor: name=172.16.10.1 enable=yes remote_as=65000

- name: remove neighbor 172.16.10.1 to BGP
  eos_bgp_neighbor name=172.16.10.1 enable=yes remote_as=65000 state=absent

                  Note

                  All configuraiton is idempontent unless otherwise specified

                  Note

                  Supports eos metaparameters for using the eAPI transport

                  Note

                  Supports tateful resource configuration