With RCON (Remote Console) you can manage your server remotely without being in the game yourself – e.g. list, kick or ban players and restart the scenario. Arma Reforger uses the BattlEye RCon protocol for this, which communicates over UDP.
Enable RCON
RCON only starts when an RCON password is set.
-
Open dashboard
Open the dashboard of your server. -
Open settings
Navigate to the Settings. -
Enter RCON password
Enter a password in the RCON Password field. -
Restart the server
Save the setting and restart your server.
RCON credentials
You need three pieces of information to connect:
-
Address
The IP address of your server (without port), e.g.203.0.113.10. -
RCON port
You can find the RCON port in the dashboard in the port overview. The port is assigned by us and cannot be changed. -
Password
The password from the RCON Password field in the Settings.
Set RCON permissions
On your server, RCON is set to the monitor permission by default. This only lets you run commands that do not change the server's state, e.g. #players. If you also want to kick or ban players over RCON, change the permission to admin.
| Permission | Description |
|---|---|
admin |
Can run any command |
monitor |
Can only run commands that do not change the server's state |
-
Stop the server
Stop your server via the dashboard. -
Connect via SFTP
Connect to your server via SFTP. -
Open config.json
Open the fileconfig.jsonin the root directory of your server and find the"rcon"section. -
Change permission
Change the value of"permission"from"monitor"to"admin":"rcon": { "permission": "admin", "blacklist": [], "whitelist": [] }The snippet only shows the relevant entries. Leave the other entries in the
"rcon"section unchanged. -
Start the server
Save the file and start your server.
Restrict commands with blacklist and whitelist
In the "rcon" section you can also define which commands are allowed over RCON. Both entries are lists of commands and are empty by default. You also edit these entries in config.json via SFTP while your server is stopped.
| Entry | Description |
|---|---|
blacklist |
Commands in this list cannot be run over RCON |
whitelist |
If the list contains commands, only these can be run over RCON |
Number of simultaneous RCON connections
With the optional "maxClients" entry in the "rcon" section you define how many RCON clients may be connected at the same time. Allowed values are 1 to 16, the default is 16. You edit config.json for this the same way as when changing the permission: stop the server, edit the file via SFTP, start the server.
"rcon": {
...
"maxClients": 4
}
Connect with RCON
-
Open RCON tool
Open an RCON tool that supports the BattlEye RCon protocol. -
Enter connection details
Enter the RCON credentials: address, RCON port and password. -
Run commands
Once connected, you can run the commands from the following table.
RCON commands
| Command | Description | admin |
monitor |
|---|---|---|---|
#players |
Lists all players with their player ID | Yes | Yes |
#kick <playerId> |
Kicks a player, who can rejoin afterwards | Yes | No |
#ban create <playerId/identityId> <duration> [reason] |
Bans a player, the duration is given in seconds (0 = permanent) |
Yes | No |
#ban remove <identityId> |
Removes a ban | Yes | No |
#ban list [page] |
Shows the bans with BanID, Player UID and duration, 25 per page over RCON (10 in game) | Yes | No |
#restart |
Restarts the running scenario, players stay connected | Yes | No |
#shutdown |
Shuts down the server and disconnects all players | Yes | No |
@logout |
Logs out the RCON client and frees its slot immediately | Yes | Yes |
The player ID (5 in the examples) is shown by #players. It only works while the player is connected to the server. If the player is no longer online, ban them by their identityId instead.
Examples:
#ban create 5 3600 Teamkilling
#ban create 5 0
#ban list 2
