Checks PortTcp

Table of Contents

Check: PortTcp

To get this help: amcli --explain=PortTcp.

To add a section in your ini:

  • Execute: amcli --nocolor --explain=PortTcp >> example.ini.
  • edit the example.ini in a text editor and update the needed values.

Syntax of an ini section


; -----------------------------------------------------------------------------
;
; Plugin PortTcp
; Check if the local server or another host is listening to a given port number.
;
[<Your check name>]
description="A short description what will be tested"
function="PortTcp"


; key 'host' {string} 🔸(required)
; optional: hostname to connect to; if unavailable 127.0.0.1 will be tested
; example: mysql:host=$aDb[server];port=3306;dbname=$aDb[database]
; default: (not provided)
params[host]=<Your value here>

; key 'port' {int} 🔸(required)
; port number to check
; example: 22
; default: (not provided)
params[port]=<Your value here>

; key 'timeout' {int} 🔹(optional)
; optional timeout in sec; default: 5
; example: 3
; default: 5
params[timeout]=<Your value here>