community.general.icx_ping (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Tests reachability using ping from switch to a remote destination.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Test reachability to 10.10.10.10
  icx_ping:
    dest: 10.10.10.10

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Test reachability to ipv6 address from source with timeout
  icx_ping:
    dest: ipv6 2001:cdba:0000:0000:0000:0000:3257:9652
    source: 10.1.1.1
    timeout: 100000

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Test reachability to 10.1.1.1 through vrf using 5 packets
  icx_ping:
    dest: 10.1.1.1
    vrf: x.x.x.x
    count: 5

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Test unreachability to 10.30.30.30
  icx_ping:
    dest: 10.40.40.40
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Test reachability to ipv4 with ttl and packet size
  icx_ping:
    dest: 10.10.10.10
    ttl: 20
    size: 500

Inputs

    
ttl:
    description:
    - Specifies the time to live as a maximum number of hops. The value can range from
      1 to 255. The default is 64.
    type: int

vrf:
    description:
    - Specifies the Virtual Routing and Forwarding (VRF) instance of the device to be
      pinged.
    type: str

dest:
    description:
    - ip-addr | host-name | vrf vrf-name | ipv6 [ ipv6-addr | host-name | vrf vrf-name]  (resolvable
      by switch) of the remote node.
    required: true
    type: str

size:
    description:
    - 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..
    type: int

count:
    description:
    - Number of packets to send. Default is 1.
    type: int

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Determines if the expected result is success or fail.
    type: str

source:
    description:
    - IP address to be used as the origin of the ping packets.
    type: str

timeout:
    description:
    - 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).
    type: int

Outputs

commands:
  description: Show the command sent.
  returned: always
  sample:
  - ping 10.40.40.40 count 20 source loopback0
  - ping 10.40.40.40
  type: list
packet_loss:
  description: Percentage of packets lost.
  returned: always
  sample: 0%
  type: str
packets_rx:
  description: Packets successfully received.
  returned: always
  sample: 20
  type: int
packets_tx:
  description: Packets successfully transmitted.
  returned: always
  sample: 20
  type: int
rtt:
  description: Show RTT stats.
  returned: always
  sample:
    avg: 2
    max: 8
    min: 1
  type: dict