New in version 2.1.
Tests reachability using ping from switch to a remote destination.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| count | no | 2 | Number of packets to send. |
|
| dest | yes | IP address or hostname (resolvable by switch) of remote node. |
||
| host | yes | 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 | no | 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 ANSIBLE_NET_PASSWORD will be used instead. |
||
| port | no | 0 (use common port) | 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). |
|
| provider | no | Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. |
||
| source | no | Source IP Address. |
||
| ssh_keyfile | no | 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 ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
| transport | yes | cli | 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_ssl | no |
| Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored. |
|
| username | no | Configures the username to use to authenticate the connection to the remote device. The value of username 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 ANSIBLE_NET_USERNAME will be used instead. |
||
| vrf | no | Outgoing VRF. |
# test reachability to 8.8.8.8 using mgmt vrf
- nxos_ping: dest=8.8.8.8 vrf=management host=68.170.147.165
# Test reachability to a few different public IPs using mgmt vrf
- 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
Common return values are documented here Common Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| count | Show amount of packets sent | always | string | 2 |
| packet_loss | Percentage of packets lost | always | string | 0.00% |
| dest | Show the ping destination | always | string | 8.8.8.8 |
| packets_rx | Packets successfully received | always | string | 2 |
| rtt | Show RTT stats | always | dict | {'max': '6.564', 'avg': '6.264', 'min': '5.978'} |
| updates | Show the command sent | always | list | ['ping 8.8.8.8 count 2 vrf management'] |
| packets_tx | Packets successfully transmitted | always | string | 2 |
| action | ['Show what action has been performed'] | always | string | PING 8.8.8.8 (8.8.8.8): 56 data bytes |
For more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_ping_module.html