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_ping_module.rst | 385 ++++++++++++++++++------------------ 1 file changed, 191 insertions(+), 194 deletions(-) (limited to 'docs/vyos.vyos.vyos_ping_module.rst') diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index 69bc418..e3377fc 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -35,235 +35,236 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
count
integer -
- - - Default:
5
- - -
Number of packets to send to check reachability.
- + + + + Default:
5
+ + +
Number of packets to send to check reachability.
+ - - + +
dest
string - / required
- - - - -
The IP Address or hostname (resolvable by the device) of the remote node.
- + / required + + + + + +
The IP Address or hostname (resolvable by the device) of the remote node.
+ - - + +
interval
integer -
- - - - -
Determines the interval (in seconds) between consecutive pings.
- + + + + + +
Determines the interval (in seconds) between consecutive pings.
+ - - + +
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.
+ - - - + + +
size
integer -
- - - - -
Determines the size (in bytes) of the ping packet(s).
- + + + + + +
Determines the size (in bytes) of the ping packet(s).
+ - - + +
source
string -
- - - - -
The source interface or IP Address to use while sending the ping packet(s).
- + + + + + +
The source interface or IP Address to use while sending the ping packet(s).
+ - - + +
state
string -
- - - - - -
Determines if the expected result is success or fail.
- + + + + + + +
Determines if the expected result is success or fail.
+ - - + +
ttl
integer -
- - - - -
The time-to-live value for the ICMP packet(s).
- + + + + + +
The time-to-live value for the ICMP packet(s).
+ - +
@@ -285,7 +286,6 @@ Examples .. code-block:: yaml+jinja - - name: Test reachability to 10.10.10.10 vyos.vyos.vyos_ping: dest: 10.10.10.10 @@ -311,7 +311,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -324,92 +323,92 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always -
List of commands sent.
-
-
Sample:
-
['ping 10.8.38.44 count 10 interface eth0 ttl 128']
- +
List of commands sent.
+
+
Sample:
+
['ping 10.8.38.44 count 10 interface eth0 ttl 128']
+ - - + +
packet_loss
string -
- + + always -
Percentage of packets lost.
-
-
Sample:
-
0%
- +
Percentage of packets lost.
+
+
Sample:
+
0%
+ - - + +
packets_rx
integer -
- + + always -
Packets successfully received.
-
-
Sample:
-
20
- +
Packets successfully received.
+
+
Sample:
+
20
+ - - + +
packets_tx
integer -
- + + always -
Packets successfully transmitted.
-
-
Sample:
-
20
- +
Packets successfully transmitted.
+
+
Sample:
+
20
+ - - + +
rtt
dictionary -
- + + when ping succeeds -
The round trip time (RTT) stats.
-
-
Sample:
-
{'avg': 2, 'max': 8, 'min': 1, 'mdev': 24}
- +
The round trip time (RTT) stats.
+
+
Sample:
+
AnsibleMapping([('avg', 2), ('max', 8), ('min', 1), ('mdev', 24)])
+ - +

@@ -421,5 +420,3 @@ Authors ~~~~~~~ - Nilashish Chakraborty (@NilashishC) - - -- cgit v1.2.3