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_ospfv3_module.rst | 469 +++++++++++++++++----------------- 1 file changed, 233 insertions(+), 236 deletions(-) (limited to 'docs/vyos.vyos.vyos_ospfv3_module.rst') diff --git a/docs/vyos.vyos.vyos_ospfv3_module.rst b/docs/vyos.vyos.vyos_ospfv3_module.rst index 1bfbde0..d1ee1b1 100644 --- a/docs/vyos.vyos.vyos_ospfv3_module.rst +++ b/docs/vyos.vyos.vyos_ospfv3_module.rst @@ -31,305 +31,308 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
dictionary -
- - - - -
A provided OSPFv3 route configuration.
- + + + + + +
A provided OSPFv3 route configuration.
+ - - - + + +
areas
list - / elements=dictionary
- - - - -
OSPFv3 area.
- + / elements=dictionary + + + + + +
OSPFv3 area.
+ - - - - + + + +
area_id
string -
- - - - -
OSPFv3 Area name/identity.
- + + + + + +
OSPFv3 Area name/identity.
+ - - - - + + + +
export_list
string -
- - - - -
Name of export-list.
- + + + + + +
Name of export-list.
+ - - - - + + + +
import_list
string -
- - - - -
Name of import-list.
- + + + + + +
Name of import-list.
+ - - - - + + + +
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.
+ - - - - - + + + + +
advertise
boolean -
- - - - - -
Advertise this range.
- + + + + + + +
Advertise this range.
+ - - - - - + + + + +
not_advertise
boolean -
- - - - - -
Don't advertise this range.
- + + + + + + +
Don't advertise this range.
+ - - - - - + + + + +
parameters
dictionary -
- - - - -
OSPFv3 specific parameters.
- + + + + + +
OSPFv3 specific parameters.
+ - - - - + + + +
router_id
string -
- - - - -
Override the default router identifier.
- + + + + + +
Override the default router identifier.
+ - - - - + + + +
redistribute
list - / elements=dictionary
- - - - -
Redistribute information from another routing protocol.
- + / elements=dictionary + + + + + +
Redistribute information from another routing protocol.
+ - - - - + + + +
route_map
string -
- - - - -
Route map references.
- + + + + + +
Route map references.
+ - - - - + + + +
route_type
string -
- - - - - -
Route type to redistribute.
- + + + + + + +
Route type to redistribute.
+ - - - - + + + +
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 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.
- + + + + + +
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 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 -
- - - - - -
The state the configuration should be left in.
- + + + + + + +
The state the configuration should be left in.
+ - +
@@ -347,7 +350,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -835,9 +837,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -850,60 +849,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 ospfv3 area 2 range '2001:db10::/32'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospfv3 area 2 range '2001:db10::/32'"]
+ - +

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