cisco.iosxr.iosxr_ping module – Tests reachability using ping from IOSXR switch.
Note
This module is part of the cisco.iosxr collection (version 3.3.1).
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 cisco.iosxr
.
To use it in a playbook, specify: cisco.iosxr.iosxr_ping
.
Synopsis
Parameters
Parameter |
Comments |
---|---|
Define echo type ipv4 or ipv6. Choices:
|
|
Repeat count the number of packets to send. |
|
The IP Address or hostname (resolvable by switch) of the remote node. |
|
Set the DF bit in IP-header. Choices:
|
|
Datagram size the size of packets to send. |
|
Source address or source interface. |
|
Determines if the expected result is success or fail. Choices:
|
|
Sweep ping. Choices:
|
|
Validate return packet. Choices:
|
|
The VRF to use for forwarding. |
Notes
Examples
- name: Test reachability to 198.51.100.251 using default vrf
cisco.iosxr.iosxr_ping:
dest: 198.51.100.251
- name: Test reachability to 198.51.100.252 using prod vrf
cisco.iosxr.iosxr_ping:
dest: 198.51.100.252
vrf: prod
afi: ipv4
- name: Test unreachability to 198.51.100.253 using default vrf
cisco.iosxr.iosxr_ping:
dest: 198.51.100.253
state: absent
- name: Test reachability to 198.51.100.250 using prod vrf and setting count and source
cisco.iosxr.iosxr_ping:
dest: 198.51.100.250
source: loopback0
vrf: prod
count: 20
- name: Test reachability to 198.51.100.249 using df-bit and size
cisco.iosxr.iosxr_ping:
dest: 198.51.100.249
df_bit: true
size: 1400
- name: Test reachability to ipv6 address
cisco.iosxr.iosxr_ping:
dest: 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff
afi: ipv6
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Show the command sent. Returned: always Sample: |
|
Percentage of packets lost. Returned: always Sample: |
|
Packets successfully received. Returned: always Sample: |
|
Packets successfully transmitted. Returned: always Sample: |
|
Show RTT stats. Returned: always Sample: |