ansible.builtin.nxos_bgp (v2.9.13) — module

Install Ansible via pip

Install with pip install ansible==2.9.13

Description

Manages BGP configurations on NX-OS switches.

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure a simple ASN
  nxos_bgp:
      asn: 65535
      vrf: test
      router_id: 192.0.2.1
      state: present

Inputs

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

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

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

isolate:
    description:
    - Enable/Disable isolate this router from BGP perspective.
    type: bool

local_as:
    description:
    - Local AS number to be used within a VRF instance.

provider:
    description:
    - B(Deprecated)
    - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
    - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.'
    - This option will be removed in a release after 2022-06-01.
    - For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html).
    - HORIZONTALLINE
    - A dict object containing connection details.
    suboptions:
      auth_pass:
        description:
        - Specifies the password to use if required to enter privileged mode on the remote
          device.  If I(authorize) is false, then this argument does nothing. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
          will be used instead.
        type: str
      authorize:
        default: false
        description:
        - Instructs the module to enter privileged mode on the remote device before sending
          any commands.  If not specified, the device will attempt to execute all commands
          in non-privileged mode. If the value is not specified in the task, the value
          of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead.
        type: bool
      host:
        description:
        - Specifies the DNS host name or address for connecting to the remote device over
          the specified transport.  The value of host is used as the destination address
          for the transport.
        type: str
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote device.  This
          is a common argument used for either I(cli) or I(nxapi) transports. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
          will be used instead.
        type: str
      port:
        description:
        - Specifies the port to use when building the connection to the remote device.  This
          value applies to either I(cli) or I(nxapi).  The port value will default to
          the appropriate transport common port if none is provided in the task.  (cli=22,
          http=80, https=443).
        type: int
      ssh_keyfile:
        description:
        - Specifies the SSH key to use to authenticate the connection to the remote device.  This
          argument is only used for the I(cli) transport. If the value is not specified
          in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will
          be used instead.
        type: str
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error. NX-API can be slow to return
          on long-running commands (sh mac, sh bgp, etc).
        type: int
      transport:
        choices:
        - cli
        - nxapi
        default: cli
        description:
        - Configures the transport connection to use when connecting to the remote device.  The
          transport argument supports connectivity to the device over cli (ssh) or nxapi.
        type: str
      use_proxy:
        default: true
        description:
        - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
          ignored.
        type: bool
      use_ssl:
        default: false
        description:
        - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi),
          otherwise this value is ignored.
        type: bool
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          device.  This value is used to authenticate either the CLI login or the nxapi
          authentication depending on which transport is used. If the value is not specified
          in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will
          be used instead.
        type: str
      validate_certs:
        default: false
        description:
        - If C(no), SSL certificates will not be validated. This should only be used on
          personally controlled sites using self-signed certificates.  If the transport
          argument is not nxapi, this value is ignored.
        type: bool
    type: dict

shutdown:
    description:
    - Administratively shutdown the BGP protocol.
    type: bool

router_id:
    description:
    - Router Identifier (ID) of the BGP router VRF instance.

cluster_id:
    description:
    - Route Reflector Cluster-ID.

maxas_limit:
    description:
    - Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values
      are between 1 and 512.

flush_routes:
    description:
    - Enable/Disable flush routes in RIB upon controlled restart. On NX-OS, this property
      is only supported in the global BGP context.
    type: bool

timer_bgp_hold:
    description:
    - Set BGP hold timer.

confederation_id:
    description:
    - Routing domain confederation AS.

enforce_first_as:
    description:
    - Enable/Disable enforces the neighbor autonomous system to be the first AS number
      listed in the AS path attribute for eBGP. On NX-OS, this property is only supported
      in the global BGP context.
    type: bool

graceful_restart:
    description:
    - Enable/Disable graceful restart.
    type: bool

event_history_cli:
    choices:
    - size_small
    - size_medium
    - size_large
    - size_disable
    - default
    description:
    - Enable/Disable cli event history buffer.

reconnect_interval:
    description:
    - The BGP reconnection interval for dropped sessions. Valid values are between 1 and
      60.

bestpath_med_confed:
    description:
    - Enable/Disable enforcement of bestpath to do a MED comparison only between paths
      originated within a confederation.
    type: bool

confederation_peers:
    description:
    - AS confederation parameters.

timer_bgp_keepalive:
    description:
    - Set BGP keepalive timer.

event_history_detail:
    choices:
    - size_small
    - size_medium
    - size_large
    - size_disable
    - default
    description:
    - Enable/Disable detail event history buffer.

event_history_events:
    choices:
    - size_small
    - size_medium
    - size_large
    - size_disable
    - default
    description:
    - Enable/Disable event history buffer.

log_neighbor_changes:
    description:
    - Enable/Disable message logging for neighbor up/down event.
    type: bool

suppress_fib_pending:
    description:
    - Enable/Disable advertise only routes programmed in hardware to peers.
    type: bool

timer_bestpath_limit:
    description:
    - Specify timeout for the first best path after a restart, in seconds.

event_history_periodic:
    choices:
    - size_small
    - size_medium
    - size_large
    - size_disable
    - default
    description:
    - Enable/Disable periodic event history buffer.

fast_external_fallover:
    description:
    - Enable/Disable immediately reset the session if the link to a directly connected
      BGP peer goes down.  Only supported in the global BGP context.
    type: bool

disable_policy_batching:
    description:
    - Enable/Disable the batching evaluation of prefix advertisement to all peers.
    type: bool

graceful_restart_helper:
    description:
    - Enable/Disable graceful restart helper mode.
    type: bool

bestpath_compare_routerid:
    description:
    - Enable/Disable comparison of router IDs for identical eBGP paths.
    type: bool

bestpath_always_compare_med:
    description:
    - Enable/Disable MED comparison on paths from different autonomous systems.
    type: bool

bestpath_compare_neighborid:
    description:
    - Enable/Disable neighborid. Use this when more paths available than max path config.
    type: bool

neighbor_down_fib_accelerate:
    description:
    - Enable/Disable handle BGP neighbor down event, due to various reasons.
    type: bool

bestpath_med_missing_as_worst:
    description:
    - Enable/Disable assigns the value of infinity to received routes that do not carry
      the MED attribute, making these routes the least desirable.
    type: bool

bestpath_cost_community_ignore:
    description:
    - Enable/Disable Ignores the cost community for BGP best-path calculations.
    type: bool

bestpath_med_non_deterministic:
    description:
    - Enable/Disable deterministic selection of the best MED pat from among the paths
      from the same autonomous system.
    type: bool

bestpath_aspath_multipath_relax:
    description:
    - Enable/Disable load sharing across the providers with different (but equal-length)
      AS paths.
    type: bool

graceful_restart_timers_restart:
    description:
    - Set maximum time for a restart sent to the BGP peer.

graceful_restart_timers_stalepath_time:
    description:
    - Set maximum time that BGP keeps the stale routes from the restarting BGP peer.

disable_policy_batching_ipv4_prefix_list:
    description:
    - Enable/Disable the batching evaluation of prefix advertisements to all peers with
      prefix list.

disable_policy_batching_ipv6_prefix_list:
    description:
    - Enable/Disable the batching evaluation of prefix advertisements to all peers with
      prefix list.

Outputs

commands:
  description: commands sent to the device
  returned: always
  sample:
  - router bgp 65535
  - vrf test
  - router-id 192.0.2.1
  type: list