.. _vyos.vyos.vyos_ospf_interfaces_module:
******************************
vyos.vyos.vyos_ospf_interfaces
******************************
**OSPF Interfaces Resource Module.**
Version added: 1.2.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module manages OSPF configuration of interfaces on devices running VYOS.
Parameters
----------
.. raw:: html
Parameter |
Choices/Defaults |
Comments |
config
list
/ elements=dictionary
|
|
A list of OSPF configuration for interfaces.
|
|
address_family
list
/ elements=dictionary
|
|
OSPF settings on the interfaces in address-family context.
|
|
|
afi
string
/ required
|
|
Address Family Identifier (AFI) for OSPF settings on the interfaces.
|
|
|
authentication
dictionary
|
|
Authentication settings on the interface.
|
|
|
|
md5_key
dictionary
|
|
md5 parameters.
|
|
|
|
|
key
string
|
|
md5 key.
|
|
|
|
|
key_id
integer
|
|
key id.
|
|
|
|
plaintext_password
string
|
|
Plain Text password.
|
|
|
bandwidth
integer
|
|
Bandwidth of interface (kilobits/sec)
|
|
|
cost
integer
|
|
metric associated with interface.
|
|
|
dead_interval
integer
|
|
Time interval to detect a dead router.
|
|
|
hello_interval
integer
|
|
Timer interval between transmission of hello packets.
|
|
|
ifmtu
integer
|
|
interface MTU.
|
|
|
instance
string
|
|
Instance ID.
|
|
|
mtu_ignore
boolean
|
|
if True, Disable MTU check for Database Description packets.
|
|
|
network
string
|
|
Interface type.
|
|
|
passive
boolean
|
|
If True, disables forming adjacency.
|
|
|
priority
integer
|
|
Interface priority.
|
|
|
retransmit_interval
integer
|
|
LSA retransmission interval.
|
|
|
transmit_delay
integer
|
|
LSA transmission delay.
|
|
name
string
|
|
Name/Identifier of the interface.
|
running_config
string
|
|
This option is used only with state parsed.
The value of this option should be the output received from the VYOS device by executing the command show configuration commands | match "set interfaces".
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
|
state
string
|
Choices:
merged ←
- replaced
- overridden
- deleted
- gathered
- parsed
- rendered
|
The state the configuration should be left in.
|