ansible.builtin.nxos_bgp_neighbor_af (v2.3.3.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

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
  nxos_bgp_neighbor_af:
    asn: 65535
    neighbor: '3.3.3.3'
    afi: ipv4
    safi: unicast
    route_reflector_client: true
    state: present
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Inputs

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

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

soo:
    default: null
    description:
    - Site-of-origin. Valid values are a string defining a VPN extcommunity or 'default'.
    required: false

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

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

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

weight:
    default: null
    description:
    - Weight value. Valid values are an integer value or 'default'.
    required: false

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

allowas_in:
    default: null
    description:
    - Activate allowas-in property
    required: false

as_override:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Activate the as-override feature.
    required: false

route_map_in:
    default: null
    description:
    - Valid values are a string defining a route-map name, or 'default'.
    required: false

next_hop_self:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Activate the next-hop-self feature.
    required: false

route_map_out:
    default: null
    description:
    - Valid values are a string defining a route-map name, or 'default'.
    required: false

allowas_in_max:
    default: null
    description:
    - Optional max-occurrences value for allowas_in. Valid values are an integer value
      or 'default'. Can be used independently or in conjunction with allowas_in.
    required: false

filter_list_in:
    default: null
    description:
    - Valid values are a string defining a filter-list name, or 'default'.
    required: false

prefix_list_in:
    default: null
    description:
    - Valid values are a string defining a prefix-list name, or 'default'.
    required: false

send_community:
    choices:
    - none
    - both
    - extended
    - standard
    - default
    default: null
    description:
    - send-community attribute.
    required: false

unsuppress_map:
    default: null
    description:
    - unsuppress-map. Valid values are a string defining a route-map name or 'default'.
    required: false

filter_list_out:
    default: null
    description:
    - Valid values are a string defining a filter-list name, or 'default'.
    required: false

prefix_list_out:
    default: null
    description:
    - Valid values are a string defining a prefix-list name, or 'default'.
    required: false

max_prefix_limit:
    default: null
    description:
    - maximum-prefix limit value. Valid values are an integer value or 'default'.
    required: false

default_originate:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Activate the default-originate feature.
    required: false

suppress_inactive:
    choices:
    - 'true'
    - 'false'
    - default
    default: null
    description:
    - suppress-inactive feature.
    required: false

max_prefix_warning:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Optional warning-only keyword. Requires max_prefix_limit.
    required: false

advertise_map_exist:
    default: null
    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.
    required: false

max_prefix_interval:
    default: null
    description:
    - Optional restart interval. Valid values are an integer. Requires max_prefix_limit.
    required: false

max_prefix_threshold:
    default: null
    description:
    - Optional threshold percentage at which to generate a warning. Valid values are an
      integer value. Requires max_prefix_limit.
    required: false

next_hop_third_party:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Activate the next-hop-third-party feature.
    required: false

additional_paths_send:
    choices:
    - enable
    - disable
    - inherit
    default: null
    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).
    required: false

route_reflector_client:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Router reflector client.
    required: false

advertise_map_non_exist:
    default: null
    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.
    required: false

soft_reconfiguration_in:
    choices:
    - enable
    - always
    - inherit
    default: null
    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).
    required: false

additional_paths_receive:
    choices:
    - enable
    - disable
    - inherit
    default: null
    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).
    required: false

default_originate_route_map:
    default: null
    description:
    - Optional route-map for the default_originate property. Can be used independently
      or in conjunction with C(default_originate). Valid values are a string defining
      a route-map name, or 'default'.
    required: false

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
end_state:
  description: k/v pairs of configuration after module execution
  returned: verbose mode
  sample:
    additional_paths_receive: inherit
    additional_paths_send: inherit
    advertise_map_exist: []
    advertise_map_non_exist: []
    afi: ipv4
    allowas_in: false
    allowas_in_max: ''
    as_override: false
    asn: '65535'
    default_originate: false
    default_originate_route_map: ''
    filter_list_in: ''
    filter_list_out: ''
    max_prefix_interval: ''
    max_prefix_limit: ''
    max_prefix_threshold: ''
    max_prefix_warning: ''
    neighbor: 3.3.3.3
    next_hop_self: false
    next_hop_third_party: true
    prefix_list_in: ''
    prefix_list_out: ''
    route_map_in: ''
    route_map_out: ''
    route_reflector_client: true
    safi: unicast
    send_community: ''
    soft_reconfiguration_in: inherit
    soo: ''
    suppress_inactive: false
    unsuppress_map: ''
    vrf: default
    weight: ''
  type: dict
existing:
  description: k/v pairs of existing configuration
  returned: verbose mode
  sample: {}
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: verbose mode
  sample:
    afi: ipv4
    asn: '65535'
    neighbor: 3.3.3.3
    route_reflector_client: true
    safi: unicast
    vrf: default
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - router bgp 65535
  - neighbor 3.3.3.3
  - address-family ipv4 unicast
  - route-reflector-client
  type: list