cisco.ios.ios_ping – Tests reachability using ping from Cisco IOS network devices¶
Note
This plugin is part of the cisco.ios collection (version 1.3.0).
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 | Choices/Defaults | Comments | |
---|---|---|---|
count
integer
|
Number of packets to send.
|
||
dest
string
/ required
|
The IP Address or hostname (resolvable by switch) of the remote node.
|
||
df_bit
boolean
|
|
Set the DF bit.
|
|
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli .For more information please see the IOS Platform Options guide.
A dict object containing connection details.
|
||
auth_pass
string
|
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
ANSIBLE_NET_AUTH_PASS will be used instead. |
||
authorize
boolean
|
|
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
ANSIBLE_NET_AUTHORIZE will be used instead. |
|
host
string
|
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_PASSWORD will be used instead. |
||
port
integer
|
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_KEYFILE will be used instead. |
||
timeout
integer
|
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_USERNAME will be used instead. |
||
size
integer
|
Size of packets to send.
|
||
source
string
|
The source IP Address.
|
||
state
string
|
|
Determines if the expected result is success or fail.
|
|
vrf
string
|
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:
Authors¶
Jacob McGill (@jmcgill298)