You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

pn_ospf - CLI command to add/remove ospf protocol to a vRouter.¶

New in version 2.2.

Synopsis
Options
Examples
Return Values
- Status

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.

Options ¶

parameter	required	default	choices	comments
pn_clipassword	no			Provide login password if user is not root.
pn_cliswitch	no			Target switch to run the CLI on.
pn_cliusername	no			Provide login username if user is not root.
pn_network_ip	yes			Specify the network IP (IPv4 or IPv6) address.
pn_ospf_area	no			Stub area number for the configuration. Required for vrouter-ospf-add.
pn_vrouter_name	yes			Specify the name of the vRouter.
state	yes	present	present absent	Assert the state of the ospf. Use 'present' to add ospf and 'absent' to remove ospf.

Examples ¶

- name: "Add OSPF to vrouter"
  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"
  pn_ospf:
    state: absent
    pn_vrouter_name: name-string

Return Values ¶

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

name	description	returned	type	sample
changed	Indicates whether the CLI caused changes on the target.	always	bool
command	The CLI command run on the target node(s).	always	str
stderr	The set of error responses from the ospf command.	on error	list
stdout	The set of responses from the ospf command.	always	list

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.