1
Files
nagios-mirotalksfu/README.md
T

24 lines
1.0 KiB
Markdown

# check_mirotalksfu.py - Nagios plugin for Mirotalk SFU server
This Nagios plugin will query a Mirotalk SFU server and report on its status.
The "MIROTALKSFU OK" message will include the roundtrip response time, the
number of rooms open, and the number of users connected.
## Usage
The following parameters are supported by the plugin:
- `-H HOST` or `--hostname HOST`: specify the `HOST` or IP address of the
server to query
- `-p PORT` or `--port PORT`: specify the connection `PORT` of the server
- `-t SECONDS` or `--timeout SECONDS`: specify the timeout of the request in
`SECONDS` seconds
- `-S` or `--https`: connect using HTTPS
- `-A APIKEY` or `--apikey APIKEY`: specify the API key as `APIKEY` for HTTP endpoints
Note that if running on LibreNMS in the official Docker container, then you must
first install the `requests` module by running `apk add py3-requests` inside the Dispatcher container. The full command, assuming your container is named
`dispatcher`, is
```
docker exec -it dispatcher apk add py3-requests
```