cisco.nxos.nxos_ping – Tests reachability using ping from Nexus switch.
cisco.nxos.nxos_ping – Tests reachability using ping from Nexus switch.
Note
This plugin is part of the cisco.nxos collection (version 1.4.0).
To install it use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_ping
.
New in version 1.0.0: of cisco.nxos
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.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
count integer |
Default: 5 |
Number of packets to send. | |
dest string / required |
IP address or hostname (resolvable by switch) of remote node. | ||
provider dictionary |
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 NXOS 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 | ||
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 | |
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 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 | ||
port integer |
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). | ||
ssh_keyfile string |
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 | ||
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. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). | ||
transport string |
|
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. | |
use_proxy boolean |
|
If | |
use_ssl boolean |
|
Configures the transport to use SSL if set to | |
username string |
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 | ||
validate_certs boolean |
|
If | |
source string |
Source IP Address or hostname (resolvable by switch) | ||
state string |
|
Determines if the expected result is success or fail. | |
vrf string |
Outgoing VRF. |
Notes
Note
- 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 NXOS Platform Options guide
- 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 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: nxos_ping
vrf: management
host: 68.170.147.165
with_items:
- 8.8.8.8
- 4.4.4.4
- 198.6.1.4
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands list / elements=string |
always |
Show the command sent
Sample: ['ping 8.8.8.8 count 2 vrf management'] |
packet_loss string |
always |
Percentage of packets lost
Sample: 0.00% |
packets_rx integer |
always |
Packets successfully received
Sample: 2 |
packets_tx integer |
always |
Packets successfully transmitted
Sample: 2 |
rtt dictionary |
always |
Show RTT stats
Sample: {'avg': 6.264, 'max': 6.564, 'min': 5.978} |
Authors
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_ping_module.html