.. _arista.eos.eos_ospfv3_module:
*********************
arista.eos.eos_ospfv3
*********************
**OSPFv3 resource module**
Version added: 1.1.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module configures and manages the attributes of ospfv3 on Arista EOS platforms.
Parameters
----------
.. raw:: html
| Parameter |
Choices/Defaults |
Comments |
|
config
dictionary
|
|
A list of configurations for ospfv3.
|
|
processes
list
/ elements=dictionary
|
|
A list of dictionary specifying the ospfv3 processes.
|
|
|
address_family
list
/ elements=dictionary
|
|
Enable address family and enter its config mode
|
|
|
|
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.
|
|
|
|
afi
string
|
|
address family .
|
|
|
|
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.
|
|
|
|
|
authentication
dictionary
|
|
Configure authentication for the area incase of ospfv3.
|
|
|
|
|
|
algorithm
string
|
|
Name of algorithm to be used.
|
|
|
|
|
|
encrypt_key
boolean
|
|
If False, key string is not encrypted
|
|
|
|
|
|
hidden_key
boolean
|
|
If True, Specifies that a HIDDEN key will follow.
|
|
|
|
|
|
key
string
|
|
128 bit MD5 key or 140 bit SHA1 key.
|
|
|
|
|
|
passphrase
string
|
|
Passphrase String for deriving keys for authentication and encryption.
|
|
|
|
|
|
spi
integer
|
|
Specify the SPI value
|
|
|
|
|
default_cost
integer
|
|
Specify the cost for default summary route in stub/NSSA area.
|
|
|
|
|
encryption
dictionary
|
|
Configure encryption for the area
|
|
|
|
|
|
algorithm
string
|
|
name of the algorithm to be used.
|
|
|
|
|
|
encrypt_key
boolean
|
|
If False, key string is not encrypted
|
|
|
|
|
|
encryption
string
|
Choices:
- 3des-cbc
- aes-128-cbc
- aes-192-cbc
- aes-256-cbc
- null
|
name of encryption to be used.
|
|
|
|
|
|
hidden_key
boolean
|
|
If True, Specifies that a HIDDEN key will follow.
|
|
|
|
|
|
key
string
|
|
128 bit MD5 key or 140 bit SHA1 key.
|
|
|
|
|
|
passphrase
string
|
|
Passphrase String for deriving keys for authentication and encryption.
|
|
|
|
|
|
spi
integer
|
|
Specify the SPI value
|
|
|
|
|
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.
|
|
|
|
|
|
|
set
boolean
|
|
True if only default information orignate is set
|
|
|
|
|
|
no_summary
boolean
|
|
Filter all type-3 LSAs in the nssa area.
|
|
|
|
|
|
nssa_only
boolean
|
|
Disable Type-7 LSA p-bit setting
|
|
|
|
|
|
set
boolean
|
|
True if only nssa is set
|
|
|
|
|
|
translate
boolean
|
|
Enable LSA translation.
|
|
|
|
|
ranges
list
/ elements=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.
|
|
|
|
|
|
set
boolean
|
|
True if only stub is set
|
|
|
|
|
|
summary_lsa
boolean
|
|
If False , Filter all type-3 LSAs in the stub area.
|
|
|
|
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
integer
|
|
Specifies the administrative distance for routes.
|
|
|
|
fips_restrictions
boolean
|
|
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 OSPFv3 neighbors.
|
|
|
|
|
detail
boolean
|
|
If true , configures the switch to log all link-state changes.
|
|
|
|
|
set
boolean
|
|
When true sets the log_adjacency_changes config alone.
|
|
|
|
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_for_bgp
boolean
|
|
Let BGP decide when to originate router-LSA with normal metric
|
|
|
|
|
|
|
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.
|
|
|
|
passive_interface
boolean
|
|
Include interface but without actively running OSPF.
|
|
|
|
redistribute
list
/ elements=dictionary
|
|
Specifies the routes to be redistributed.
|
|
|
|
|
route_map
string
|
|
Specify which route map to use.
|
|
|
|
|
routes
string
|
Choices:
- bgp
- connected
- static
|
Route types (BGP,static,connected)
|
|
|
|
router_id
string
|
|
32-bit number assigned to a router running OSPFv3.
|
|
|
|
shutdown
boolean
|
|
Disable the OSPF instance.
|
|
|
|
timers
dictionary
|
|
Configure OSPF timers.
|
|
|
|
|
lsa
raw
|
|
Configure OSPFv3 LSA timers.
|
|
|
|
|
|
direction
string
|
|
Configure OSPFv3 LSA receiving/transmission 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
|
|
|
|
|
out_delay
integer
|
|
Configure out-delay timer.
|
|
|
|
|
pacing
integer
|
|
Configure OSPF packet pacing.
|
|
|
|
|
spf
dictionary
|
|
Configure OSPFv3 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
|
|
|
|
|
throttle
dictionary
|
|
This command is deprecated by 'timers lsa' or 'timers spf'.
|
|
|
|
|
|
initial
integer
|
|
Initial SPF schedule delay in msecs.
|
|
|
|
|
|
lsa
boolean
|
|
Configure threshold for retransmission of lsa
|
|
|
|
|
|
max
integer
|
|
Max wait time between two SPFs in msecs.
|
|
|
|
|
|
min
integer
|
|
Min Hold time between two SPFs in msecs
|
|
|
|
|
|
spf
boolean
|
|
Configure time between SPF calculations
|
|
|
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.
|
|
|
|
authentication
dictionary
|
|
Configure authentication for the area incase of ospfv3.
|
|
|
|
|
algorithm
string
|
|
Name of algorithm to be used.
|
|
|
|
|
encrypt_key
boolean
|
|
If False, key string is not encrypted
|
|
|
|
|
hidden_key
boolean
|
|
If True, Specifies that a HIDDEN key will follow.
|
|
|
|
|
key
string
|
|
128 bit MD5 key or 140 bit SHA1 key.
|
|
|
|
|
passphrase
string
|
|
Passphrase String for deriving keys for authentication and encryption.
|
|
|
|
|
spi
integer
|
|
Specify the SPI value
|
|
|
|
default_cost
integer
|
|
Specify the cost for default summary route in stub/NSSA area.
|
|
|
|
encryption
dictionary
|
|
Configure encryption for the area
|
|
|
|
|
algorithm
string
|
|
name of the algorithm to be used.
|
|
|
|
|
encrypt_key
boolean
|
|
If False, key string is not encrypted
|
|
|
|
|
encryption
string
|
Choices:
- 3des-cbc
- aes-128-cbc
- aes-192-cbc
- aes-256-cbc
- null
|
name of encryption to be used.
|
|
|
|
|
hidden_key
boolean
|
|
If True, Specifies that a HIDDEN key will follow.
|
|
|
|
|
key
string
|
|
128 bit MD5 key or 140 bit SHA1 key.
|
|
|
|
|
passphrase
string
|
|
Passphrase String for deriving keys for authentication and encryption.
|
|
|
|
|
spi
integer
|
|
Specify the SPI value
|
|
|
|
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.
|
|
|
|
|
|
set
boolean
|
|
True if only default information orignate is set
|
|
|
|
|
no_summary
boolean
|
|
Filter all type-3 LSAs in the nssa area.
|
|
|
|
|
nssa_only
boolean
|
|
Disable Type-7 LSA p-bit setting
|
|
|
|
|
set
boolean
|
|
True if only nssa is set
|
|
|
|
|
translate
boolean
|
|
Enable LSA translation.
|
|
|
|
stub
dictionary
|
|
Stub area.
|
|
|
|
|
set
boolean
|
|
True if only stub is set.
|
|
|
|
|
summary_lsa
boolean
|
|
If False , Filter all type-3 LSAs in the stub area.
|
|
|
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.
|
|
|
fips_restrictions
boolean
|
|
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 OSPFv3 neighbors.
|
|
|
|
detail
boolean
|
|
If true , configures the switch to log all link-state changes.
|
|
|
|
set
boolean
|
|
When true sets the log_adjacency_changes config alone.
|
|
|
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_for_bgp
boolean
|
|
Let BGP decide when to originate router-LSA with normal metric
|
|
|
|
|
|
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.
|
|
|
passive_interface
boolean
|
|
Include interface but without actively running OSPF.
|
|
|
router_id
string
|
|
32-bit number assigned to a router running OSPFv3.
|
|
|
shutdown
boolean
|
|
Disable the OSPF instance.
|
|
|
timers
dictionary
|
|
Configure OSPF timers.
|
|
|
|
lsa
raw
|
|
Configure OSPFv3 LSA timers.
|
|
|
|
|
direction
string
|
|
Configure OSPFv3 LSA receiving/transmission 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
|
|
|
|
out_delay
integer
|
|
Configure out-delay timer.
|
|
|
|
pacing
integer
|
|
Configure OSPF packet pacing.
|
|
|
|
spf
dictionary
|
|
Configure OSPFv3 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
|
|
|
|
throttle
dictionary
|
|
This command is deprecated by 'timers lsa' or 'timers spf'.
|
|
|
|
|
initial
integer
|
|
Initial SPF schedule delay in msecs.
|
|
|
|
|
lsa
boolean
|
|
Configure threshold for retransmission of lsa
|
|
|
|
|
max
integer
|
|
Max wait time between two SPFs in msecs.
|
|
|
|
|
min
integer
|
|
Min Hold time between two SPFs in msecs
|
|
|
|
|
spf
boolean
|
|
Configure time between SPF calculations
|
|
|
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 ospfv3.
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.
|