community.general.pn_ospf (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Assert the state of the ospf. Use 'present' to add ospf and 'absent' to remove ospf.
    required: true

pn_cliswitch:
    default: local
    description:
    - Target switch to run the CLI on.
    required: false

pn_ospf_area:
    description:
    - Stub area number for the configuration. Required for vrouter-ospf-add.

pn_network_ip:
    description:
    - Specify the network IP (IPv4 or IPv6) address.
    required: true

pn_clipassword:
    description:
    - Provide login password if user is not root.
    required: false

pn_cliusername:
    description:
    - Provide login username if user is not root.
    required: false

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

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