W3cubDocs

/Ansible 2.10

community.network.pn_ospf – CLI command to add/remove ospf protocol to a vRouter.

Note

This plugin is part of the community.network collection.

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

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

DEPRECATED

Removed in

version 2.0.0

Why

Doesn’t support latest Pluribus Networks netvisor

Alternative

Latest modules will be pushed in Ansible future versions.

Synopsis

  • Execute vrouter-ospf-add, vrouter-ospf-remove command.
  • This command adds/removes Open Shortest Path First(OSPF) routing protocol to a virtual router(vRouter) service.

Parameters

Parameter Choices/Defaults Comments
pn_clipassword
string
Provide login password if user is not root.
pn_cliswitch
string
Default:
"local"
Target switch to run the CLI on.
pn_cliusername
string
Provide login username if user is not root.
pn_network_ip
string / required
Specify the network IP (IPv4 or IPv6) address.
pn_ospf_area
string
Stub area number for the configuration. Required for vrouter-ospf-add.
pn_vrouter_name
string / required
Specify the name of the vRouter.
state
string / required
    Choices:
  • present ←
  • absent
Assert the state of the ospf. Use 'present' to add ospf and 'absent' to remove ospf.

Examples

- name: "Add OSPF to vrouter"
  community.network.pn_ospf:
    state: present
    pn_vrouter_name: name-string
    pn_network_ip: 192.168.11.2/24
    pn_ospf_area: 1.0.0.0

- name: "Remove OSPF from vrouter"
  community.network.pn_ospf:
    state: absent
    pn_vrouter_name: name-string

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(s).
stderr
list / elements=string
on error
The set of error responses from the ospf command.
stdout
list / elements=string
always
The set of responses from the ospf command.


Status

  • This module will be removed in version 2.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Pluribus Networks (@amitsi)

© 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_ospf_module.html