vyos_ping – Tests reachability using ping from VyOS network devices¶
New in version 2.8.
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| 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_PASSWORDwill 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_KEYFILEwill 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_USERNAMEwill 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 
                    -
                                                                 | 
 | 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 net_ping module.
- For Windows targets, use the win_ping module instead.
- For targets running Python, use the ping module instead.
- This module works with connection network_cli. See the VyOS OS Platform Options.
- For more information on using Ansible to manage network devices see the Ansible Network Guide
Examples¶
- name: Test reachability to 10.10.10.10
  vyos_ping:
    dest: 10.10.10.10
- name: Test reachability to 10.20.20.20 using source and ttl set
  vyos_ping:
    dest: 10.20.20.20
    source: eth0
    ttl: 128
- name: Test unreachability to 10.30.30.30 using interval
  vyos_ping:
    dest: 10.30.30.30
    interval: 3
    state: absent
- name: Test reachability to 10.40.40.40 setting count and source
  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:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Nilashish Chakraborty (@NilashishC)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
