File: host.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 (37 lines) | stat: -rw-r--r-- 976 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
34
35
36
37
host - ping a host
^^^^^^^^^^^^^^^^^^

Check a host is pingable.

.. tip:: This monitor relies on executing the ``ping`` command provided by your OS. It has known issues on non-English locales on Windows. You should use the :ref:`ping<ping>` monitor instead. The only reason to use this one is that it does not require SimpleMonitor to run as root.

.. confval:: host

    :type: string
    :required: true

    the hostname/IP to ping

.. confval:: ping_regexp

    :type: regexp
    :required: false
    :default: automatic

    the regexp which matches a successful ping. You may need to set this to use this monitor in a non-English locale.

.. confval:: time_regexp

    :type: regexp
    :required: false
    :default: automatic

    the regexp which matches the ping time in the output. Must set a match group named ``ms``. You may need to set this as above.

.. confval:: count

    :type: int
    :required: false
    :default: ``1``

    the number of pings to send