Set server query for TeamSpeak 3

TeamSpeak itself has integrated the server query as a command line-based feature so that admins can effectively maintain and manage their TeamSpeak 3 servers.

Written on Mar 24, 2022

You can perform all tasks that you can also perform as a server admin in the TeamSpeak3 client. However, the server query has significantly more rights. For example, you can activate and deactivate the anti-DoS function of the TeamSpeak 3 server or change server instance rights.

How is the server query used?

There are various ways to use the server query:

  • Connection via Telnet with programs or the Linux command line
  • Via a web interface
  • Via software programs

Server query via Telnet

The easiest way to connect to your own TeamSpeak3 server via console is to connect via Telnet.

  1. download the Telnet client, for example Putty
    1. if you are using Linux as your operating system, you can use the telnet command directly via the terminal.
  2. start the Telnet client and enter the connection data
    1. host name (or IP address): Enter your TeamSpeak3 IP address
    2. connection type: select `telnet
    3. port: The ServerQuery-Port is required here, this is 10011 by default
  3. then click on Open to start the connection via Telnet
  4. if the connection is successful, a server message will appear
    1. Welcome to the TeamSpeak 3 ServerQuery interface, type "help" for a list of commands and "help <command>" for information on a specific command.
  5. so that you can now also send commands, you still have to log in with your ServerQuery data
    1. you will usually receive the login data from your server hoster or you can generate it as an admin via the client. To do this, go to Extras at the top and click on ServerQuery Login.
    2. now log in with your data: login <username> <password>
    3. if the login is successful, you will receive the following message: error id=0 msg=ok

Server query via web interface

There are now some good, web-based admin tools. However, these often have to be installed on your own web server. Settings are then made via the browser.

  • Web interfaces for server administration are often provided by commercial TS3 server providers and hosters for their customers.

Example interface

An example interface is the TS3 Manager from www.ts3.app (as of 03/2022).

Server query via locally installed programs

Programs for TeamSpeak3 server administration are installed locally on the computer. After installation, you connect to the server - similar to the Telnet connection - and all settings can be entered conveniently via an interface.

Example program

An example program is the Yet another TeamSpeak3 Query app from yat.qa (as of 03/2022).

The most important Teamspeak3 server commands

Console commandExplanation
login <user> <password>Server-Query Login / Telnet
serverlistAll virtual TS3 servers are displayed
use <server id>select server via ID
use port=<port>select server via port
serverinfoserver information is read out
serveredit virtualserver_maxclients=<max user>set maximum number of slots
servercreate virtualserver_name=<name> virtualserver_port=<port> virtualserver_maxclients=<max user>Create virtual server with entered settings
serverdelete sid=<server id>Delete virtual server via ID
serverstop sid=<server id>Stop virtual server via ID
serverstart sid=<server id>Start virtual server via ID

Official server query instructions and manual

The official manual explains the complex topic in detail, including all the necessary server commands for the console.

The current manual is always included in the doc directory of the Teamspeak 3 server files.

Teamspeak3 Logo

Overview

Developer

TeamSpeak Systems GmbH

Studio

TeamSpeak Systems GmbH

Release

Aug 10, 2011

Genres

Platforms

Mac OS X, Windows, iOS, Android, Linux

More topics about TeamSpeak 3