cisco.nxos.nxos_ping module – Tests reachability using ping from Nexus switch.

Note

This module is part of the cisco.nxos collection (version 9.2.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.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_ping.

New in cisco.nxos 1.0.0

Synopsis

Parameters

Parameter

Comments

count

integer

Number of packets to send.

Default: 5

dest

string / required

IP address or hostname (resolvable by switch) of remote node.

df_bit

boolean

Set the DF bit.

Choices:

  • false ← (default)

  • true

size

integer

Size of packets to send.

source

string

Source IP Address or hostname (resolvable by switch)

state

string

Determines if the expected result is success or fail.

Choices:

  • "absent"

  • "present" ← (default)

vrf

string

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

commands

list / elements=string

Show the command sent

Returned: always

Sample: ["ping 8.8.8.8 count 2 vrf management"]

packet_loss

string

Percentage of packets lost

Returned: always

Sample: "0.00%"

packets_rx

integer

Packets successfully received

Returned: always

Sample: 2

packets_tx

integer

Packets successfully transmitted

Returned: always

Sample: 2

rtt

dictionary

Show RTT stats

Returned: always

Sample: {"avg": 6.264, "max": 6.564, "min": 5.978}

Authors

  • Jason Edelman (@jedelman8)

  • Gabriele Gerbino (@GGabriele)