ansible.builtin.pn_ospfarea (v2.7.18) — module

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

| "added in version" 2.2 of ansible.builtin"

Authors: Pluribus Networks (@amitsi)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.7.18

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
state:
    choices:
    - present
    - absent
    - update
    description:
    - State the action to perform. Use 'present' to add ospf-area, 'absent' to remove
      ospf-area and 'update' to modify ospf-area.
    required: true

pn_quiet:
    default: true
    description:
    - Enable/disable system information.
    required: false

pn_cliswitch:
    description:
    - Target switch(es) to run the CLI on.
    required: false

pn_ospf_area:
    description:
    - Specify the OSPF area number.
    required: true

pn_stub_type:
    choices:
    - none
    - stub
    - stub-no-summary
    - nssa
    - nssa-no-summary
    description:
    - Specify the OSPF stub type.

pn_clipassword:
    description:
    - Login password.
    required: true

pn_cliusername:
    description:
    - Login username.
    required: true

pn_vrouter_name:
    description:
    - Specify the name of the vRouter.
    required: true

pn_prefix_listin:
    description:
    - OSPF prefix list for filtering incoming packets.

pn_prefix_listout:
    description:
    - OSPF prefix list for filtering outgoing packets.

Outputs

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