xk6-icmp
    Preparing search index...

    Interface PingDetail

    Data you receive as a parameter in the ping callback.

    interface PingDetail {
        alive: boolean;
        id?: number;
        options: PingOptions;
        received_at?: number;
        sent_at?: number;
        seq?: number;
        size?: number;
        target: string;
        target_ip: string;
        target_ip_version: IP;
        ttl?: number;
    }
    Index

    Properties

    alive id? options received_at? sent_at? seq? size? target target_ip target_ip_version ttl?

    Properties

    alive: boolean

    Indicates whether the target is reachable (if an echo reply was received).

    id?: number

    Identifier for the ICMP session from the echo reply, if a response was received.

    options: PingOptions

    Ping options used for the request.

    received_at?: number

    Timestamp when the response was received. Value is in UTC milliseconds since the Unix epoch.

    sent_at?: number

    Timestamp when the request was sent. Value is in UTC milliseconds since the Unix epoch.

    seq?: number

    Sequence number for the ICMP echo request from the echo reply, if a response was received.

    size?: number

    Size of the ICMP echo reply, if a response was received.

    target: string

    Hostname or IP address that was pinged.

    target_ip: string

    Target IP address that was pinged.

    target_ip_version: IP

    Target IP version that was used for the ping request. Valid values are "ip4" and "ip6".

    ttl?: number

    Time to live from the echo reply, if a response was received.

    Settings

    On This Page

    Properties