From a45e2988263f5109a56b6dcb2c46ecbc6738cb3a Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Thu, 27 Aug 2020 14:58:25 -0400 Subject: Release 1.0.4 (#81) Release 1.0.4 Reviewed-by: https://github.com/apps/ansible-zuul --- docs/vyos.vyos.vyos_ospfv2_module.rst | 2320 +++++++++++++++++---------------- 1 file changed, 1163 insertions(+), 1157 deletions(-) (limited to 'docs/vyos.vyos.vyos_ospfv2_module.rst') diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 1d23305..50ed5d3 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -31,1598 +31,1609 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
dictionary -
- - - - -
A provided OSPFv2 route configuration.
- - - - - + + + + + +
A provided OSPFv2 route configuration.
+ + + + +
areas
list - / elements=dictionary
- - - - -
OSPFv2 area.
- - - - - - + / elements=dictionary + + + + + +
OSPFv2 area.
+ + + + + +
area_id
string -
- - - - -
OSPFv2 area identity.
- + + + + + +
OSPFv2 area identity.
+ - - - - + + + +
area_type
dictionary -
- - - - -
Area type.
- - - - - - - + + + + + +
Area type.
+ + + + + + +
normal
boolean -
- - - - - -
Normal OSPFv2 area.
- + + + + + + +
Normal OSPFv2 area.
+ - - - - - + + + + +
nssa
dictionary -
- - - - -
NSSA OSPFv2 area.
- - - - - - - - + + + + + +
NSSA OSPFv2 area.
+ + + + + + + +
default_cost
integer -
- - - - -
Summary-default cost of NSSA area.
- + + + + + +
Summary-default cost of NSSA area.
+ - - - - - - + + + + + +
no_summary
boolean -
- - - - - -
Do not inject inter-area routes into stub.
- + + + + + + +
Do not inject inter-area routes into stub.
+ - - - - - - + + + + + +
set
boolean -
- - - - - -
Enabling NSSA.
- + + + + + + +
Enabling NSSA.
+ - - - - - - + + + + + +
translate
string -
- - - - - -
NSSA-ABR.
- - - - - - - - + + + + + + +
NSSA-ABR.
+ + + + + + + +
stub
dictionary -
- - - - -
Stub OSPFv2 area.
- - - - - - - - + + + + + +
Stub OSPFv2 area.
+ + + + + + + +
default_cost
integer -
- - - - -
Summary-default cost of stub area.
- + + + + + +
Summary-default cost of stub area.
+ - - - - - - + + + + + +
no_summary
boolean -
- - - - - -
Do not inject inter-area routes into stub.
- + + + + + + +
Do not inject inter-area routes into stub.
+ - - - - - - + + + + + +
set
boolean -
- - - - - -
Enabling stub.
- - - - - - - - + + + + + + +
Enabling stub.
+ + + + + + + +
authentication
string -
- - - - - -
OSPFv2 area authentication type.
- + + + + + + +
OSPFv2 area authentication type.
+ - - - - + + + +
network
list - / elements=dictionary
- - - - -
OSPFv2 network.
- - - - - - - + / elements=dictionary + + + + + +
OSPFv2 network.
+ + + + + + +
address
string - / required
- - - - -
OSPFv2 IPv4 network address.
- - - - - - - + / required + + + + + +
OSPFv2 IPv4 network address.
+ + + + + + +
range
list - / elements=dictionary
- - - - -
Summarize routes matching prefix (border routers only).
- - - - - - - + / elements=dictionary + + + + + +
Summarize routes matching prefix (border routers only).
+ + + + + + +
address
string -
- - - - -
border router IPv4 address.
- + + + + + +
border router IPv4 address.
+ - - - - - + + + + +
cost
integer -
- - - - -
Metric for this range.
- + + + + + +
Metric for this range.
+ - - - - - + + + + +
not_advertise
boolean -
- - - - - -
Don't advertise this range.
- + + + + + + +
Don't advertise this range.
+ - - - - - + + + + +
substitute
string -
- - - - -
Announce area range (IPv4 address) as another prefix.
- - - - - - - + + + + + +
Announce area range (IPv4 address) as another prefix.
+ + + + + + +
shortcut
string -
- - - - - -
Area's shortcut mode.
- + + + + + + +
Area's shortcut mode.
+ - - - - + + + +
virtual_link
list - / elements=dictionary
- - - - -
Virtual link address.
- - - - - - - + / elements=dictionary + + + + + +
Virtual link address.
+ + + + + + +
address
string -
- - - - -
virtual link address.
- + + + + + +
virtual link address.
+ - - - - - + + + + +
authentication
dictionary -
- - - - -
OSPFv2 area authentication type.
- - - - - - - - + + + + + +
OSPFv2 area authentication type.
+ + + + + + + +
md5
list - / elements=dictionary
- - - - -
MD5 key id based authentication.
- - - - - - - - - + / elements=dictionary + + + + + +
MD5 key id based authentication.
+ + + + + + + + +
key_id
integer -
- - - - -
MD5 key id.
- + + + + + +
MD5 key id.
+ - - - - - - - + + + + + + +
md5_key
string -
- - - - -
MD5 key.
- - - - - - - - - + + + + + +
MD5 key.
+ + + + + + + + +
plaintext_password
string -
- - - - -
Plain text password.
- - - - - - - - + + + + + +
Plain text password.
+ + + + + + + +
dead_interval
integer -
- - - - -
Interval after which a neighbor is declared dead.
- + + + + + +
Interval after which a neighbor is declared dead.
+ - - - - - + + + + +
hello_interval
integer -
- - - - -
Interval between hello packets.
- + + + + + +
Interval between hello packets.
+ - - - - - + + + + +
retransmit_interval
integer -
- - - - -
Interval between retransmitting lost link state advertisements.
- + + + + + +
Interval between retransmitting lost link state advertisements.
+ - - - - - + + + + +
transmit_delay
integer -
- - - - -
Link state transmit delay.
- - - - - - - + + + + + +
Link state transmit delay.
+ + + + + + +
auto_cost
dictionary -
- - - - -
Calculate OSPFv2 interface cost according to bandwidth.
- - - - - - + + + + + +
Calculate OSPFv2 interface cost according to bandwidth.
+ + + + + +
reference_bandwidth
integer -
- - - - -
Reference bandwidth cost in Mbits/sec.
- - - - - - + + + + + +
Reference bandwidth cost in Mbits/sec.
+ + + + + +
default_information
dictionary -
- - - - -
Control distribution of default information.
- - - - - - + + + + + +
Control distribution of default information.
+ + + + + +
originate
dictionary -
- - - - -
Distribute a default route.
- - - - - - - + + + + + +
Distribute a default route.
+ + + + + + +
always
boolean -
- - - - - -
Always advertise default route.
- + + + + + + +
Always advertise default route.
+ - - - - - + + + + +
metric
integer -
- - - - -
OSPFv2 default metric.
- + + + + + +
OSPFv2 default metric.
+ - - - - - + + + + +
metric_type
integer -
- - - - -
OSPFv2 Metric types for default routes.
- + + + + + +
OSPFv2 Metric types for default routes.
+ - - - - - + + + + +
route_map
string -
- - - - -
Route map references.
- - - - - - - + + + + + +
Route map references.
+ + + + + + +
default_metric
integer -
- - - - -
Metric of redistributed routes
- + + + + + +
Metric of redistributed routes
+ - - - + + +
distance
dictionary -
- - - - -
Administrative distance.
- - - - - - + + + + + +
Administrative distance.
+ + + + + +
global
integer -
- - - - -
Global OSPFv2 administrative distance.
- + + + + + +
Global OSPFv2 administrative distance.
+ - - - - + + + +
ospf
dictionary -
- - - - -
OSPFv2 administrative distance.
- - - - - - - + + + + + +
OSPFv2 administrative distance.
+ + + + + + +
external
integer -
- - - - -
Distance for external routes.
- + + + + + +
Distance for external routes.
+ - - - - - + + + + +
inter_area
integer -
- - - - -
Distance for inter-area routes.
- + + + + + +
Distance for inter-area routes.
+ - - - - - + + + + +
intra_area
integer -
- - - - -
Distance for intra-area routes.
- - - - - - - + + + + + +
Distance for intra-area routes.
+ + + + + + +
log_adjacency_changes
string -
- - - - - -
Log changes in adjacency state.
- + + + + + + +
Log changes in adjacency state.
+ - - - + + +
max_metric
dictionary -
- - - - -
OSPFv2 maximum/infinite-distance metric.
- - - - - - + + + + + +
OSPFv2 maximum/infinite-distance metric.
+ + + + + +
router_lsa
dictionary -
- - - - -
Advertise own Router-LSA with infinite distance (stub router).
- - - - - - - + + + + + +
Advertise own Router-LSA with infinite distance (stub router).
+ + + + + + +
administrative
boolean -
- - - - - -
Administratively apply, for an indefinite period.
- + + + + + + +
Administratively apply, for an indefinite period.
+ - - - - - + + + + +
on_shutdown
integer -
- - - - -
Time to advertise self as stub-router.
- + + + + + +
Time to advertise self as stub-router.
+ - - - - - + + + + +
on_startup
integer -
- - - - -
Time to advertise self as stub-router
- - - - - - - + + + + + +
Time to advertise self as stub-router
+ + + + + + +
mpls_te
dictionary -
- - - - -
MultiProtocol Label Switching-Traffic Engineering (MPLS-TE) parameters.
- - - - - - + + + + + +
MultiProtocol Label Switching-Traffic Engineering (MPLS-TE) parameters.
+ + + + + +
enabled
boolean -
- - - - - -
Enable MPLS-TE functionality.
- + + + + + + +
Enable MPLS-TE functionality.
+ - - - - + + + +
router_address
string -
- - - - -
Stable IP address of the advertising router.
- - - - - - + + + + + +
Stable IP address of the advertising router.
+ + + + + +
neighbor
list - / elements=dictionary
- - - - -
Neighbor IP address.
- - - - - - + / elements=dictionary + + + + + +
Neighbor IP address.
+ + + + + +
neighbor_id
string -
- - - - -
Identity (number/IP address) of neighbor.
- + + + + + +
Identity (number/IP address) of neighbor.
+ - - - - + + + +
poll_interval
integer -
- - - - -
Seconds between dead neighbor polling interval.
- + + + + + +
Seconds between dead neighbor polling interval.
+ - - - - + + + +
priority
integer -
- - - - -
Neighbor priority.
- - - - - - + + + + + +
Neighbor priority.
+ + + + + +
parameters
dictionary -
- - - - -
OSPFv2 specific parameters.
- - - - - - + + + + + +
OSPFv2 specific parameters.
+ + + + + +
abr_type
string -
- - - - - -
OSPFv2 ABR Type.
- + + + + + + +
OSPFv2 ABR Type.
+ - - - - + + + +
opaque_lsa
boolean -
- - - - - -
Enable the Opaque-LSA capability (rfc2370).
- + + + + + + +
Enable the Opaque-LSA capability (rfc2370).
+ - - - - + + + +
rfc1583_compatibility
boolean -
- - - - - -
Enable rfc1583 criteria for handling AS external routes.
- + + + + + + +
Enable rfc1583 criteria for handling AS external routes.
+ - - - - + + + +
router_id
string -
- - - - -
Override the default router identifier.
- - - - - - + + + + + +
Override the default router identifier.
+ + + + + +
passive_interface
list - / elements=string
- - - - -
Suppress routing updates on an interface.
- + / elements=string + + + + + +
Suppress routing updates on an interface.
+ - - - + + +
passive_interface_exclude
list - / elements=string
- - - - -
Interface to exclude when using passive-interface default.
- + / elements=string + + + + + +
Interface to exclude when using passive-interface default.
+ - - - + + +
redistribute
list - / elements=dictionary
- - - - -
Redistribute information from another routing protocol.
- - - - - - + / elements=dictionary + + + + + +
Redistribute information from another routing protocol.
+ + + + + +
metric
integer -
- - - - -
Metric for redistribution routes.
- + + + + + +
Metric for redistribution routes.
+ - - - - + + + +
metric_type
integer -
- - - - -
OSPFv2 Metric types.
- + + + + + +
OSPFv2 Metric types.
+ - - - - + + + +
route_map
string -
- - - - -
Route map references.
- + + + + + +
Route map references.
+ - - - - + + + +
route_type
string -
- - - - - -
Route type to redistribute.
- - - - - - + + + + + + +
Route type to redistribute.
+ + + + + +
route_map
list - / elements=string
- - - - -
Filter routes installed in local route map.
- + / elements=string + + + + + +
Filter routes installed in local route map.
+ - - - + + +
timers
dictionary -
- - - - -
Adjust routing timers.
- - - - - - + + + + + +
Adjust routing timers.
+ + + + + +
refresh
dictionary -
- - - - -
Adjust refresh parameters.
- - - - - - - + + + + + +
Adjust refresh parameters.
+ + + + + + +
timers
integer -
- - - - -
refresh timer.
- - - - - - - + + + + + +
refresh timer.
+ + + + + + +
throttle
dictionary -
- - - - -
Throttling adaptive timers.
- - - - - - - + + + + + +
Throttling adaptive timers.
+ + + + + + +
spf
dictionary -
- - - - -
OSPFv2 SPF timers.
- - - - - - - - + + + + + +
OSPFv2 SPF timers.
+ + + + + + + +
delay
integer -
- - - - -
Delay (msec) from first change received till SPF calculation.
- + + + + + +
Delay (msec) from first change received till SPF calculation.
+ - - - - - - + + + + + +
initial_holdtime
integer -
- - - - -
Initial hold time(msec) between consecutive SPF calculations.
- + + + + + +
Initial hold time(msec) between consecutive SPF calculations.
+ - - - - - - + + + + + +
max_holdtime
integer -
- - - - -
maximum hold time (sec).
- - - - - - - - + + + + + +
maximum hold time (sec).
+ + + + + + + +
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 | grep 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.
- + + + + + +
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 | grep 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 -
- - - - - -
The state the configuration should be left in.
- - - + + + + + + +
The state the configuration should be left in.
+ + +
@@ -1640,7 +1651,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -3038,8 +3048,6 @@ Examples - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -3052,60 +3060,60 @@ Common return values are documented `here Returned Description - - + +
after
dictionary -
- + + when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
dictionary -
- +
+ always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospf passive-interface 'eth1'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospf passive-interface 'eth1'"]
+ - +

@@ -3117,5 +3125,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - -- cgit v1.2.3