TeamSpeak

Send a command to a TeamSpeak server from the panel and read the reply.

Save the ServerQuery login once, and the console is there whenever you need it.

Open Admin > TeamSpeak.

What this page covers

This page is a ServerQuery console for a TeamSpeak server that already runs somewhere. Use it to:

• Store the address, the query port, and the ServerQuery login of a TeamSpeak server.
• Send any ServerQuery command and read the raw reply.

The panel encrypts the ServerQuery password before it saves. The panel connects to the query port. It does not touch the voice port.

This page does not host a TeamSpeak server

It sends commands to one that is already running, wherever that is.

To host one on this panel, create a game server from a TeamSpeak egg in the Voice Servers nest. You then manage it from its own server page.

A server you create that way does not appear here. Add it here as well to get the ServerQuery console for it.

Before you start

The panel keeps the ServerQuery password encrypted. Without an app encryption key in the panel environment, the whole TeamSpeak area stops working. The page then loads with an empty list and no error message.

If the list stays empty after you add an instance, set the encryption key and restart the panel.

Registering an instance

1. Click Add instance. A panel named New TeamSpeak instance opens.
2. Fill in the boxes. Each box shows its purpose as placeholder text. There are no separate labels.

Box	Description	Default
Display name	The name in the panel list.	empty
Host (ts.example.com)	The address of the TeamSpeak server. This box is required.	empty
Query port	The ServerQuery port.	10011
Voice port	The voice port. The panel records it but never connects to it.	9987
ServerQuery login	The ServerQuery user name. This box is required.	serveradmin
Password	The ServerQuery password. This box is required.	empty
Virtual server ID	The virtual server that the panel selects before each command.	1

3. Click Save.

The panel does not test the login at this point. The first test happens when you run a command.

Your instances

Column	Contents
Name	The display name.
Host	The address.
Query port	The ServerQuery port.
SID	The virtual server ID.

There is no detail page. The list shows an empty state that reads No instances registered.

Running a ServerQuery command

1. Click Run command on the row. The ServerQuery command card opens.
2. Type the command. The box starts with clientlist.
3. Click Run.

The reply appears below the box in plain text.

For each command the panel opens a new connection, logs in, selects the virtual server, sends the command, and disconnects. The panel keeps no session and no command history. The reply disappears when you close the card.

Use this console for the actions that the page has no button for. Examples:

• serverinfo - read the current server settings.
• serveredit virtualserver_maxclients=64 - change the slot count.
• clientlist - list the connected clients.
• banadd ip=203.0.113.10 time=0 - add a ban.

A failed command shows the raw TeamSpeak error, for example an error about an invalid login name or password.

Editing an instance

There is no edit action. To change a host, a port, or a password, unregister the instance and add it again.

Unregistering an instance

Click Unregister on the row. The dialog reads:

"<name>" is removed from the panel. The instance itself keeps running.

Click Unregister to confirm. The TeamSpeak server and its data are not touched.

Customer visibility

This page is for administrators only. There is no per-server TeamSpeak tab.

Permissions

The TeamSpeak entry appears for an administrator with the settings view permission. Adding an instance, running a command, and unregistering an instance all need the settings update permission.

There is no license add-on for this page.

Every action writes an audit entry. A command entry records the first part of the command text. See Audit Logs.

Next steps

• Eggs - the TeamSpeak eggs in the Voice Servers nest.
• Cloudflare - automatic SRV records for TeamSpeak servers.