.. _arista.eos.eos_ospfv2_module:
*********************
arista.eos.eos_ospfv2
*********************
**OSPFv2 resource module**
Version added: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module configures and manages the attributes of ospfv2 on Arista EOS platforms.
Parameters
----------
.. raw:: html
Parameter |
Choices/Defaults |
Comments |
config
dictionary
|
|
A list of configurations for ospfv2.
|
|
processes
list
/ elements=dictionary
|
|
A list of dictionary specifying the ospfv2 processes.
|
|
|
adjacency
dictionary
|
|
Configure adjacency options for OSPF instance.
|
|
|
|
exchange_start
dictionary
|
|
Configure exchange-start options for OSPF instance.
|
|
|
|
|
threshold
integer
|
|
Number of peers to bring up simultaneously.
|
|
|
areas
list
/ elements=dictionary
|
|
Specifies the configuration for OSPF areas
|
|
|
|
area_id
string
|
|
Specifies a 32 bit number expressed in decimal or dotted-decimal notation.
|
|
|
|
default_cost
integer
|
|
Specify the cost for default summary route in stub/NSSA area.
|
|
|
|
filter
dictionary
|
|
Specify the filter for incoming summary LSAs.
|
|
|
|
|
address
string
|
|
IP address.
|
|
|
|
|
prefix_list
string
|
|
Specify list to filter for incoming LSAs.
|
|
|
|
|
subnet_address
string
|
|
IP address with mask length
|
|
|
|
|
subnet_mask
string
|
|
IP subnet mask
|
|
|
|
not_so_stubby
dictionary
|
|
Configures NSSA parameters.
|
|
|
|
|
default_information_originate
dictionary
|
|
Originate default Type 7 LSA.
|
|
|
|
|
|
metric
integer
|
|
Metric for default route.
|
|
|
|
|
|
metric_type
integer
|
|
Metric type for default route.
|
|
|
|
|
|
nssa_only
boolean
|
|
Limit default advertisement to this NSSA area.
|
|
|
|
|
lsa
boolean
|
|
lsa parameters
|
|
|
|
|
no_summary
boolean
|
|
Filter all type-3 LSAs in the nssa area.
|
|
|
|
|
nssa_only
boolean
|
|
Disable Type-7 LSA p-bit setting
|
|
|
|
|
set
boolean
|
|
Set config up to not-so-stubby
|
|
|
|
nssa
dictionary
|
|
Configures NSSA parameters.
|
|
|
|
|
default_information_originate
dictionary
|
|
Originate default Type 7 LSA.
|
|
|
|
|
|
metric
integer
|
|
Metric for default route.
|
|
|
|
|
|
metric_type
integer
|
|
Metric type for default route.
|
|
|
|
|
|
nssa_only
boolean
|
|
Limit default advertisement to this NSSA area.
|
|
|
|
|
no_summary
boolean
|
|
Filter all type-3 LSAs in the nssa area.
|
|
|
|
|
nssa_only
boolean
|
|
Disable Type-7 LSA p-bit setting
|
|
|
|
|
set
boolean
|
|
Set config up to nssa
|
|
|
|
range
dictionary
|
|
Configure route summarization.
|
|
|
|
|
address
string
|
|
IP address.
|
|
|
|
|
advertise
boolean
|
|
Enable Advertisement of the range.
|
|
|
|
|
cost
integer
|
|
Configures the metric.
|
|
|
|
|
subnet_address
string
|
|
IP address with mask length
|
|
|
|
|
subnet_mask
string
|
|
IP subnet mask
|
|
|
|
stub
dictionary
|
|
Stub area.
|
|
|
|
|
no_summary
boolean
|
|
If False , Filter all type-3 LSAs in the stub area.
|
|
|
|
|
set
boolean
|
|
When true sets the stub config alone.
|
|
|
auto_cost
dictionary
|
|
Set auto-cost.
|
|
|
|
reference_bandwidth
integer
|
|
reference bandwidth in megabits per sec.
|
|
|
bfd
dictionary
|
|
Enable BFD.
|
|
|
|
all_interfaces
boolean
|
|
Enable BFD on all interfaces.
|
|
|
default_information
dictionary
|
|
Control distribution of default information.
|
|
|
|
always
boolean
|
|
Always advertise default route.
|
|
|
|
metric
integer
|
|
Metric for default route.
|
|
|
|
metric_type
integer
|
|
Metric type for default route.
|
|
|
|
originate
boolean
|
|
Distribute a default route.
|
|
|
|
route_map
string
|
|
Specify which route-map to use.
|
|
|
default_metric
integer
|
|
Configure the default metric for redistributed routes
|
|
|
distance
dictionary
|
|
Specifies the administrative distance for routes.
|
|
|
|
external
integer
|
|
Routes external to the area
|
|
|
|
inter_area
integer
|
|
Routes from other areas
|
|
|
|
intra_area
integer
|
|
Routes with in an area
|
|
|
distribute_list
dictionary
|
|
Specifies the list of routes to be filtered.
|
|
|
|
prefix_list
string
|
|
prefix list to be filtered
|
|
|
|
route_map
string
|
|
route map to be filtered
|
|
|
dn_bit_ignore
boolean
|
|
If True, Disable dn-bit check for Type-3 LSAs in non-default VRFs.
|
|
|
fips_restrictions
string
|
|
Use FIPS compliant algorithms
|
|
|
graceful_restart
dictionary
|
|
Enable graceful restart mode.
|
|
|
|
grace_period
integer
|
|
Specify maximum time to wait for graceful-restart to complete.
|
|
|
|
set
boolean
|
|
When true sets the grace_fulrestart config alone.
|
|
|
graceful_restart_helper
boolean
|
|
If True, Enable graceful restart helper.
|
|
|
log_adjacency_changes
dictionary
|
|
To configure link-state changes and transitions of OSPFv2 neighbors.
|
|
|
|
detail
boolean
|
|
If true , configures the switch to log all link-state changes.
|
|
|
max_lsa
dictionary
|
|
Specifies the switch behavior on reaching max lsa count.
|
|
|
|
count
integer
|
|
maximum count of lsas.
|
|
|
|
ignore_count
integer
|
|
No. of times the switch can shut down temporarily on warning
|
|
|
|
ignore_time
integer
|
|
time in minutes, for which the switch shoud be shutdown on max-lsa warning
|
|
|
|
reset_time
integer
|
|
Time in minutes, after which the shutdown counter resets.
|
|
|
|
threshold
integer
|
|
percentage of <count> , when a warning should be raised.
|
|
|
|
warning
boolean
|
|
Only give warning message when limit is exceeded
|
|
|
max_metric
dictionary
|
|
Set maximum metric.
|
|
|
|
router_lsa
dictionary
|
|
Maximum metric in self-originated router-LSAs.
|
|
|
|
|
external_lsa
dictionary
|
|
Override external-lsa metric with max-metric value.
|
|
|
|
|
|
max_metric_value
integer
|
|
Set max metric value for external LSAs.
|
|
|
|
|
|
set
boolean
|
|
Set external-lsa attribute.
|
|
|
|
|
include_stub
boolean
|
|
Set maximum metric for stub links in router-LSAs.
|
|
|
|
|
on_startup
dictionary
|
|
Set maximum metric temporarily after reboot.
|
|
|
|
|
|
wait_period
integer
|
|
Wait period in seconds after startup.
|
|
|
|
|
set
boolean
|
|
Set router-lsa attribute.
|
|
|
|
|
summary_lsa
dictionary
|
|
Override summary-lsa metric with max-metric value.
|
|
|
|
|
|
max_metric_value
integer
|
|
Set max metric value for external LSAs.
|
|
|
|
|
|
set
boolean
|
|
Set external-lsa attribute.
|
|
|
maximum_paths
integer
|
|
Maximum number of next-hops in an ECMP route.
|
|
|
mpls_ldp
boolean
|
|
mpls ldp sync configuration.
|
|
|
networks
list
/ elements=dictionary
|
|
Configure routing for a network.
|
|
|
|
area
string
|
|
Configure OSPF area.
|
|
|
|
mask
string
|
|
Network Wildcard Mask.
|
|
|
|
network_address
string
|
|
Network Address.
|
|
|
|
prefix
string
|
|
Prefix.
|
|
|
passive_interface
dictionary
|
|
Include interface but without actively running OSPF.
|
|
|
|
default
boolean
|
|
If True, Set all interfaces to passive by default
|
|
|
|
interface_list
string
|
|
Interface range.
|
|
|
point_to_point
boolean
|
|
Configure Point-to-point specific features.
|
|
|
process_id
integer
|
|
ID of OSPFV2 process.
|
|
|
redistribute
list
/ elements=dictionary
|
|
Specifies the routes to be redistributed
|
|
|
|
isis_level
string
|
|
ISIS levels.
|
|
|
|
route_map
string
|
|
Specify which route map to use.
|
|
|
|
routes
string
|
|
Route types (BGP,isis,connected etc)
|
|
|
retransmission_threshold
integer
|
|
Configure threshold for retransmission.
|
|
|
rfc1583compatibility
boolean
|
|
Specifies different methods for calculating summary route metrics.
|
|
|
router_id
string
|
|
32-bit number assigned to a router running OSPFv2.
|
|
|
shutdown
boolean
|
|
Disable the OSPF instance.
|
|
|
summary_address
dictionary
|
|
Summary route configuration.
|
|
|
|
address
string
|
|
IP summary address.
|
|
|
|
attribute_map
string
|
|
Set attributes of summary route.
|
|
|
|
mask
string
|
|
Summary Mask.
|
|
|
|
not_advertise
boolean
|
|
Do not advertise summary route.
|
|
|
|
prefix
string
|
|
Prefix.
|
|
|
|
tag
integer
|
|
Set tag.
|
|
|
timers
list
/ elements=dictionary
|
|
Configure OSPF timers.
|
|
|
|
lsa
dictionary
|
|
Configure OSPF LSA timers.
|
|
|
|
|
rx
dictionary
|
|
Configure OSPF LSA receiving timers
|
|
|
|
|
|
min_interval
integer
|
|
Configure OSPF LSA arrival timer.
|
|
|
|
|
tx
dictionary
|
|
Configure OSPF LSA transmission timers.
|
|
|
|
|
|
delay
dictionary
|
|
Configure OSPF LSA transmission delay.
|
|
|
|
|
|
|
initial
integer
|
|
Delay to generate first occurrence of LSA in msecs.
|
|
|
|
|
|
|
max
integer
|
|
Maximum delay between originating the same LSA in msecs.
|
|
|
|
|
|
|
min
integer
|
|
Min delay between originating the same LSA in msecs.
|
|
|
|
out_delay
integer
|
|
Configure out-delay timer.
|
|
|
|
pacing
integer
|
|
Configure OSPF packet pacing.
|
|
|
|
spf
dictionary
|
|
Configure SPF timers
|
|
|
|
|
initial
integer
|
|
Initial SPF schedule delay in msecs.
|
|
|
|
|
max
integer
|
|
Max wait time between two SPFs in msecs.
|
|
|
|
|
min
integer
|
|
Min Hold time between two SPFs in msecs
|
|
|
|
|
seconds
integer
|
|
Seconds.
|
|
|
|
throttle
dictionary
|
|
Configure throttle timers(valid only for eos version < 4.23).
|
|
|
|
|
attr
string
|
|
throttle attribute.
|
|
|
|
|
initial
integer
|
|
Initial schedule delay in msecs.
|
|
|
|
|
max
integer
|
|
Max wait time
|
|
|
|
|
min
integer
|
|
Min Hold time
|
|
|
traffic_engineering
boolean
|
|
Enter traffic engineering config mode
|
|
|
vrf
string
|
|
VRF name .
|
running_config
string
|
|
This option is used only with state parsed.
The value of this option should be the output received from the EOS device by executing the command show running-config | section ospf.
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:
- deleted
merged ←
- overridden
- replaced
- gathered
- rendered
- parsed
|
The state the configuration should be left in.
|