vyos.vyos.vyos_ping_module.rst

vyos.vyos.vyos_ping

Tests reachability using ping from VyOS network devices

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

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:`ansible.netcommon.net_ping <ansible.netcommon.net_ping_module>` module.
• For Windows targets, use the :ref:`ansible.windows.win_ping <ansible.windows.win_ping_module>` module instead.
• For targets running Python, use the :ref:`ansible.builtin.ping <ansible.builtin.ping_module>` module instead.

Parameters

Parameter	Choices/Defaults	Comments
count integer	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.
interval integer		Determines the interval (in seconds) between consecutive pings.
size integer		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).
state string	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:`ansible.netcommon.net_ping <ansible.netcommon.net_ping_module>` module.
• For Windows targets, use the :ref:`ansible.windows.win_ping <ansible.windows.win_ping_module>` module instead.
• For targets running Python, use the :ref:`ansible.builtin.ping <ansible.builtin.ping_module>` module instead.
• This module works with connection ansible.netcommon.network_cli. See the VyOS OS Platform Options.
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

Examples

- 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 reachability 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:

Key	Returned	Description
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)