Admin Console

Admin Console

The bundled Portal binary reads admin commands from stdin while it runs — no restart required for any of them.

Command	Description
help	List available commands
players	List online players and the server each is connected to
servers	List registered servers, their group, weight, player count, draining and health state
kick <player> [reason]	Disconnect a player
transfer <player> <server>	Transfer a player to another registered server
drain <server> [on|off]	Mark a server as draining (default on) so it stops receiving new players

Embedding in your own transport

If you're embedding Portal as a library, Portal.HandleAdminCommand and Portal.ServeAdminConsole are available directly so you can wire these same commands up to a different transport — for example, an in-game /portal command on a hub server instead of a stdin console.

Related

• drain here does the same thing as the socket API's SetServerDraining packet — see Socket Protocol for the wire-level equivalent backend servers can trigger themselves.
• For programmatic reaction to admin actions (e.g. logging every kick), subscribe to the relevant topic on the Event Bus instead of polling console output.