Ping

Run a ping on any host.

Attribute	Type	Required	Default	Description
`cmd`	`const`	Yes	`ping`	Command Name
`name`	`string`	Yes		Name to uniquely identify the teststep. This name will show up in reports, logs and the WebUI
`options`	`OptionsObject`	No		Additional command options
`parameters`	`PingOptions`	Yes		Options passed into the `ping` cmd

Ping Options

Attribute	Type	Required	Default	Description
`host`	`string`	Yes		Hostname or IP address used for the ping.
`port`	`integer`	No	`22`	Port to use for the ping.
`proxy`	`PingProxyOptions`	No		Optional proxy configuration for connecting through an intermediate host.
`expect`	`PingExpectOptions`	No		Expected result of the ping.

Ping Proxy Options

Attribute	Type	Required	Default	Description
`type`	`string`	Yes		Type of proxy to use. Currently only `ssh` is supported.
`host`	`string`	Yes		Hostname or IP address of the proxy server.
`port`	`integer`	No	`22`	Port to connect to on the proxy server.
`ssh`	`PingProxySSHOptions`	Yes (when type is ssh)		SSH-specific proxy configuration.

Ping Proxy SSH Options

Attribute	Type	Required	Default	Description
`user`	`string`	Yes		Username for SSH authentication to the proxy.
`password`	`string`	No		Password for SSH authentication (optional if using key-based auth).
`identity_file`	`string`	No		Path to private key file for SSH authentication.
`timeout`	`string`	No	`30s`	Timeout for SSH connection (e.g., ’30s’, ‘5m’).

Ping Expect Options

Attribute	Type	Required	Default	Description
`should_fail`	`boolean`	No	`false`	Expect the port to stay closed for the whole step timeout. The step fails at the first connection that the port accepts. Through a proxy that is never reachable, the state of the port is unknown, so the step fails.

Ping Examples

Basic Ping

cmd: ping
name: Wait for the device to become online.
options:
  timeout: 4m
parameters:
  host: "[[attributes.Host]]"

Port stays closed

options.timeout sets how long the port must stay closed:

- cmd: ping
  name: The raw VNC port is closed to the network
  options:
    timeout: 30s
  parameters:
    host: "[[attributes.BMC]]"
    port: 5900
    expect:
      should_fail: true

The log reads Port 5900 on '...' stayed closed for 30s.

Ping with SSH Proxy

- cmd: ping
  name: Wait for the device to become online.
  options:
    timeout: 4m
  parameters:
    host: "[[attributes.host]]"
    port: 22
    proxy:
      type: ssh
      host: "[[attributes.dutctl]]"
      port: 22
      ssh:
        user: oscar
        identity_file: "[[ssh-keys.proxy_key]]" # Or omit for auto-discovery