Overview
This node allows execution of commands on game servers via the RCON (Remote Console) protocol. It supports sending either a single command or multiple commands sequentially within the same authenticated session. This is useful for automating server management tasks such as querying server status, sending messages to players, or executing administrative commands remotely.
Use Case Examples
- Send a single command like 'list' to get the list of players currently connected to the server.
- Send multiple commands sequentially, for example, sending a message to all players followed by a server status check.
Properties
| Name | Meaning |
|---|---|
| Command Mode | Determines whether to execute a single command or multiple commands sequentially. |
| Command | The RCON command(s) to execute. For single command mode, this is a single command string. For multiple commands mode, this is a multiline string with one command per line. |
| Error Pattern (RegExp) | An optional regular expression pattern. If the response from the server matches this pattern, the node execution will fail, indicating an error in the command execution. |
Output
JSON
command- The single command sent to the server.response- The response from the server for the single command.timestamp- Timestamp when the command was executed.commands- Array of commands sent when multiple commands mode is used.responses- Array of objects containing each command and its corresponding response.totalCommands- Total number of commands executed in multiple commands mode.
Dependencies
- Requires an RCON API credential for authentication to the game server.
Troubleshooting
- If the node fails with an authentication error, verify the RCON credentials (host, port, password) are correct.
- If the node throws an error about an invalid regular expression, check the syntax of the 'Error Pattern (RegExp)' input.
- If the response matches the error pattern, the node will fail and provide the matching response for debugging.
- Ensure the commands are valid for the target game server's RCON interface to avoid 'Unknown command' errors.
Links
- RCON Protocol - General information about the RCON protocol used for remote server management.