community.network.icx_ping module – Tests reachability using ping from Ruckus ICX 7000 series switches
Note
This module is part of the community.network collection (version 5.1.0).
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 community.network
.
To use it in a playbook, specify: community.network.icx_ping
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
Tests reachability using ping from switch to a remote destination.
Aliases: network.icx.icx_ping
Parameters
Parameter |
Comments |
---|---|
Number of packets to send. Default is 1. |
|
ip-addr | host-name | vrf vrf-name | ipv6 [ ipv6-addr | host-name | vrf vrf-name] (resolvable by switch) of the remote node. |
|
Specifies the size of the ICMP data portion of the packet, in bytes. This is the payload and does not include the header. The value can range from 0 to 10000. The default is 16.. |
|
IP address to be used as the origin of the ping packets. |
|
Determines if the expected result is success or fail. Choices:
|
|
Specifies the time, in milliseconds for which the device waits for a reply from the pinged device. The value can range from 1 to 4294967296. The default is 5000 (5 seconds). |
|
Specifies the time to live as a maximum number of hops. The value can range from 1 to 255. The default is 64. |
|
Specifies the Virtual Routing and Forwarding (VRF) instance of the device to be pinged. |
Notes
Note
Tested against ICX 10.1
Examples
- name: Test reachability to 10.10.10.10
community.network.icx_ping:
dest: 10.10.10.10
- name: Test reachability to ipv6 address from source with timeout
community.network.icx_ping:
dest: ipv6 2001:cdba:0000:0000:0000:0000:3257:9652
source: 10.1.1.1
timeout: 100000
- name: Test reachability to 10.1.1.1 through vrf using 5 packets
community.network.icx_ping:
dest: 10.1.1.1
vrf: x.x.x.x
count: 5
- name: Test unreachability to 10.30.30.30
community.network.icx_ping:
dest: 10.40.40.40
state: absent
- name: Test reachability to ipv4 with ttl and packet size
community.network.icx_ping:
dest: 10.10.10.10
ttl: 20
size: 500
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Show the command sent. Returned: always Sample: |
|
Percentage of packets lost. Returned: always Sample: |
|
Packets successfully received. Returned: always Sample: |
|
Packets successfully transmitted. Returned: always Sample: |
|
Show RTT stats. Returned: always Sample: |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.