Documentation

pn_vrouterbgp - CLI command to add/remove/modify vrouter-bgp.

New in version 2.2.

Synopsis

  • 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.

Options

parameter required default choices comments
pn_bfd
no
Specify if you want BFD protocol support for fault detection.
pn_clipassword
no
Provide login password if user is not root.
pn_cliswitch
no
Target switch(es) to run the cli on.
pn_cliusername
no
Provide login username if user is not root.
pn_default_originate
no
Specify if you want announce default routes to the neighbor or not.
pn_ebgp
no
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_holdtime
no
Specify BGP neighbor holdtime in seconds.
pn_keepalive
no
Specify BGP neighbor keepalive interval in seconds.
pn_max_prefix
no
Specify the maximum number of prefixes.
pn_max_prefix_warn
no
Specify if you want a warning message when the maximum number of prefixes is exceeded.
pn_multiprotocol
no
  • ipv4-unicast
  • ipv6-unicast
Specify a multi-protocol for BGP.
pn_neighbor
no
Specify a neighbor IP address to use for BGP.
Required for vrouter-bgp-add.
pn_next_hop_self
no
Specify if the next-hop is the same router or not.
pn_override_capability
no
Specify if you want to override capability.
pn_password
no
Specify a password, if desired.
pn_prefix_listin
no
Specify the prefix list to filter traffic inbound.
pn_prefix_listout
no
Specify the prefix list to filter traffic outbound.
pn_remote_as
no
Specify the remote Autonomous System(AS) number. This value is between 1 and 4294967295.
Required for vrouter-bgp-add.
pn_route_mapin
no
Specify inbound route map for neighbor.
pn_route_mapout
no
Specify outbound route map for neighbor.
pn_route_reflector
no
Specify if a route reflector client is used.
pn_soft_reconfig
no
Specify if you want a soft reconfiguration of inbound traffic.
pn_vrouter_name
yes
Specify a name for the vRouter service.
pn_weight
no
Specify a default weight value between 0 and 65535 for the neighbor routes.
state
yes
  • present
  • absent
  • update
State the action to perform. Use 'present' to add bgp, 'absent' to remove bgp and 'update' to modify bgp.

Examples

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

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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
changed Indicates whether the CLI caused changes on the target. always bool
command The CLI command run on the target node(s). always str
stderr The set of error responses from the vrouterbgp command. on error list
stdout The set of responses from the vrouterbpg command. always list


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.