cisco.ios.ios_ping – Tests reachability using ping from Cisco IOS network devices
Note
This plugin is part of the cisco.ios collection (version 2.6.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 cisco.ios
.
To use it in a playbook, specify: cisco.ios.ios_ping
.
New in version 1.0.0: of cisco.ios
Synopsis
Tests reachability using ping from switch to a remote destination.
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.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Number of packets to send. |
|
The IP Address or hostname (resolvable by switch) of the remote node. |
|
Set the DF bit. Choices:
|
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html. A dict object containing connection details. |
|
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable Choices:
|
|
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. |
|
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 |
|
Specifies the port to use when building the connection to the remote device. |
|
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 |
|
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. |
|
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 |
|
Size of packets to send. |
|
The source IP Address. |
|
Determines if the expected result is success or fail. Choices:
|
|
The VRF to use for forwarding. |
Notes
Note
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.
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Examples
- name: Test reachability to 10.10.10.10 using default vrf
cisco.ios.ios_ping:
dest: 10.10.10.10
- name: Test reachability to 10.20.20.20 using prod vrf
cisco.ios.ios_ping:
dest: 10.20.20.20
vrf: prod
- name: Test unreachability to 10.30.30.30 using default vrf
cisco.ios.ios_ping:
dest: 10.30.30.30
state: absent
- name: Test reachability to 10.40.40.40 using prod vrf and setting count and source
cisco.ios.ios_ping:
dest: 10.40.40.40
source: loopback0
vrf: prod
count: 20
- name: Test reachability to 10.50.50.50 using df-bit and size
cisco.ios.ios_ping:
dest: 10.50.50.50
df_bit: true
size: 1400
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: [“ping vrf prod 10.40.40.40 count 20 source loopback0”] |
|
Percentage of packets lost. Returned: always Sample: “0%” |
|
Packets successfully received. Returned: always Sample: 20 |
|
Packets successfully transmitted. Returned: always Sample: 20 |
|
Show RTT stats. Returned: always Sample: {“avg”: 2, “max”: 8, “min”: 1} |
Authors
Jacob McGill (@jmcgill298)