ansible.builtin.pn_vrouterbgp (v2.7.18) — module

Install Ansible via pip

Install with pip install ansible==2.7.18

Description

Execute vrouter-bgp-add, vrouter-bgp-remove, vrouter-bgp-modify command.

Each fabric, cluster, standalone switch, or virtual network (VNET) can provide its tenants with a vRouter service that forwards traffic between networks and implements Layer 4 protocols.

Usage examples

Scanned by Steampunk Spotter

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

- name: add vrouter-bgp
  pn_vrouterbgp:
    state: 'present'
    pn_vrouter_name: 'ansible-vrouter'
    pn_neighbor: 104.104.104.1
    pn_remote_as: 1800

Scanned by Steampunk Spotter

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

- name: remove vrouter-bgp
  pn_vrouterbgp:
    state: 'absent'
    pn_name: 'ansible-vrouter'

Inputs

    
state:
    choices:
    - present
    - absent
    - update
    description:
    - State the action to perform. Use 'present' to add bgp, 'absent' to remove bgp and
      'update' to modify bgp.
    required: true

pn_bfd:
    description:
    - Specify if you want BFD protocol support for fault detection.

pn_ebgp:
    description:
    - Specify a value for external BGP to accept or attempt BGP connections to external
      peers, not directly connected, on the network. This is a value between 1 and 255.

pn_weight:
    description:
    - Specify a default weight value between 0 and 65535 for the neighbor routes.

pn_holdtime:
    description:
    - Specify BGP neighbor holdtime in seconds.

pn_neighbor:
    description:
    - Specify a neighbor IP address to use for BGP.
    - Required for vrouter-bgp-add.

pn_password:
    description:
    - Specify a password, if desired.

pn_cliswitch:
    description:
    - Target switch(es) to run the cli on.
    required: false

pn_keepalive:
    description:
    - Specify BGP neighbor keepalive interval in seconds.

pn_remote_as:
    description:
    - Specify the remote Autonomous System(AS) number. This value is between 1 and 4294967295.
    - Required for vrouter-bgp-add.

pn_max_prefix:
    description:
    - Specify the maximum number of prefixes.

pn_clipassword:
    description:
    - Provide login password if user is not root.
    required: false

pn_cliusername:
    description:
    - Provide login username if user is not root.
    required: false

pn_route_mapin:
    description:
    - Specify inbound route map for neighbor.

pn_route_mapout:
    description:
    - Specify outbound route map for neighbor.

pn_vrouter_name:
    description:
    - Specify a name for the vRouter service.
    required: true

pn_multiprotocol:
    choices:
    - ipv4-unicast
    - ipv6-unicast
    description:
    - Specify a multi-protocol for BGP.

pn_next_hop_self:
    description:
    - Specify if the next-hop is the same router or not.

pn_prefix_listin:
    description:
    - Specify the prefix list to filter traffic inbound.

pn_soft_reconfig:
    description:
    - Specify if you want a soft reconfiguration of inbound traffic.

pn_prefix_listout:
    description:
    - Specify the prefix list to filter traffic outbound.

pn_max_prefix_warn:
    description:
    - Specify if you want a warning message when the maximum number of prefixes is exceeded.

pn_route_reflector:
    description:
    - Specify if a route reflector client is used.

pn_default_originate:
    description:
    - Specify if you want announce default routes to the neighbor or not.

pn_override_capability:
    description:
    - Specify if you want to override capability.

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(s).
  returned: always
  type: str
stderr:
  description: The set of error responses from the vrouterbgp command.
  returned: on error
  type: list
stdout:
  description: The set of responses from the vrouterbpg command.
  returned: always
  type: list