pn_ospf - CLI command to add/remove ospf protocol to 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) routing protocol to a virtual router(vRouter) service.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_clipassword |
Provide login password if user is not root.
|
|
| pn_cliswitch |
Target switch to run the CLI on.
|
|
| pn_cliusername |
Provide login username if user is not root.
|
|
| pn_network_ip
required
|
Specify the network IP (IPv4 or IPv6) address.
|
|
| pn_ospf_area |
Stub area number for the configuration. Required for vrouter-ospf-add.
|
|
| pn_vrouter_name
required
|
Specify the name of the vRouter.
|
|
| state
required
|
|
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, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed
bool
|
always |
Indicates whether the CLI caused changes on the target.
|
| command
str
|
always |
The CLI command run on the target node(s).
|
| stderr
list
|
on error |
The set of error responses from the ospf command.
|
| stdout
list
|
always |
The set of responses from the ospf command.
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Pluribus Networks (@amitsi)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/pn_ospf_module.html