Skip to content

Network Actions ​

General ​

waitPort ​

Waits until a TCP port on a host is open, or until the timeout expires.

Returns: true when the port becomes open within the timeout.

ParameterTypeRequiredDefaultDescription
hoststring✓—Hostname or IP address to connect to.
portnumber✓—TCP port number to wait for (1–65535).
timeoutnumber60000Maximum time to wait in milliseconds (default 60000).
yaml
# Wait for an SSH port to open before connecting
- group: network
  name: waitPort
  params:
    host: '{{ targetHost }}'
    port: 22
    timeout: 60000

Port ​

resolveDNS ​

Resolves DNS records for a hostname, optionally filtered by record type.

Returns: An array of DNS records matching the requested type.

ParameterTypeRequiredDefaultDescription
hoststring✓—Hostname to resolve.
typeA | AAAA | MX | NS | CNAME | TXT—DNS record type to query (A, AAAA, MX, NS, CNAME, or TXT). Defaults to A.
yaml
# Resolve A records for a target host
- group: network
  name: resolveDNS
  params:
    host: '{{ targetHost }}'
    type: A

DNS ​

reverseDNS ​

Performs a reverse DNS lookup to find the hostname(s) associated with an IP address.

Returns: An array of hostnames mapped to the given IP.

ParameterTypeRequiredDefaultDescription
ipstring✓—IP address to perform a reverse DNS lookup on.
yaml
# Reverse-lookup the hostname for a known IP address
- group: network
  name: reverseDNS
  params:
    ip: '{{ targetIp }}'

lookup ​

Performs a general DNS lookup for a hostname, returning all resolved addresses.

Returns: An array of { address, family } objects for the hostname.

ParameterTypeRequiredDefaultDescription
hostnamestring✓—Hostname to look up.
yaml
# Look up all IP addresses (IPv4 and IPv6) for a hostname
- group: network
  name: lookup
  params:
    hostname: '{{ targetHost }}'

ping ​

Sends an ICMP echo request (ping) to a host and returns whether it is reachable.

Returns: true if the host is alive and responds to ping, otherwise false.

ParameterTypeRequiredDefaultDescription
hoststring✓—Hostname or IP address to ping.
yaml
# Check whether a remote host is reachable via ICMP ping
- group: network
  name: ping
  params:
    host: '{{ targetHost }}'

Connectivity ​

checkTlsCertificate ​

Connects to a host over TLS and returns the server's certificate details.

Returns: An object containing the certificate's subject, issuer, validity dates, days remaining, and SANs.

ParameterTypeRequiredDefaultDescription
hoststring✓—Server hostname to check the TLS certificate for.
portnumber443Server port (default 443).
yaml
# Inspect the TLS certificate on a web server (defaults to port 443)
- group: network
  name: checkTlsCertificate
  params:
    host: '{{ serverHost }}'

Released under the Apache License 2.0.