ping( target, [options] )

Sends ICMP echo requests (pings) to the specified target.

Signature

ping(target, options)

Parameters

Parameter	Type	Description
target	string	Hostname or IP address to ping.
options	PingOptions	Optional ping configuration options.

Returns

Type	Description
boolean	Returns `true` if the number of successful pings is greater than or equal to the threshold, otherwise `false`.

Example

import { ping } from "k6/x/icmp"

export default function () {
  const host = "8.8.8.8"

  console.log(`Pinging ${host}:`);

  if (ping(host)) {
    console.log(`Host ${host} is reachable`);
  } else {
    console.error(`Host ${host} is unreachable`);
  }
}