cisco.nxos.nxos_bgp_neighbor_af (4.4.0) — module

Install collection

Install with ansible-galaxy collection install cisco.nxos:==4.4.0

Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 4.4.0

Description

Manages BGP address-family's neighbors configurations on NX-OS switches.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure RR client
  cisco.nxos.nxos_bgp_neighbor_af:
    asn: 65535
    neighbor: 192.0.2.3
    afi: ipv4
    safi: unicast
    route_reflector_client: true
    state: present
    rewrite_evpn_rt_asn: true

Inputs

    
afi:
    choices:
    - ipv4
    - ipv6
    - vpnv4
    - vpnv6
    - l2vpn
    description:
    - Address Family Identifier.
    required: true
    type: str

asn:
    description:
    - BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT
      notation.
    required: true
    type: str

soo:
    description:
    - Site-of-origin. Valid values are a string defining a VPN extcommunity or 'default'.
    type: str

vrf:
    default: default
    description:
    - Name of the VRF. The name 'default' is a valid VRF representing the global bgp.
    type: str

safi:
    choices:
    - unicast
    - multicast
    - evpn
    description:
    - Sub Address Family Identifier.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines whether the config should be present or not on the device.
    type: str

weight:
    description:
    - Weight value. Valid values are an integer value or 'default'.
    type: str

neighbor:
    description:
    - Neighbor Identifier. Valid values are string. Neighbors may use IPv4 or IPv6 notation,
      with or without prefix length.
    required: true
    type: str

allowas_in:
    description:
    - Activate allowas-in property
    type: bool

as_override:
    description:
    - Activate the as-override feature.
    type: bool

route_map_in:
    description:
    - Valid values are a string defining a route-map name, or 'default'.
    type: str

next_hop_self:
    description:
    - Activate the next-hop-self feature.
    type: bool

route_map_out:
    description:
    - Valid values are a string defining a route-map name, or 'default'.
    type: str

allowas_in_max:
    description:
    - Max-occurrences value for allowas_in. Valid values are an integer value or 'default'.
      This is mutually exclusive with allowas_in.
    type: str

filter_list_in:
    description:
    - Valid values are a string defining a filter-list name, or 'default'.
    type: str

prefix_list_in:
    description:
    - Valid values are a string defining a prefix-list name, or 'default'.
    type: str

send_community:
    choices:
    - none
    - both
    - extended
    - standard
    - default
    description:
    - send-community attribute.
    type: str

unsuppress_map:
    description:
    - unsuppress-map. Valid values are a string defining a route-map name or 'default'.
    type: str

filter_list_out:
    description:
    - Valid values are a string defining a filter-list name, or 'default'.
    type: str

prefix_list_out:
    description:
    - Valid values are a string defining a prefix-list name, or 'default'.
    type: str

max_prefix_limit:
    description:
    - maximum-prefix limit value. Valid values are an integer value or 'default'.
    type: str

default_originate:
    description:
    - Activate the default-originate feature.
    type: bool

suppress_inactive:
    description:
    - suppress-inactive feature.
    type: bool

max_prefix_warning:
    description:
    - Optional warning-only keyword. Requires max_prefix_limit. May not be combined with
      max_prefix_interval.
    type: bool

advertise_map_exist:
    description:
    - Conditional route advertisement. This property requires two route maps, an advertise-map
      and an exist-map. Valid values are an array specifying both the advertise-map name
      and the exist-map name, or simply 'default' e.g. ['my_advertise_map', 'my_exist_map'].
      This command is mutually exclusive with the advertise_map_non_exist property.
    elements: str
    type: list

max_prefix_interval:
    description:
    - Optional restart interval. Valid values are an integer. Requires max_prefix_limit.
      May not be combined with max_prefix_warning.
    type: str

rewrite_evpn_rt_asn:
    description:
    - Auto generate route targets for EBGP neighbor.
    type: bool
    version_added: 1.1.0
    version_added_collection: cisco.nxos

max_prefix_threshold:
    description:
    - Optional threshold percentage at which to generate a warning. Valid values are an
      integer value. Requires max_prefix_limit.
    type: str

next_hop_third_party:
    description:
    - Activate the next-hop-third-party feature.
    type: bool

additional_paths_send:
    choices:
    - enable
    - disable
    - inherit
    description:
    - Valid values are enable for basic command enablement; disable for disabling the
      command at the neighbor af level (it adds the disable keyword to the basic command);
      and inherit to remove the command at this level (the command value is inherited
      from a higher BGP layer).
    type: str

disable_peer_as_check:
    description:
    - Disable checking of peer AS-number while advertising
    type: bool

route_reflector_client:
    description:
    - Router reflector client.
    type: bool

advertise_map_non_exist:
    description:
    - Conditional route advertisement. This property requires two route maps, an advertise-map
      and an exist-map. Valid values are an array specifying both the advertise-map name
      and the non-exist-map name, or simply 'default' e.g. ['my_advertise_map', 'my_non_exist_map'].
      This command is mutually exclusive with the advertise_map_exist property.
    elements: str
    type: list

soft_reconfiguration_in:
    choices:
    - enable
    - always
    - inherit
    description:
    - Valid values are 'enable' for basic command enablement; 'always' to add the always
      keyword to the basic command; and 'inherit' to remove the command at this level
      (the command value is inherited from a higher BGP layer).
    type: str

additional_paths_receive:
    choices:
    - enable
    - disable
    - inherit
    description:
    - Valid values are enable for basic command enablement; disable for disabling the
      command at the neighbor af level (it adds the disable keyword to the basic command);
      and inherit to remove the command at this level (the command value is inherited
      from a higher BGP layer).
    type: str

default_originate_route_map:
    description:
    - Route-map for the default_originate property. Valid values are a string defining
      a route-map name, or 'default'. This is mutually exclusive with default_originate.
    type: str

Outputs

commands:
  description: commands sent to the device
  returned: always
  sample:
  - router bgp 65535
  - neighbor 192.0.2.3
  - address-family ipv4 unicast
  - route-reflector-client
  - rewrite-evpn-rt-asn
  type: list