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

Note

This module is part of the community.network collection (version 5.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Note

The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.

DEPRECATED

Removed in:

version 6.0.0

Why:

This collection and all content in it is unmaintained and deprecated.

Alternative:

Unknown.

Synopsis

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

Aliases: network.netvisor.pn_vrouter_ospf

Parameters

Parameter

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

vrouter-ospf configuration command.

Choices:

  • "present" ← (default)

  • "absent"

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

Description

changed

boolean

indicates whether the CLI caused changes on the target.

Returned: always

command

string

the CLI command run on the target node.

Returned: always

stderr

list / elements=string

set of error responses from the vrouter-ospf command.

Returned: on error

stdout

list / elements=string

set of responses from the vrouter-ospf command.

Returned: always

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Pluribus Networks (@rajaspachipulusu17)