Documentation

pn_ospfarea - CLI command to add/remove ospf area to/from a vrouter.

New in version 2.2.

Synopsis

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

Options

parameter required default choices comments
pn_clipassword
yes
Login password.
pn_cliswitch
no
Target switch(es) to run the CLI on.
pn_cliusername
yes
Login username.
pn_ospf_area
yes
Specify the OSPF area number.
pn_prefix_listin
no
OSPF prefix list for filtering incoming packets.
pn_prefix_listout
no
OSPF prefix list for filtering outgoing packets.
pn_quiet
no True
Enable/disable system information.
pn_stub_type
no
  • none
  • stub
  • stub-no-summary
  • nssa
  • nssa-no-summary
Specify the OSPF stub type.
pn_vrouter_name
yes
Specify the name of the vRouter.
state
yes
  • present
  • absent
  • update
State the action to perform. Use 'present' to add ospf-area, 'absent' to remove ospf-area and 'update' to modify ospf-area.

Examples

- name: "Add OSPF area to vrouter"
  pn_ospfarea:
    state: present
    pn_cliusername: admin
    pn_clipassword: admin
    pn_ospf_area: 1.0.0.0
    pn_stub_type: stub

- name: "Remove OSPF from vrouter"
  pn_ospf:
    state: absent
    pn_cliusername: admin
    pn_clipassword: admin
    pn_vrouter_name: name-string
    pn_ospf_area: 1.0.0.0

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).
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.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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