New in version 2.2.
Parameter | Choices/Defaults | Comments |
---|---|---|
pn_bfd | Specify if you want BFD protocol support for fault detection. | |
pn_clipassword | Provide login password if user is not root. | |
pn_cliswitch | Target switch(es) to run the cli on. | |
pn_cliusername | Provide login username if user is not root. | |
pn_default_originate | Specify if you want announce default routes to the neighbor or not. | |
pn_ebgp | 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 | Specify BGP neighbor holdtime in seconds. | |
pn_keepalive | Specify BGP neighbor keepalive interval in seconds. | |
pn_max_prefix | Specify the maximum number of prefixes. | |
pn_max_prefix_warn | Specify if you want a warning message when the maximum number of prefixes is exceeded. | |
pn_multiprotocol |
| Specify a multi-protocol for BGP. |
pn_neighbor | Specify a neighbor IP address to use for BGP. Required for vrouter-bgp-add. | |
pn_next_hop_self | Specify if the next-hop is the same router or not. | |
pn_override_capability | Specify if you want to override capability. | |
pn_password | Specify a password, if desired. | |
pn_prefix_listin | Specify the prefix list to filter traffic inbound. | |
pn_prefix_listout | Specify the prefix list to filter traffic outbound. | |
pn_remote_as | Specify the remote Autonomous System(AS) number. This value is between 1 and 4294967295. Required for vrouter-bgp-add. | |
pn_route_mapin | Specify inbound route map for neighbor. | |
pn_route_mapout | Specify outbound route map for neighbor. | |
pn_route_reflector | Specify if a route reflector client is used. | |
pn_soft_reconfig | Specify if you want a soft reconfiguration of inbound traffic. | |
pn_vrouter_name required | Specify a name for the vRouter service. | |
pn_weight | Specify a default weight value between 0 and 65535 for the neighbor routes. | |
state required |
| State the action to perform. Use 'present' to add bgp, 'absent' to remove bgp and 'update' to modify bgp. |
- 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'
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed bool | always | Indicates whether the CLI caused changes on the target. |
command str | always | The CLI command run on the target node(s). |
stderr list | on error | The set of error responses from the vrouterbgp command. |
stdout list | always | The set of responses from the vrouterbpg command. |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/pn_vrouterbgp_module.html