Checks Simple

Table of Contents

Check: Simple

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

To add a section in your ini:

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

Syntax of an ini section


; -----------------------------------------------------------------------------
;
; Plugin Simple
; Check loaded php modules
;
[<Your check name>]
description="A short description what will be tested"
function="Simple"


; key 'value' {string} 🔸(required)
; Ouput text to describe the result
; example: My simple example
; default: (not provided)
params[value]=<Your value here>

; key 'result' {int} 🔸(required)
; Result value to return
; example: 0 (for "ok")
; default: (not provided)
params[result]=<Your value here>

; key 'type' {string} 🔹(optional)
; Type of the rendetred tile
; example: counter
; default: (not provided)
params[type]=<Your value here>

; key 'count' {float} 🔹(optional)
; If a count exists in a check then a tile will be rendered as a tile
; example: 3.14
; default: (not provided)
params[count]=<Your value here>

; key 'visual' {string} 🔹(optional)
; Visualize count value with "simple", "line", "bar,<width>,<count>"
; example: bar,3,100
; default: (not provided)
params[visual]=<Your value here>