| banadd |
[ip={regexp}] [name={regexp}] [uid={clientUID}] |
Adds a new ban rule on the selected virtual server. All parameters are optional but at least one of the following must be set: ip, name, or uid. |
b_client_ban_create |
| banclient |
clid={clientID} [time={timeInSeconds}] [banreason={text}] |
Bans the client specified with ID clid from the server. Please note that this will create two separate ban rules for the targeted clients IP address and his unique identifier. |
i_client_ban_power, i_client_needed_ban_power |
| bandel |
banid={banID} |
Deletes the ban rule with ID banid from the server. |
b_client_ban_delete, b_client_ban_delete_own |
| bindinglist |
[subsystem={voice|query|filetransfer}] |
Displays a list of IP addresses used by the server instance on multi-homed machines. If no subsystem is specified, "voice" is used by default. |
b_serverinstance_binding_list |
| channeladdperm |
cid={channelID} [permid={permID}...] |
Adds a set of specified permissions to a channel. Multiple permissions can be added by providing the two parameters of each permission. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| channelclientaddperm |
cid={channelID} cldbid={clientDBID} |
Adds a set of specified permissions to a client in a specific channel. Multiple permissions can be added by providing the three parameters of each permission. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| channelclientdelperm |
cid={channelID} cldbid={clientDBID} |
Removes a set of specified permissions from a client in a specific channel. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| channelclientpermlist |
cid={channelID} cldbid={clientDBID} [-permsid] |
Displays a list of permissions defined for a client in a specific channel. |
b_virtualserver_channelclient_permission_list |
| channelcreate |
channel_name={channelName} [channel_properties...] |
Creates a new channel using the given properties and displays its ID. Note that this command accepts multiple properties which means that you're able to specifiy all settings of the new channel at once. For detailed information, see Channel Properties. |
i_channel_min_depth, i_channel_max_depth, b_channel_create_child, b_channel_create_permanent, b_channel_create_semi_permanent, b_channel_create_temporary, b_channel_create_with_topic, b_channel_create_with_description, b_channel_create_with_password, b_channel_create_modify_with_codec_speex8, b_channel_create_modify_with_codec_speex16, b_channel_create_modify_with_codec_speex32, b_channel_create_modify_with_codec_celtmono48, i_channel_create_modify_with_codec_maxquality, i_channel_create_modify_with_codec_latency_factor_min, b_channel_create_with_maxclients, b_channel_create_with_maxfamilyclients, b_channel_create_with_sortorder, b_channel_create_with_default, b_channel_create_with_needed_talk_power |
| channeldelete |
cid={channelID} force={1|0} |
Deletes an existing channel by ID. If force is set to 1, the channel will be deleted even if there are clients within. The clients will be kicked to the default channel with an appropriate reason message. |
b_channel_delete_permanent, b_channel_delete_semi_permanent, b_channel_delete_temporary, b_channel_delete_flag_force |
| channeldelperm |
cid=123 [permid={permID}...] [permsid={permName}...] |
Removes a set of specified permissions from a channel. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| channeledit |
cid={channelID} [channel_properties...] |
Changes a channels configuration using given properties. Note that this command accepts multiple properties which means that you're able to change all settings of the channel specified with cid at once. For detailed information, see Channel Properties. |
i_channel_min_depth, i_channel_max_depth, b_channel_modify_parent, b_channel_modify_make_default, b_channel_modify_make_permanent, b_channel_modify_make_semi_permanent, b_channel_modify_make_temporary, b_channel_modify_name, b_channel_modify_topic, b_channel_modify_description, b_channel_modify_password, b_channel_modify_codec, b_channel_create_modify_with_codec_speex8, b_channel_create_modify_with_codec_speex16, b_channel_create_modify_with_codec_speex32, b_channel_create_modify_with_codec_celtmono48, b_channel_modify_codec_quality, b_channel_create_modify_with_codec_maxquality, b_channel_modify_codec_latency_factor, b_channel_modify_make_codec_encrypted, b_channel_modify_maxclients, b_channel_modify_maxfamilyclients, b_channel_modify_sortorder, b_channel_modify_needed_talk_power, i_channel_modify_power, i_channel_needed_modify_power |
| channelfind |
pattern={channelName} |
Displays a list of channels matching a given name pattern. |
b_virtualserver_channel_search |
| channelgroupadd |
name={groupName} [type={groupDbType}] |
Creates a new channel group using a given name and displays its ID. The optional type parameter can be used to create template groups. For detailed information, see Definitions. |
b_virtualserver_channelgroup_create |
| channelgroupaddperm |
cgid={groupID} [permid={permID}...] |
Adds a set of specified permissions to a channel group. Multiple permissions can be added by providing the two parameters of each permission. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| channelgroupclientlist |
[cid={channelID}] [cldbid={clientDBID}] |
Displays all the client and/or channel IDs currently assigned to channel groups. All three parameters are optional so you're free to choose the most suitable combination for your requirements. |
b_virtualserver_channelgroup_client_list |
| channelgroupcopy |
scgid={sourceGroupID} tsgid={targetGroupID} |
Creates a copy of the channel group specified with scgid. If tcgid is set to 0, the server will create a new group. To overwrite an existing group, simply set tcgid to the ID of a designated target group. If a target group is set, the name parameter will be ignored. The type parameter can be used to create template groups. For detailed information, see Definitions. |
b_virtualserver_channelgroup_create, i_group_modify_power, i_group_needed_modify_power |
| channelgroupdel |
cgid={groupID} force={1|0} |
Deletes a channel group by ID. If force is set to 1, the channel group will be deleted even if there are clients within. |
b_virtualserver_channelgroup_delete |
| channelgroupdelperm |
cgid={groupID} [permid={permID}...] |
Removes a set of specified permissions from the channel group. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| channelgrouppermlist |
cgid={groupID} [-permsid] |
Displays a list of permissions assigned to the channel group specified with cgid. If the -permsid option is specified, the output will contain the permission names instead of the internal IDs. |
b_virtualserver_channelgroup_permission_list |
| channelgrouprename |
cgid={groupID} name={groupName} |
Changes the name of a specified channel group. |
i_group_modify_power, i_group_needed_modify_power |
| channelinfo |
cid={channelID} |
Displays detailed configuration information about a channel including ID, topic, description, etc. For detailed information, see Channel Properties. |
b_channel_info_view |
| channellist |
[-topic] [-flags] [-voice] [-limits] [-icon] [-secondsempty] |
Displays a list of channels created on a virtual server including their ID, order, name, etc. The output can be modified using several command options. |
b_virtualserver_channel_list |
| channelmove |
cid={channelID} cpid={channelParentID} |
Moves a channel to a new parent channel with the ID cpid. If order is specified, the channel will be sorted right under the channel with the specified ID. If order is set to 0, the channel will be sorted right below the new parent. |
i_channel_min_depth, i_channel_max_depth, b_channel_modify_parent, b_channel_modify_sortorder |
| channelpermlist |
cid={channelID} [-permsid] |
Displays a list of permissions defined for a channel. |
b_virtualserver_channel_permission_list |
| clientaddperm |
cldbid={clientDBID} [permid={permID}...] |
Adds a set of specified permissions to a client. Multiple permissions can be added by providing the three parameters of each permission. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| clientdbdelete |
cldbid={clientDBID} |
Deletes a clients properties from the database. |
b_client_delete_dbproperties |
| clientdbedit |
cldbid={clientDBID} [client_properties...] |
Changes a clients settings using given properties. For detailed information, see Client Properties. |
b_client_modify_dbproperties, b_client_modify_description, b_client_set_talk_power |
| clientdbfind |
pattern={clientName|clientUID} [-uid] |
Displays a list of client database IDs matching a given pattern. You can either search for a clients last known nickname or his unique identity by using the -uid option. The pattern parameter can include regular characters and SQL wildcard characters (e.g. %). |
b_virtualserver_client_dbsearch |
| clientdbinfo |
cldbid={clientDBID} |
Displays detailed database information about a client including unique ID, creation date, etc. |
b_virtualserver_client_dbinfo |
| clientdblist |
[start={offset}] [duration={limit}] [-count] |
Displays a list of client identities known by the server including their database ID, last nickname, etc. |
b_virtualserver_client_dblist |
| clientedit |
clid={clientID} [client_properties...] |
Changes a clients settings using given properties. For detailed information, see Client Properties. |
b_client_modify_description, b_client_set_talk_power |
| clientfind |
pattern={clientName} |
Displays a list of clients matching a given name pattern. |
b_virtualserver_client_search |
| clientgetdbidfromuid |
cluid={clientUID} |
Displays the database ID matching the unique identifier specified by cluid. |
|
| clientgetids |
cluid={clientUID} |
Displays all client IDs matching the unique identifier specified by cluid. |
|
| clientgetnamefromdbid |
cldbid={clientDBID} |
Displays the unique identifier and nickname matching the database ID specified by cldbid. |
|
| clientgetnamefromuid |
cluid={clientUID} |
Displays the database ID and nickname matching the unique identifier specified by cluid. |
|
| clientgetuidfromclid |
clid={clientID} |
Displays the unique identifier matching the clientID specified by clid. |
|
| clientinfo |
clid={clientID} |
Displays detailed configuration information about a client including unique ID, nickname, client version, etc. |
b_client_info_view |
| clientkick |
clid={clientID}... reasonid={4|5} [reasonmsg={text}] |
Kicks one or more clients specified with clid from their currently joined channel or from the server, depending on reasonid. The reasonmsg parameter specifies a text message sent to the kicked clients. This parameter is optional and may only have a maximum of 40 characters. For detailed information, see Definitions. |
i_client_kick_from_server_power, i_client_kick_from_channel_power, i_client_needed_kick_from_server_power, i_client_needed_kick_from_channel_power |
| clientlist |
[-uid] [-away] [-voice] [-times] [-groups] [-info] [-country] |
Displays a list of clients online on a virtual server including their ID, nickname, status flags, etc. The output can be modified using several command options. Please note that the output will only contain clients which are currently in channels you're able to subscribe to. |
b_virtualserver_client_list, i_channel_subscribe_power, i_channel_needed_subscribe_power |
| clientmove |
clid={clientID}... cid={channelID} [cpw={channelPassword}] |
Moves one or more clients specified with clid to the channel with ID cid. If the target channel has a password, it needs to be specified with cpw. If the channel has no password, the parameter can be omitted. |
i_client_move_power, i_client_needed_move_power |
| clientpermlist |
cldbid={clientDBID} [-permsid] |
Displays a list of permissions defined for a client. |
b_virtualserver_client_permission_list |
| clientpoke |
clid={clientID} msg={text} |
Sends a poke message to the client specified with clid. |
i_client_poke_power, i_client_needed_poke_power |
| clientsetserverquerylogin |
client_login_name={username} |
Updates your own ServerQuery login credentials using a specified username. The password will be auto-generated. |
b_client_create_modify_serverquery_login |
| clientupdate |
[client_properties...] |
Change your ServerQuery clients settings using given properties. For detailed information, see Client Properties. |
|
| complainadd |
tcldbid={targetClientDBID} message={text} |
Submits a complaint about a connected client with database ID tcldbid to the server. |
i_client_complain_power, i_client_needed_complain_power |
| complaindel |
tcldbid={targetClientDBID} fcldbid={fromClientDBID} |
Deletes the complaint about the client with ID tcldbid submitted by the client with ID fcldbid from the server. |
b_client_complain_delete, b_client_complain_delete_own |
| complaindelall |
tcldbid={targetClientDBID} |
Deletes all complaints about the client with database ID tcldbid from the server. |
b_client_complain_delete |
| complainlist |
[tcldbid={targetClientDBID}] |
Displays a list of complaints on the selected virtual server. If tcldbid is specified, only complaints about the targeted client will be shown. |
b_client_complain_list |
| custominfo |
cldbid={clientDBID} |
Displays a list of custom properties for the client specified with cldbid. |
|
| customsearch |
ident={ident} pattern={pattern} |
Searches for custom client properties specified by ident and value. The value parameter can include regular characters and SQL wildcard characters (e.g. %). |
|
| ftcreatedir |
cid={channelID} cpw={channelPassword} dirname={dirPath} |
Creates new directory in a channels file repository. |
i_ft_directory_create_power, i_ft_needed_file_directory_create_power |
| ftdeletefile |
cid={channelID} cpw={channelPassword} name={filePath}... |
Deletes one or more files stored in a channels file repository. |
i_ft_file_delete_power, i_ft_needed_file_delete_power |
| ftgetfileinfo |
cid={channelID} cpw={channelPassword} name={filePath}... |
Displays detailed information about one or more specified files stored in a channels file repository. |
i_ft_file_browse_power, i_ft_needed_file_browse_power |
| ftgetfilelist |
cid={channelID} cpw={channelPassword} path={filePath} |
Displays a list of files and directories stored in the specified channels file repository. |
i_ft_file_browse_power, i_ft_needed_file_browse_power |
| ftinitdownload |
clientftfid={clientFileTransferID} name={filePath} |
Initializes a file transfer download. clientftfid is an arbitrary ID to identify the file transfer on client-side. On success, the server generates a new ftkey which is required to start downloading the file through TeamSpeak 3's file transfer interface. Since version 3.0.13 there is an optional proto parameter. The client can request a protocol version with it. Currently only 0 and 1 are supported which only differ in the way they handle some timings. The server will reply which protocol version it will support. The server will reply with an ip parameter if it determines the filetransfer subsystem is not reachable by the ip that is currently being used for the query connection. |
i_ft_file_download_power, i_ft_needed_file_ download _power, i_ft_quota_mb_ download _per_client |
| ftinitupload |
clientftfid={clientFileTransferID} name={filePath} |
Initializes a file transfer upload. clientftfid is an arbitrary ID to identify the file transfer on client-side. On success, the server generates a new ftkey which is required to start uploading the file through TeamSpeak 3's file transfer interface. Since version 3.0.13 there is an optional proto parameter. The client can request a protocol version with it. Currently only 0 and 1 are supported which only differ in the way they handle some timings. The server will reply which protocol version it will support. The server will reply with an ip parameter if it determines the filetransfer subsystem is not reachable by the ip that is currently being used for the query connection. |
i_ft_file_upload_power, i_ft_needed_file_ upload _power, i_ft_quota_mb_upload_per_client |
| ftrenamefile |
cid={channelID} cpw={channelPassword} |
Renames a file in a channels file repository. If the two parameters tcid and tcpw are specified, the file will be moved into another channels file repository. |
i_ft_file_rename_power, i_ft_needed_file_rename_power |
| ftstop |
serverftfid={serverFileTransferID} delete={1|0} |
Stops the running file transfer with server-side ID serverftfid. |
|
| gm |
msg={text} |
Sends a text message to all clients on all virtual servers in the TeamSpeak 3 Server instance. |
b_serverinstance_textmessage_send |
| instanceedit |
[instance_properties...] |
Changes the server instance configuration using given properties. For detailed information, see Server Instance Properties. |
b_serverinstance_modify_settings |
| logadd |
loglevel={1-4} logmsg={text} |
Writes a custom entry into the servers log. Depending on your permissions, you'll be able to add entries into the server instance log and/or your virtual servers log. The loglevel parameter specifies the type of the entry. For detailed information, see Definitions. |
b_serverinstance_log_add, b_virtualserver_log_add |
| login |
client_login_name={username} client_login_password={password} |
Authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials. |
b_serverquery_login |
| logview |
[lines={1-100}] [reverse={1|0}] [instance={1|0}] [begin_pos={n}] |
Displays a specified number of entries from the servers log. If instance is set to 1, the server will return lines from the master logfile (ts3server_0.log) instead of the selected virtual server logfile. |
b_serverinstance_log_view, b_virtualserver_log_view |
| messageadd |
cluid={clientUID} subject={subject} message={text} |
Sends an offline message to the client specified by cluid. |
|
| messagedel |
msgid={messageID} |
Deletes an existing offline message with ID msgid from your inbox. |
|
| messageget |
msgid={messageID} |
Displays an existing offline message with ID msgid from your inbox. Please note that this does not automatically set the flag_read property of the message. |
|
| messageupdateflag |
msgid={messageID} flag={1|0} |
Updates the flag_read property of the offline message specified with msgid. If flag is set to 1, the message will be marked as read. |
|
| permfind |
[permid={permID}...] [permsid={permName}...] |
Displays detailed information about all assignments of the permission specified with permid. The output is similar to permoverview which includes the type and the ID of the client, channel or group associated with the permission. A permission can be specified by permid or permsid. |
b_virtualserver_permission_find, b_serverinstance_permission_find |
| permget |
permid={permID}|permid={permID} |
Displays the current value of the permission specified with permid or permsid for your own connection. This can be useful when you need to check your own privileges. |
b_client_permissionoverview_own |
| permidgetbyname |
permsid={permName}... |
Displays the database ID of one or more permissions specified by permsid. |
b_serverinstance_permission_list |
| permoverview |
cid={channelID} cldbid={clientDBID} [permid={permID}...] |
Displays all permissions assigned to a client for the channel specified with cid. If permid is set to 0, all permissions will be displayed. A permission can be specified by permid or permsid. |
b_client_permissionoverview_view |
| privilegekeyadd |
tokentype={1|0} tokenid1={groupID} tokenid2={channelID} |
Create a new token. If tokentype is set to 0, the ID specified with tokenid1 will be a server group ID. Otherwise, tokenid1 is used as a channel group ID and you need to provide a valid channel ID using tokenid2. The tokencustomset parameter allows you to specify a set of custom client properties. This feature can be used when generating tokens to combine a website account database with a TeamSpeak user. The syntax of the value needs to be escaped using the ServerQuery escape patterns and has to follow the general syntax of: ident=ident1 value=value1|ident=ident2 value=value2|ident=ident3 value=value3 |
b_virtualserver_token_add, i_group_needed_member_add_power, i_group_member_add_power |
| privilegekeydelete |
token={tokenKey} |
Deletes an existing token matching the token key specified with token. |
b_virtualserver_token_delete |
| privilegekeyuse |
token={tokenKey} |
Use a token key gain access to a server or channel group. Please note that the server will automatically delete the token after it has been used. |
b_virtualserver_token_use |
| sendtextmessage |
targetmode={1-3} target={clientID} msg={text} |
Sends a text message to a specified target. If targetmode is set to 1, a message is sent to the client with the ID specified by target. If targetmode is set to 2 or 3, the target parameter will be ignored and a message is sent to the current channel or server respectively. |
i_client_private_textmessage_power, i_client_needed_private_textmessage_power, b_client_server_textmessage_send, b_client_channel_textmessage_send |
| servercreate |
virtualserver_name={serverName} |
Creates a new virtual server using the given properties and displays its ID, port and initial administrator privilege key. If virtualserver_port is not specified, the server will test for the first unused UDP port. The first virtual server will be running on UDP port 9987 by default. Subsequently started virtual servers will be running on increasing UDP port numbers. For detailed information, see Virtual Server Properties. |
b_virtualserver_create |
| serverdelete |
sid={serverID} |
Deletes the virtual server specified with sid. Please note that only virtual servers in stopped state can be deleted. |
b_virtualserver_delete |
| serveredit |
[virtualserver_properties...] |
Changes the selected virtual servers configuration using given properties. Note that this command accepts multiple properties which means that you're able to change all settings of the selected virtual server at once. For detailed information, see Virtual Server Properties. |
b_virtualserver_modify_name, b_virtualserver_modify_welcomemessage, b_virtualserver_modify_maxclients, b_virtualserver_modify_reserved_slots, b_virtualserver_modify_password, b_virtualserver_modify_default_servergroup, b_virtualserver_modify_default_channelgroup, b_virtualserver_modify_default_channeladmingroup, b_virtualserver_modify_ft_settings, b_virtualserver_modify_ft_quotas, b_virtualserver_modify_channel_forced_silence, b_virtualserver_modify_complain, b_virtualserver_modify_antiflood, b_virtualserver_modify_hostmessage, b_virtualserver_modify_hostbanner, b_virtualserver_modify_hostbutton, b_virtualserver_modify_port, b_virtualserver_modify_autostart, b_virtualserver_modify_needed_identity_security_level, b_virtualserver_modify_priority_speaker_dimm_modificator, b_virtualserver_modify_log_settings, b_virtualserver_modify_icon_id, b_virtualserver_modify_weblist, b_virtualserver_modify_min_client_version, b_virtualserver_modify_codec_encryption_mode |
| servergroupadd |
name={groupName} [type={groupDbType}] |
Creates a new server group using the name specified with name and displays its ID. The optional type parameter can be used to create ServerQuery groups and template groups. For detailed information, see Definitions. |
b_virtualserver_servergroup_create |
| servergroupaddclient |
sgid={groupID} cldbid={clientDBID} |
Adds a client to the server group specified with sgid. Please note that a client cannot be added to default groups or template groups. |
i_group_member_add_power, i_group_needed_member_add_power |
| servergroupaddperm |
sgid={groupID} [permid={permID}...] |
Adds a set of specified permissions to the server group specified with sgid. Multiple permissions can be added by providing the four parameters of each permission. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| servergroupautoaddperm |
sgtype={groupID} [permid={permID}...] |
Adds a set of specified permissions to *ALL* regular server groups on all virtual servers. The target groups will be identified by the value of their i_group_auto_update_type permission specified with sgtype. Multiple permissions can be added at once. A permission can be specified by permid or permsid. The known values for sgtype are: 10: Channel Guest 15: Server Guest 20: Query Guest 25: Channel Voice 30: Server Normal 35: Channel Operator 40: Channel Admin 45: Server Admin 50: Query Admin |
b_permission_modify_power_ignore |
| servergroupautodelperm |
sgtype={groupID} [permid={permID}...] |
Removes a set of specified permissions from *ALL* regular server groups on all virtual servers. The target groups will be identified by the value of their i_group_auto_update_type permission specified with sgtype. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. The known values for sgtype are: 10: Channel Guest 15: Server Guest 20: Query Guest 25: Channel Voice 30: Server Normal 35: Channel Operator 40: Channel Admin 45: Server Admin 50: Query Admin |
b_permission_modify_power_ignore |
| servergroupclientlist |
sgid={groupID} [-names] |
Displays the IDs of all clients currently residing in the server group specified with sgid. If you're using the optional -names option, the output will also contain the last known nickname and the unique identifier of the clients. |
b_virtualserver_servergroup_client_list |
| servergroupcopy |
ssgid={sourceGroupID} tsgid={targetGroupID} |
Creates a copy of the server group specified with ssgid. If tsgid is set to 0, the server will create a new group. To overwrite an existing group, simply set tsgid to the ID of a designated target group. If a target group is set, the name parameter will be ignored. The type parameter can be used to create ServerQuery groups and template groups. For detailed information, see Definitions. |
b_virtualserver_servergroup_create, i_group_modify_power, i_group_needed_modify_power |
| servergroupdel |
sgid={groupID} force={1|0} |
Deletes the server group specified with sgid. If force is set to 1, the server group will be deleted even if there are clients within. |
b_virtualserver_servergroup_delete |
| servergroupdelclient |
sgid={groupID} cldbid={clientDBID} |
Removes a client specified with cldbid from the server group specified with sgid. |
i_group_member_remove_power, i_group_needed_member_remove_power |
| servergroupdelperm |
sgid={groupID} [permid={permID}...] |
Removes a set of specified permissions from the server group specified with sgid. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. |
i_group_modify_power, i_group_needed_modify_power, i_permission_modify_power |
| servergrouppermlist |
sgid={groupID} [-permsid] |
Displays a list of permissions assigned to the server group specified with sgid. If the -permsid option is specified, the output will contain the permission names instead of the internal IDs. |
b_virtualserver_servergroup_permission_list |
| servergrouprename |
sgid={groupID} name={groupName} |
Changes the name of the server group specified with sgid. |
i_group_modify_power, i_group_needed_modify_power |
| servergroupsbyclientid |
cldbid={clientDBID} |
Displays all server groups the client specified with cldbid is currently residing in. |
|
| serveridgetbyport |
virtualserver_port={serverPort} |
Displays the database ID of the virtual server running on the UDP port specified by virtualserver_port. |
b_serverinstance_virtualserver_list |
| serverlist |
[-uid] [-short] [-all] [-onlyoffline] |
Displays a list of virtual servers including their ID, status, number of clients online, etc. If you're using the -all option, the server will list all virtual servers stored in the database. This can be useful when multiple server instances with different machine IDs are using the same database. The machine ID is used to identify the server instance a virtual server is associated with. The status of a virtual server can be either online, offline, booting up, shutting down or virtual online. While most of them are self-explanatory, virtual online is a bit more complicated. Whenever you select a virtual server which is currently stopped with the -virtual parameter, it will be started in virtual mode which means you are able to change its configuration, create channels or change permissions, but no regular TeamSpeak 3 Client can connect. As soon as the last ServerQuery client deselects the virtual server, its status will be changed back to offline. |
b_serverinstance_virtualserver_list |
| serversnapshotdeploy |
[-mapping] virtualserver_snapshot |
Restores the selected virtual servers configuration using the data from a previously created server snapshot. Please note that the TeamSpeak 3 Server does NOT check for necessary permissions while deploying a snapshot so the command could be abused to gain additional privileges. |
b_virtualserver_snapshot_deploy |
| serverstart |
sid={serverID} |
Starts the virtual server specified with sid. Depending on your permissions, you're able to start either your own virtual server only or all virtual servers in the server instance. |
b_virtualserver_start_any, b_virtualserver_start |
| serverstop |
sid={serverID} |
Stops the virtual server specified with sid. Depending on your permissions, you're able to stop either your own virtual server only or all virtual servers in the server instance. |
b_virtualserver_stop_any, b_virtualserver_stop |
| servertemppasswordadd |
pw={password} desc={description} |
Sets a new temporary server password specified with pw. The temporary password will be valid for the number of seconds specified with duration. The client connecting with this password will automatically join the channel specified with tcid. If tcid is set to 0, the client will join the default channel. |
b_virtualserver_modify_password |
| servertemppassworddel |
pw={password} |
Deletes the temporary server password specified with pw. |
b_virtualserver_modify_password |
| setclientchannelgroup |
cgid={groupID} cid={channelID} cldbid={clientDBID} |
Sets the channel group of a client to the ID specified with cgid. |
i_group_member_add_power, i_group_needed_member_add_power, i_group_member_remove_power, i_group_needed_member_remove_power |
| tokenadd |
tokentype={1|0} tokenid1={groupID} tokenid2={channelID} |
Alias for privilegekeyadd. |
|
| tokendelete |
token={tokenKey} |
Alias for privilegekeydelete |
|
| tokenuse |
token={tokenKey} |
Alias for privilegekeyuse. |
|
| use |
[sid={serverID}] [port={serverPort}] [-virtual] |
Selects the virtual server specified with sid or port to allow further interaction. The ServerQuery client will appear on the virtual server and acts like a real TeamSpeak 3 Client, except it's unable to send or receive voice data. If your database contains multiple virtual servers using the same UDP port, use will select a random virtual server using the specified port. |
b_virtualserver_select |