File: command.rst

package info (click to toggle)
simplemonitor 1.15.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,520 kB
  • sloc: python: 8,725; sh: 258; makefile: 74; javascript: 69
file content (33 lines) | stat: -rw-r--r-- 906 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
command - run an external command
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Run a command, and optionally verify its output. If the command exits non-zero, this monitor fails.

.. confval:: command

    :type: string
    :required: true

    the command to run.

.. confval:: result_regexp

    :type: string (regular expression)
    :required: false
    :default: none

    if supplied, the output of the command must match else the monitor fails.

.. confval:: result_max

    :type: integer
    :required: false

    if supplied, the output of the command is evaluated as an integer and if greater than this, the monitor fails. If the output cannot be converted to an integer, the monitor fails.

.. confval:: show_output

    :type: boolean
    :required: false

    if set to true, the output of the command will be captured as the message with a successful test or appended to the message on a failed test.