community.general.pn_vrouter_bgp (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module can be used to add Border Gateway Protocol neighbor to a vRouter modify Border Gateway Protocol neighbor to a vRouter and remove Border Gateway Protocol neighbor from a vRouter.

Usage examples

Scanned by Steampunk Spotter

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

- name: "Add BGP to vRouter"
  pn_vrouter_bgp:
    state: 'present'
    pn_vrouter_name: 'sw01-vrouter'
    pn_neighbor: '105.104.104.1'
    pn_remote_as: 65000
    pn_bfd: true

Scanned by Steampunk Spotter

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

- name: "Remove BGP to vRouter"
  pn_vrouter_bgp:
    state: 'absent'
    pn_vrouter_name: 'sw01-vrouter'
    pn_neighbor: '105.104.104.1'

Scanned by Steampunk Spotter

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

- name: "Modify BGP to vRouter"
  pn_vrouter_bgp:
    state: 'update'
    pn_vrouter_name: 'sw01-vrouter'
    pn_neighbor: '105.104.104.1'
    pn_remote_as: 65000
    pn_bfd: false
    pn_allowas_in: true

Inputs

    
state:
    choices:
    - present
    - absent
    - update
    default: present
    description:
    - vrouter-bgp configuration command.
    required: false
    type: str

pn_bfd:
    default: false
    description:
    - BFD protocol support for fault detection.
    required: false
    type: bool

pn_weight:
    description:
    - default weight value between 0 and 65535 for the neighbor's routes.
    required: false

pn_neighbor:
    description:
    - IP address for BGP neighbor.
    required: true
    type: str

pn_password:
    description:
    - password for MD5 BGP.
    required: false
    type: str

pn_cliswitch:
    description:
    - Target switch to run the CLI on.
    required: false
    type: str

pn_interface:
    description:
    - Interface to reach the neighbor.
    required: false
    type: str

pn_remote_as:
    description:
    - BGP remote AS from 1 to 4294967295.
    required: false
    type: str

pn_allowas_in:
    description:
    - Allow/reject routes with local AS in AS_PATH.
    required: false
    type: bool

pn_max_prefix:
    description:
    - maximum number of prefixes.
    required: false
    type: str

pn_bfd_multihop:
    description:
    - always use BFD multi-hop port for fault detection.
    required: false
    type: bool

pn_route_map_in:
    description:
    - route map in for nbr.
    required: false
    type: str

pn_vrouter_name:
    description:
    - name of service config.
    required: true
    type: str

pn_ebgp_multihop:
    description:
    - value for external BGP from 1 to 255.
    required: false
    type: str

pn_next_hop_self:
    description:
    - BGP next hop is self or not.
    required: false
    type: bool

pn_route_map_out:
    description:
    - route map out for nbr.
    required: false
    type: str

pn_update_source:
    description:
    - IP address of BGP packets required for peering over loopback interface.
    required: false
    type: str

pn_multi_protocol:
    choices:
    - ipv4-unicast
    - ipv6-unicast
    description:
    - Multi-protocol features.
    required: false

pn_prefix_list_in:
    description:
    - prefixes used for filtering.
    required: false
    type: str

pn_send_community:
    description:
    - send any community attribute to neighbor.
    required: false
    type: bool

pn_no_route_map_in:
    description:
    - Remove ingress route-map from BGP neighbor.
    required: false
    type: str

pn_prefix_list_out:
    description:
    - prefixes used for filtering outgoing packets.
    required: false
    type: str

pn_no_route_map_out:
    description:
    - Remove egress route-map from BGP neighbor.
    required: false
    type: str

pn_default_originate:
    description:
    - announce default routes to the neighbor or not.
    required: false
    type: bool

pn_neighbor_holdtime:
    description:
    - BGP Holdtime (seconds).
    required: false
    type: str

pn_override_capability:
    description:
    - override capability.
    required: false
    type: bool

pn_max_prefix_warn_only:
    description:
    - warn if the maximum number of prefixes is exceeded.
    required: false
    type: bool

pn_soft_reconfig_inbound:
    description:
    - soft reset to reconfigure inbound traffic.
    required: false
    type: bool

pn_advertisement_interval:
    description:
    - Minimum interval between sending BGP routing updates.
    required: false
    type: str

pn_connect_retry_interval:
    description:
    - BGP Connect retry interval (seconds).
    required: false
    type: str

pn_route_reflector_client:
    description:
    - set as route reflector client.
    required: false
    type: bool

pn_neighbor_keepalive_interval:
    description:
    - BGP Keepalive interval (seconds).
    required: false
    type: str

Outputs

changed:
  description: indicates whether the CLI caused changes on the target.
  returned: always
  type: bool
command:
  description: the CLI command run on the target node.
  returned: always
  type: str
stderr:
  description: set of error responses from the vrouter-bgp command.
  returned: on error
  type: list
stdout:
  description: set of responses from the vrouter-bgp command.
  returned: always
  type: list