community.network.pn_vrouter_ospf – CLI command to add/remove vrouter-ospf

From Get docs
Ansible/docs/2.10/collections/community/network/pn vrouter ospf module


community.network.pn_vrouter_ospf – CLI command to add/remove vrouter-ospf

Note

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

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

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


Synopsis

  • This module can be used to add OSPF protocol to vRouter and remove OSPF protocol from a vRouter

Parameters

Parameter Choices/Defaults Comments

pn_cliswitch

string

Target switch to run the CLI on.

pn_netmask

string

OSPF network IP address netmask.

pn_network

string / required

OSPF network IP address.

pn_ospf_area

string

stub area number for the configuration.

pn_vrouter_name

string / required

name of service config.

state

string

  • present

  • absent

vrouter-ospf configuration command.



Examples

- name: Add OSPF to vRouter
  community.network.pn_vrouter_ospf:
    state: 'present'
    pn_vrouter_name: 'sw01-vrouter'
    pn_network: '105.104.104.1'
    pn_netmask: '24'
    pn_ospf_area: '0'
- name: "Remove OSPF to vRouter"
  community.network.pn_vrouter_ospf:
    state: 'absent'
    pn_vrouter_name: 'sw01-vrouter'
    pn_network: '105.104.104.1'

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-ospf command.


stdout

list / elements=string

always

set of responses from the vrouter-ospf command.





Authors

  • Pluribus Networks (@rajaspachipulusu17)

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