napalm_ping ===================== This module logs into the device, issues a ping request, and returns the response Parameters ---------- .. raw:: html
Parameter | Required | Default | Choices | Description |
---|---|---|---|---|
count | False | N/A | N/A | N |
destination | True | N/A | N/A | H |
dev_os | False | N/A | N/A | OS of the device |
hostname | False | N/A | N/A | IP or FQDN of the device you want to connect to |
optional_args | False | N/A | N/A | Dictionary of additional arguments passed to underlying driver |
password | False | N/A | N/A | Password |
ping_timeout | False | N/A | N/A | M |
provider | False | N/A | N/A | Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Note - hostname, username, password and dev_os must be defined in either provider or local param Note - local param takes precedence, e.g. hostname is preferred to provider['hostname'] |
size | False | N/A | N/A | S |
source | False | N/A | N/A | S |
source_interface | False | N/A | N/A | i |
timeout | False | N/A | N/A | Time in seconds to wait for the device to respond |
ttl | False | N/A | N/A | M |
username | False | N/A | N/A | Username |
vrf | False | N/A | N/A | v |
Name | Description | Returned | Type | Sample |
---|---|---|---|---|
changed | ALWAYS RETURNS FALSE | always | bool | True |
results | structure response data of ping | always | dict | {"success": {"packet_loss": 0, "probes_sent": 2, "results": [{"ip_address": "10.0.0.5:", "rtt": 1.71}, {"ip_address": "10.0.0.5:", "rtt": 0.733}], "rtt_avg": 1.225, "rtt_max": 1.718, "rtt_min": 0.733, "rtt_stddev": 0.493}} |
alt_results | Example results key on failure | always | dict | {"error": "connect: Network is unreachable "}} |