[go: nahoru, domu]
Skip to content

Latest commit

 

History

History
381 lines (344 loc) · 14.5 KB

cisco.ios.ios_ping_module.rst

File metadata and controls

381 lines (344 loc) · 14.5 KB
Raw

cisco.ios.ios_ping

Tests reachability using ping from IOS switch.

Version added: 1.0.0

Synopsis

  • Tests reachability using ping from switch to a remote destination.
  • For a general purpose network module, see the net_ping module.
  • For Windows targets, use the win_ping module instead.
  • For targets running Python, use the ping module instead.

Parameters

Parameter Choices/Defaults Comments
afi
string
    Choices:
  • ip ←
  • ipv6
Define echo type ip or ipv6.
count
integer
Number of packets to send.
dest
string / required
The IP Address or hostname (resolvable by switch) of the remote node.
df_bit
boolean
    Choices:
  • no ←
  • yes
Set the DF bit.
egress
string
Force egress interface bypassing routing.
ingress
string
LAN source interface for Ingress.
size
integer
Size of the packet to send.
source
string
The source IP Address.
state
string
    Choices:
  • absent
  • present ←
Determines if the expected result is success or fail.
timeout
integer
specify timeout interval.
vrf
string
The VRF to use for forwarding.

Notes

Note

  • Tested against Cisco IOSXE Version 17.3 on CML.
  • For a general purpose network module, see the net_ping module.
  • For Windows targets, use the win_ping module instead.
  • For targets running Python, use the ping module instead.

Examples

- name: Test reachability to 198.51.100.251 using default vrf
  cisco.ios.ios_ping:
    dest: 198.51.100.251

- name: Test reachability to 198.51.100.252 using prod vrf
  cisco.ios.ios_ping:
    dest: 198.51.100.252
    vrf: prod
    afi: ip

- name: Test un reachability to 198.51.100.253 using default vrf
  cisco.ios.ios_ping:
    dest: 198.51.100.253
    state: absent

- name: Test reachability to 198.51.100.250 using prod vrf and setting count and source
  cisco.ios.ios_ping:
    dest: 198.51.100.250
    source: loopback0
    vrf: prod
    count: 20

- name: Test reachability to 198.51.100.249 using df-bit and size
  cisco.ios.ios_ping:
    dest: 198.51.100.249
    df_bit: true
    size: 1400

- name: Test reachability to ipv6 address
  cisco.ios.ios_ping:
    dest: 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff
    afi: ipv6

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
commands
list
always
Show the command sent.

Sample:
['ping vrf prod 198.51.100.251 count 20 source loopback0']
packet_loss
string
always
Percentage of packets lost.

Sample:
0%
packets_rx
integer
always
Packets successfully received.

Sample:
20
packets_tx
integer
always
Packets successfully transmitted.

Sample:
20
rtt
dictionary
always
Show RTT stats.

Sample:
{'avg': 2, 'max': 8, 'min': 1}


Status

Authors

  • Jacob McGill (@jmcgill298)
  • Sagar Paul (@KB-perByte)