From 84afad5130564a8ad48e756cca1566c17eaafc36 Mon Sep 17 00:00:00 2001 From: Rohit Date: Thu, 18 Jun 2020 01:48:45 +0530 Subject: [VyOS]: update readme and add .rst files (#44) [VyOS]: update readme and add .rst files Reviewed-by: https://github.com/apps/ansible-zuul --- docs/vyos.vyos.vyos_ping_module.rst | 431 ++++++++++++++++++++++++++++++++++++ 1 file changed, 431 insertions(+) create mode 100644 docs/vyos.vyos.vyos_ping_module.rst (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 new file mode 100644 index 0000000..a75eb90 --- /dev/null +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -0,0 +1,431 @@ +:orphan: + +.. _vyos.vyos.vyos_ping_module: + + +******************* +vyos.vyos.vyos_ping +******************* + +**Tests reachability using ping from VyOS network devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Tests reachability using ping from a VyOS device to a remote destination. +- Tested against VyOS 1.1.8 (helium) +- For a general purpose network module, see the :ref:`net_ping ` module. +- For Windows targets, use the :ref:`win_ping ` module instead. +- For targets running Python, use the :ref:`ping ` module instead. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ count + +
+ integer +
+ 		+ Default:
5
+ 		+
Number of packets to send to check reachability.
+
+
+ dest + +
+ - + / required
+ 		+ +
The IP Address or hostname (resolvable by the device) of the remote node.
+
+
+ interval + +
+ integer +
+ 		+ +
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.
+
+
+ host + +
+ string + / required
+ 		+ +
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.
+
+
+ port + +
+ integer +
+ 		+ Default:
22
+ 		+
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.
+
+
+ timeout + +
+ integer +
+ 		+ Default:
10
+ 		+
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.
+
+
+ size + +
+ integer +
+ 		+ +
Determines the size (in bytes) of the ping packet(s).
+
+
+ source + +
+ - +
+ 		+ +
The source interface or IP Address to use while sending the ping packet(s).
+
+
+ state + +
+ - +
+ 		+
    Choices: +
  • absent
    • +
  • present ←
    • +
+ 		+
Determines if the expected result is success or fail.
+
+
+ ttl + +
+ integer +
+ 		+ +
The time-to-live value for the ICMP packet(s).
+
+
+ + +Notes +----- + +.. note:: + - Tested against VyOS 1.1.8 (helium). + - For a general purpose network module, see the :ref:`net_ping ` module. + - For Windows targets, use the :ref:`win_ping ` module instead. + - For targets running Python, use the :ref:`ping ` module instead. + - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Test reachability to 10.10.10.10 + vyos.vyos.vyos_ping: + dest: 10.10.10.10 + + - name: Test reachability to 10.20.20.20 using source and ttl set + vyos.vyos.vyos_ping: + dest: 10.20.20.20 + source: eth0 + ttl: 128 + + - name: Test unreachability to 10.30.30.30 using interval + vyos.vyos.vyos_ping: + dest: 10.30.30.30 + interval: 3 + state: absent + + - name: Test reachability to 10.40.40.40 setting count and source + vyos.vyos.vyos_ping: + dest: 10.40.40.40 + source: eth1 + count: 20 + size: 512 + + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
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%
+
+
+ packets_rx + +
+ integer +
+ 		always +
Packets successfully received.
+
+
Sample:
+
20
+
+
+ packets_tx + +
+ integer +
+ 		always +
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}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) + + +.. hint:: + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. -- cgit v1.2.3