PingIP

Edit online

The PingIP method pings the specified IP address.

Method Synopsis

PingIP($ipAddress [, $protocol])

Parameters

$ipAddress
Specifies the IP address to be pinged.
$protocol
Specifies an optional parameter that identifies the IP protocol. You can specify one of the following values:
  • 1 — Specifies Internet Protocol version 4 (IPv4).
  • 3 — Specifies Internet Protocol version 6 (IPv6).

Description

The PingIP method pings the IP address specified in the ipAddress parameter. The method returns without waiting for a response from the network device at that address.

Notes®

The PingIP method issues the appropriate ping request to the Helper Server, which performs the actual work. Thus, the Helper Server (and ncp_ctrl) must be running so that this method can make the appropriate ping request.

Returns

Upon completion, the PingIP method returns the value 1 to indicate that it successfully pinged the device at the specified address. Otherwise, it returns the value 0 (zero).