net_ping - Tests reachability using ping from a network device
New in version 2.4.
Synopsis
- Tests reachability using ping from network device to a remote destination.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| count |
no | 5 |
Number of packets to send.
|
|
| dest |
yes |
The IP Address or hostname (resolvable by switch) of the remote node.
|
||
| source |
no |
The source IP Address.
|
||
| state |
no | present |
|
Determines if the expected result is success or fail.
|
| vrf |
no | default |
The VRF to use for forwarding.
|
Examples
- provider:
host: "{{ ansible_host }}"
username: "{{ username }}"
password: "{{ password }}"
network_os: "{{ network_os }}"
- name: Test reachability to 10.10.10.10 using default vrf
net_ping:
provider: "{{ provider }}"
dest: 10.10.10.10
- name: Test reachability to 10.20.20.20 using prod vrf
net_ping:
provider: "{{ provider }}"
dest: 10.20.20.20
vrf: prod
- name: Test unreachability to 10.30.30.30 using default vrf
net_ping:
provider: "{{ provider }}"
dest: 10.30.30.30
state: absent
- name: Test reachability to 10.40.40.40 using prod vrf and setting count and source
net_ping:
provider: "{{ provider }}"
dest: 10.40.40.40
source: loopback0
vrf: prod
count: 20
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| commands |
Show the command sent.
|
always | list | ['ping vrf prod 10.40.40.40 count 20 source loopback0'] |
| packet_loss |
Percentage of packets lost.
|
always | str | 0% |
| packets_rx |
Packets successfully received.
|
always | int | 20 |
| packets_tx |
Packets successfully transmitted.
|
always | int | 20 |
| rtt |
Show RTT stats.
|
always | dict | {'max': 8, 'avg': 2, 'min': 1} |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/net_ping_module.html