cisco.nxos.nxos_ping module – Tests reachability using ping from Nexus switch.
Note
This module is part of the cisco.nxos collection (version 3.2.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.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_ping
.
New in cisco.nxos 1.0.0
Synopsis
Tests reachability using ping from switch to a remote destination.
For a general purpose network module, see the ansible.netcommon.net_ping module.
For Windows targets, use the ansible.windows.win_ping module instead.
For targets running Python, use the ansible.builtin.ping module instead.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Number of packets to send. Default: |
|
IP address or hostname (resolvable by switch) of remote node. |
|
Set the DF bit. Choices:
|
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.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 is a common argument used for either cli or nxapi transports. 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. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). |
|
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. 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. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). |
|
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable |
|
If Choices:
|
|
Size of packets to send. |
|
Source IP Address or hostname (resolvable by switch) |
|
Determines if the expected result is success or fail. Choices:
|
|
Outgoing VRF. |
Notes
Note
Unsupported for Cisco MDS
For a general purpose network module, see the ansible.netcommon.net_ping module.
For Windows targets, use the ansible.windows.win_ping module instead.
For targets running Python, use the ansible.builtin.ping module instead.
For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- name: Test reachability to 8.8.8.8 using mgmt vrf
cisco.nxos.nxos_ping:
dest: 8.8.8.8
vrf: management
host: 68.170.147.165
- name: Test reachability to a few different public IPs using mgmt vrf
cisco.nxos.nxos_ping:
dest: "{{ item }}"
vrf: management
host: 68.170.147.165
with_items:
- 8.8.8.8
- 4.4.4.4
- 198.6.1.4
- name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit
cisco.nxos.nxos_ping:
dest: 8.8.8.8
df_bit: true
size: 1400
vrf: management
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: |