xk6-icmp
    Preparing search index...

    Interface PingOptions

    Options for configuring the ping operation.

    interface PingOptions {
        count?: number;
        deadline?: Duration;
        id?: number;
        interval?: Duration;
        preferred_ip_version?: IP;
        seq?: number;
        size?: number;
        source?: string;
        tags?: Record<string, string>;
        threshold?: number;
        timeout?: Duration;
        ttl?: number;
    }
    Index

    Properties

    count? deadline? id? interval? preferred_ip_version? seq? size? source? tags? threshold? timeout? ttl?

    Properties

    count?: number

    Number of ping requests to send. Default is 1.

    If the count is set to a value greater than 1, the ping process will send multiple requests and returns true if at least threshold percent of the requests succeed.

    deadline?: Duration

    Deadline for the whole ping operation. The value is a number or string. The number value is in milliseconds, the string value contains the unit (e.g. 2s). The deadline includes all echo requests and their responses.

    If the deadline is exceeded, the callback will be invoked with an error and the result will be false. Default is no deadline.

    id?: number

    Identifier for the ICMP session. It is a 16-bit unsigned integer. Default is a k6 process ID plus a VU ID modulo 65536.

    interval?: Duration

    Interval between ping requests if count is set to a value greater than 1. The value is a number or string. The number value is in milliseconds, the string value contains the unit (e.g. 2s). Default is 1s (1 second).

    A very low value can be used for DoS attacks, so the allowed minimum value can be configured via the K6_PING_MINIMUM_INTERVAL environment variable for safety. Default allowed minimum value is 500ms (0.5 seconds).

    preferred_ip_version?: IP

    Preferred IP protocol version to use for the ping request if the target is not an IPv4 or IPv6 address. Valid values are "ip4" and "ip6". If not set, "ip4" protocol will be used.

    seq?: number

    Starting sequence number for the ICMP echo request. It is a 16-bit unsigned integer. Default is a random value.

    size?: number

    Size of the data to include in the ping request, in bytes. If this option is not set, 56 bytes will be used (ping command default).

    source?: string

    Source IP address to use for the ping request. If not set, the system's default source address will be used.

    tags?: Record<string, string>

    Optional tags for metrics and logging.

    threshold?: number

    Minimum percent of successful ping responses required for the ping operation to be considered successful. If this option is not set, the default is 100 (%).

    timeout?: Duration

    Timeout for the single echo request and its response. The value is a number or string. The number value is in milliseconds, the string value contains the unit (e.g. 2s).

    If the timeout is exceeded, the callback will be invoked with an error and the result will be false. Default is 10s (10 seconds).

    ttl?: number

    Time to live for the ping packets. This value is decremented by each router the packet passes through.

    Settings

    On This Page

    Properties