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_static_routes_module.rst | 467 ++++++++++++++------------- 1 file changed, 234 insertions(+), 233 deletions(-) (limited to 'docs/vyos.vyos.vyos_static_routes_module.rst') diff --git a/docs/vyos.vyos.vyos_static_routes_module.rst b/docs/vyos.vyos.vyos_static_routes_module.rst index 1808538..53942a5 100644 --- a/docs/vyos.vyos.vyos_static_routes_module.rst +++ b/docs/vyos.vyos.vyos_static_routes_module.rst @@ -31,296 +31,303 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
A provided static route configuration.
- + / elements=dictionary + + + + + +
A provided static route configuration.
+ - - - + + +
address_families
list - / elements=dictionary
- - - - -
A dictionary specifying the address family to which the static route(s) belong.
- + / elements=dictionary + + + + + +
A dictionary specifying the address family to which the static route(s) belong.
+ - - - - + + + +
afi
string - / required
- - - - - -
Specifies the type of route.
- + / required + + + + + + +
Specifies the type of route.
+ - - - - + + + +
routes
list - / elements=dictionary
- - - - -
A ditionary that specify the static route configurations.
- + / elements=dictionary + + + + + +
A ditionary that specify the static route configurations.
+ - - - - - + + + + +
blackhole_config
dictionary -
- - - - -
Configured to silently discard packets.
- + + + + + +
Configured to silently discard packets.
+ - - - - - - + + + + + +
distance
integer -
- - - - -
Distance for the route.
- + + + + + +
Distance for the route.
+ - - - - - - + + + + + +
type
string -
- - - - -
This is to configure only blackhole.
- + + + + + +
This is to configure only blackhole.
+ - - - - - - + + + + + +
dest
string - / required
- - - - -
An IPv4/v6 address in CIDR notation that specifies the destination network for the static route.
- + / required + + + + + +
An IPv4/v6 address in CIDR notation that specifies the destination network for the static route.
+ - - - - - + + + + +
next_hops
list - / elements=dictionary
- - - - -
Next hops to the specified destination.
- + / elements=dictionary + + + + + +
Next hops to the specified destination.
+ - - - - - - + + + + + +
admin_distance
integer -
- - - - -
Distance value for the route.
- + + + + + +
Distance value for the route.
+ - - - - - - + + + + + +
enabled
boolean -
- - - - - -
Disable IPv4/v6 next-hop static route.
- + + + + + + +
Disable IPv4/v6 next-hop static route.
+ - - - - - - + + + + + +
forward_router_address
string - / required
- - - - -
The IP address of the next hop that can be used to reach the destination network.
- + / required + + + + + +
The IP address of the next hop that can be used to reach the destination network.
+ - - - - - - + + + + + +
interface
string -
- - - - -
Name of the outgoing interface.
- + + + + + +
Name of the outgoing 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 | grep static route.
-
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 static route.
+
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 of the configuration after module completion.
- + + + + + + +
The state of the configuration after module completion.
+ - +
@@ -338,7 +345,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -1080,9 +1086,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -1095,60 +1098,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + 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
list -
- +
+ 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 static route 192.0.2.32/28 next-hop '192.0.2.6'", "set protocols static route 192.0.2.32/28 'blackhole'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
["set protocols static route 192.0.2.32/28 next-hop '192.0.2.6'", "set protocols static route 192.0.2.32/28 'blackhole'"]
+ - +

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