How to use the Server Query

[ColonelJohn]

How do you use and work server query?

Please help.

[Sebi94]

Hello!

How do you use and work server query?

ServerQuery is a commandline based administration tool/feature of TeamSpeak 3 server.

There are two ways to use a ServerQuery:

• Telnet (Putty or Linux Commandline)
• Webinterface (Take a look at http://addons.teamspeak.com/)

Telnet
You can open a "telnet" connection to your TeamSpeak 3 server. Just follow the steps:

• Windows
  
  1. Download Putty: http://www.putty.org/
  2. Open Putty
  3. Enter your TeamSpeak 3 server address in the Putty field 'Host Name (or IP Address)'
  4. Connection Type: Telnet
  5. Port: 10011 (default)
  6. Now open your telnet connection by pressing the button "Open"
  7. If all was correctly, you will see something like this:
     

     TS3
     Welcome to the TeamSpeak 3 ServerQuery interface, type "help" for a list of commands and "help <command>" for information on a specific command.

  8. As next step, you have to login with your ServerQuery account:
     

     login <serverquery username> <serverquery password>

     For example like this:
     

     login serveradmin verySecret$Password2013

     Your server will answer you, if your login was successfull or not:
     

     error id=0 msg=ok

  9. Now: You can run every command, which is listed in the help list:
     

     help
     TeamSpeak 3 Server :: ServerQuery
     (c) TeamSpeak Systems GmbH
     
     ServerQuery is a command-line interface built into the TeamSpeak 3 Server which
     allows powerful scripting and automation tools to be built based on the exact
     same instruction set and functionality provided by the TeamSpeak 3 Client. For
     example, you can use scripts to automate the management of virtual servers or
     nightly backups. In short, you can perform operations more efficiently by using
     ServerQuery scripts than you can by using a user interface.
     
     Command Overview:
        help                        | read help files
        login                       | authenticate with the server
        logout                      | deselect virtual server and log out
        quit                        | close connection
        use                         | select virtual server
        banadd                      | create a ban rule
        banclient                   | ban a client
     .
     .
     .

  
  
• Linux
  
  1. Open a terminal
  2. Enter the following command to connect to your TeamSpeak 3 server:
     

     telnet <host> <serverquery port>

     For example:
     

     telnet yourdomain.com 10011

  3. If it was correctly, you will see something like this:
     

     Trying 127.0.0.1...
     Connected to localhost.
     Escape character is '^]'.
     TS3
     Welcome to the TeamSpeak 3 ServerQuery interface, type "help" for a list of commands and "help <command>" for information on a specific command.

  4. As next step, you have to login with your ServerQuery account:
     

     login <serverquery username> <serverquery password>

     For example like this:
     

     login serveradmin verySecret$Password2013

     Your server will answer you, if your login was successfull or not:
     

     error id=0 msg=ok

  5. Now: You can run every command, which is listed in the help list:
     

     help
     TeamSpeak 3 Server :: ServerQuery
     (c) TeamSpeak Systems GmbH
     
     ServerQuery is a command-line interface built into the TeamSpeak 3 Server which
     allows powerful scripting and automation tools to be built based on the exact
     same instruction set and functionality provided by the TeamSpeak 3 Client. For
     example, you can use scripts to automate the management of virtual servers or
     nightly backups. In short, you can perform operations more efficiently by using
     ServerQuery scripts than you can by using a user interface.
     
     Command Overview:
        help                        | read help files
        login                       | authenticate with the server
        logout                      | deselect virtual server and log out
        quit                        | close connection
        use                         | select virtual server
        banadd                      | create a ban rule
        banclient                   | ban a client
     .
     .
     .

To the commands: If you don't know, how they are working: run the command "help <commandname>". You will get the detailled usage informations about the command.

For example like that:

help servercreate
Usage: servercreate [virtualserver_properties...]

Creates a new virtual server using the given properties and displays its ID and
initial administrator token. If virtualserver_port is not specified, the server
will test for the first unused UDP port.

Example:
   servercreate virtualserver_name=TeamSpeak\s]\p[\sServer
    virtualserver_port=9988 virtualserver_maxclients=32
   sid=7 token=HhPbcMAMdAHGUip1yOma2Tl3sN0DN7B3Y0JVzYv6 virtualserver_port=9988
   error id=0 msg=ok


error id=0 msg=ok

Webinterface
You can use a graphical user interface and can do some until all commands by clicking (without knowing the ServerQuery commands). The Webinterface is running the ServerQuery commands in background.

One negative point is, that you will need a webserver with php module for the webinterface(s).

On the http://addons.teamspeak.com/ page, you can find much different webinterfaces with different layout and functionality.

Myself is using two webinterfaces:

• For the computer: Psychokiller's webinterface
• For the smartphone/tablet: TS3 WebApp (from myself)

Why two different? The problem of Psychokiller's webinterface is, that you have to load very much styles and images and that needs much time on a mobile internet connection. I need everytime fast access to my server from everwhere.

I hope I could help you.

[ColonelJohn]

I'm so sorry! I didn't get your reply until literally JUST now. I did get putty and it thankfully does work and I have been able to log in. Thank you!

[Sebi94]

Ah, okay.

Yeah, no problem.

[zploch1]

Hello,

How exactly do you get the window up where you can use the Server Query? When I hit Server Query Log In, it just asks me for information. I type it in and nothing happens.

[Istalantar]

'server query login' only creates a login for you. You need another program to use it (putty) Here is the link to the query manual: http://media.teamspeak.com/ts3_liter...y%20Manual.pdf

[Sebi94]

How exactly do you get the window up where you can use the Server Query?

That's also written here.

[numma_cway]

Why do people still bother with telnet/Putty over two years after my release of YaTQA? I don't get that.

[Barungar]

Why do people still bother with telnet/Putty over two years after my release of YaTQA? I don't get that.

Because some people like to use a console?! I for example hate GUIs and use a text-based interface whenever this is possible. Even in Windows in many cases I use PowerShell or CMD before I try to mess with this stupid explorer.

[Matthias B]

I do not use an external tool for administration because when I work with a console I know what commands I execute. If there is a bug in a tool I'm using, things can get messed up. So for people like me it's just a "Never trust anybody" thing ;-)

[darkdaz]

Why do people still bother with telnet/Putty over two years after my release of YaTQA? I don't get that.

becuase the site were Your YaTOA is stored etc ts3 addons site,, we cant access as the site is down and no sign of it returning

[PotaBlava]

becuase the site were Your YaTOA is stored etc ts3 addons site,, we cant access as the site is down and no sign of it returning

There is an alternate link for Yatqa in its thread:
http://forum.teamspeak.com/showthrea...ery-Admin-Tool

[billytalent231]

that pretty much it

[numma_cway]

If you want to do it the very complicated way, read this. If not, read this.

[redhawk44109]

i'm new to teamspeak 3 and i'm trying to use webinterface but i'm a noob at it can you please help if possible?