vyos.vyos.vyos_ping module – Tests reachability using ping from VyOS network devices
Note
This module is part of the vyos.vyos collection (version 5.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install vyos.vyos
.
To use it in a playbook, specify: vyos.vyos.vyos_ping
.
New in vyos.vyos 1.0.0
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 ansible.netcommon.net_ping module.
For Windows targets, use the ansible.windows.win_ping module instead.
For targets running Python, use the ansible.builtin.ping module instead.
Aliases: ping
Parameters
Parameter |
Comments |
---|---|
Number of packets to send to check reachability. Default: |
|
The IP Address or hostname (resolvable by the device) of the remote node. |
|
Determines the interval (in seconds) between consecutive pings. |
|
Determines the size (in bytes) of the ping packet(s). |
|
The source interface or IP Address to use while sending the ping packet(s). |
|
Determines if the expected result is success or fail. Choices:
|
|
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 ansible.netcommon.net_ping module.
For Windows targets, use the ansible.windows.win_ping module instead.
For targets running Python, use the ansible.builtin.ping 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 |
Description |
---|---|
List of commands sent. Returned: always Sample: |
|
Percentage of packets lost. Returned: always Sample: |
|
Packets successfully received. Returned: always Sample: |
|
Packets successfully transmitted. Returned: always Sample: |
|
The round trip time (RTT) stats. Returned: when ping succeeds Sample: |