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_route_module.rst | 404 ++++++++++++++-------------- 1 file changed, 201 insertions(+), 203 deletions(-) (limited to 'docs/vyos.vyos.vyos_static_route_module.rst') diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst index 848d5a0..74f296d 100644 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ b/docs/vyos.vyos.vyos_static_route_module.rst @@ -38,304 +38,306 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
admin_distance
integer -
- - - - -
Admin distance of the static route.
- + + + + + +
Admin distance of the static route.
+ - - + +
aggregate
list - / elements=dictionary
- - - - -
List of static route definitions
- + / elements=dictionary + + + + + +
List of static route definitions
+ - - - + + +
admin_distance
integer -
- - - - -
Admin distance of the static route.
- + + + + + +
Admin distance of the static route.
+ - - - + + +
mask
string -
- - - - -
Network prefix mask of the static route.
- + + + + + +
Network prefix mask of the static route.
+ - - - + + +
next_hop
string -
- - - - -
Next hop IP of the static route.
- + + + + + +
Next hop IP of the static route.
+ - - - + + +
prefix
string - / required
- - - - -
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
- + / required + + + + + +
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
+ - - - + + +
state
string -
- - - - - -
State of the static route configuration.
- + + + + + + +
State of the static route configuration.
+ - - - + + +
mask
string -
- - - - -
Network prefix mask of the static route.
- + + + + + +
Network prefix mask of the static route.
+ - - + +
next_hop
string -
- - - - -
Next hop IP of the static route.
- + + + + + +
Next hop IP of the static route.
+ - - + +
prefix
string -
- - - - -
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
- + + + + + +
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
+ - - + +
provider
dictionary -
- - - - -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
-
For more information please see the Network Guide.
-
-
A dict object containing connection details.
- + + + + + +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+ - - - + + +
host
string -
- - - - -
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
- + + + + + +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+ - - - + + +
password
string -
- - - - -
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
- + + + + + +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+ - - - + + +
port
integer -
- - - - -
Specifies the port to use when building the connection to the remote device.
- + + + + + +
Specifies the port to use when building the connection to the remote device.
+ - - - + + +
ssh_keyfile
path -
- - - - -
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
- + + + + + +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+ - - - + + +
timeout
integer -
- - - - -
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
- + + + + + +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+ - - - + + +
username
string -
- - - - -
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
- + + + + + +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+ - - - + + +
state
string -
- - - - - -
State of the static route configuration.
- + + + + + + +
State of the static route configuration.
+ - +
@@ -354,7 +356,6 @@ Examples .. code-block:: yaml+jinja - - name: configure static route vyos.vyos.vyos_static_route: prefix: 192.168.2.0 @@ -389,7 +390,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -402,24 +402,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set protocols static route 192.168.2.0/16 next-hop 10.0.0.1']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set protocols static route 192.168.2.0/16 next-hop 10.0.0.1']
+ - +

@@ -435,5 +435,3 @@ Authors ~~~~~~~ - Trishna Guha (@trishnaguha) - - -- cgit v1.2.3