From de160c0a720bb8dccc1ff349ac776d8ce27bd3d2 Mon Sep 17 00:00:00 2001 From: XiCoN-FJS- Date: Sat, 2 Jan 2016 03:19:36 +0100 Subject: [PATCH] Add readme incl. description of project --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c734dbd..0f98f26 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,10 @@ # check_teamspeak3 -Nagios/Icinga(2) Check for Teamspeak™ 3 Server via "voice" port +Nagios/Icinga(2) Check for **Teamspeak™ 3 Server** via "voice" port + + +This perl script is a check script for Nagios™ & Icinga(2) for probing the status of a Teamspeak™ 3 server via its "voice" port *(default: 9987/udp)*. + +The check is using a fixed packet sequence including the magic string `TS3INIT` to initialize a connection und waiting for a valid response. It is useful, if you don't have access to the "serverquery" port *(default: 10011/tcp)*, which allows to do telnet queries, or you really want to know, if the Teamspeak™ 3 server is (really) reachable from external. + + +**Warning: ANY USE OF THE SOFTWARE IS ENTIRELY AT YOUR OWN RISK** (because it's using a hacky predefined data stream which is usually not the way to go)