PBUCON
From PunksBusted
Contents |
Introduction
A number of games have built in RCON (Remote CONsole) systems that allow admins to run commands remotely on the game server without needing to be at the server's actual console. Because of the varying RCON systems, plus a growing number of games that have non-existent or poor RCON systems, Even Balance have brought introduced one that is integrated into PunkBuster itself.
UCON is now available in all supported games, from Saturday 20th May with a set of new server updates. Even Balance are announcing it as an open beta test and so there may still be problems with the system.
Security Considerations
Treat UCON in the same way as standard RCON - users with UCON privilege are able to run any server command, which could modify or shut down the game server. If you wish to give out partial and limited control, you would be advised to look at PB's Power Points ability - see this guide for more information.
Setup Tutorial
Setting up UCON is surprisingly easy. The documentation supplied by Even Balance may look complex, but it only boils down to a few major points to get up and running. You will need access to the PB directory on the server to create and edit files.
Creating pbucon.use
The first step is to create a blank file called pbucon.use - the contents don't matter at all, but it works as a switch to enable or disable UCON from functioning. On Windows:
- Right click in a directory and create a blank text file named pbucon.use
- Upload this file into the PB directory of your server using FTP or your GSP's control panel as normal
 Creating a blank pbucon.use file |
 New pbucon.use file created |
 Transferring pbucon.use over FTP |
Setting up pbsv.cfg
The next step is to add the required entries to your pbsv.cfg config file. The first line to add is:
pb_sv_usessionlimit 1
This defines the maximum number of UCON sessions that can take place simultaneously and should be increased only as required.
The next entries define the usernames and passwords for admins to use. These take the form: pb_sv_uconadd [profile_type] [hostmask] [username] [password]
The profile_type can be one of three values:
- 0 - user can only see PB log entries
- 1 - same as 0, plus can execute any command
- 3 - same as 1, plus user can see game logging (where supported)
The hostmask defines the IP address (or range) that the user can log in from and matches the start of the IP address used.
- To match 192.168.0.0 - 192.168.255.255, use: 192.168.
- To match local addresses only, use: 127.0.0.1:
- To match a specific IP address, use: 213.45.71.130:
Examples pb_sv_uconadd entries are:
- pb_sv_uconadd 3 192.168. username password
- pb_sv_uconadd 1 127.0.0.1: username password
- pb_sv_uconadd 0 213.45.71.130: username password
Once you have added these settings in, save the pbsv.cfg file on the server and then either issue a pb_sv_restart, or restart the game server itself.
Using the client
There are both Windows and Linux clients available currently from Even Balance. They are available for download here:
Run the executable/binary and you are prompted to accept the EULA. If you do, type I Agree at the prompt. Next, you are prompted for the server address/port - enter the game server's IP address and game port.
The next prompt is for the local address/port. It is suspected that this will require a port redirection if you are behind a NAT router - if UCON fails to work, try redirecting the port you pick (UDP) back to your own PC. Type in your public IP address (see whatismyip.com) and a port (say 5555), e.g. 213.45.71.130:5555
Next, you are prompted for your username and password, which were specified in the pbsv.cfg file earlier. The UCON client will list all of the supplied details, leaving you at a prompt saying Console active. By pressing Return, the client will try to connect to the server. If it succeeds, you will see a line that reads Received Server Challenge as illustrated in the screenshot. From here, you can type in PB commands if you have access and see the responses in the client.
Related Links
- Even Balance UCON Page - contains more information on other commands to manage the UCON system
