community.network.pn_vrouter_bgp_network – CLI command to add/remove vrouter-bgp-network

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.pn_vrouter_bgp_network.

Synopsis
Parameters
Examples
Return Values

Synopsis

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

Parameters

Parameter	Choices/Defaults	Comments
pn_cliswitch string		Target switch to run the CLI on.
pn_netmask string		BGP network mask.
pn_network string		IP address for BGP network.
pn_vrouter_name string		name of service config.
state string / required	present absent	State the action to perform. Use `present` to add bgp network and `absent` to remove bgp network.

Examples

- name:  Add network to bgp
  community.network.pn_vrouter_bgp_network:
    pn_cliswitch: "sw01"
    state: "present"
    pn_vrouter_name: "foo-vrouter"
    pn_network: '10.10.10.10'
    pn_netmask: '31'

- name:  Remove network from bgp
  community.network.pn_vrouter_bgp_network:
    pn_cliswitch: "sw01"
    state: "absent"
    pn_vrouter_name: "foo-vrouter"
    pn_network: '10.10.10.10'

Return Values

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

Key	Returned	Description
changed boolean	always	indicates whether the CLI caused changes on the target.
command string	always	the CLI command run on the target node.
stderr list / elements=string	on error	set of error responses from the vrouter-bgp-network command.
stdout list / elements=string	always	set of responses from the vrouter-bgp-network command.

Authors

Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/pn_vrouter_bgp_network_module.html