Server console commands - UserXXX/vCom GitHub Wiki
This page gives an overview over the commands the server application supports. Parameters set in [...] are optional. Parameters set in (...) must be present.
Displays help information.
Syntax: help [options]
No options defaults to -l.
| Value | Meaning |
|---|---|
| -list (-l) | Lists all commands, after -l a regular expression for filtering can be used. |
| command name | Lists the help for a specific command. |
Displays lists of users.
Syntax: showusers [option] [filter]
| Value | Meaning |
|---|---|
| -online (-o) | Display online users only. |
| -blacklist (-b) | Displays blacklisted users only. |
| -whitelist (-w) | Displays whitelisted users only. |
| -complete (-c) | Displays the complete available information for each user. |
Combinations of the above options may be used, such as "-online -complete" or "-oc", but oly one of -o, -b or -w.
A regular expression for filtering the list.
Gets the value of a setting and prints it out.
Syntax: get (setting)
The setting. Valid values are:
| Value | Meaning |
|---|---|
| maxfiletranfersize | Maximum file transfer size in KB. |
| maxusers | Maximum number of users that can register on this server. |
| maxonlineusers | Maximum number of users that are allowed to be online simultaneously. |
| maxinboxsize | Maximum size of each users inbox in KB. |
| messagelifetime | Lifetime of messages in days. |
| updatetype | Type of update (autoupdate / prepare only / do not update). |
Sets the value of a setting.
Syntax: set (setting) (new value)
The setting. Valid values are:
| Value | Meaning |
|---|---|
| maxfiletranfersize | Maximum file transfer size in KB. |
| maxusers | Maximum number of users that can register on this server. |
| maxonlineusers | Maximum number of users that are allowed to be online simultaneously. |
| maxinboxsize | Maximum size of each users inbox in KB. |
| messagelifetime | Lifetime of messages in days. |
| updatetype | Type of update (autoupdate / prepare only / do not update). |
Value to set, depends on setting.
Reloads the configuration files (including the schedule).
Syntax: reloadconfig
Modifies the whitelist.
Syntax: whitelist [enabled] [parameters]
One of these values:
| Value | Meaning |
|---|---|
| -enable (-e) | Enables the whitelist. Only one of whitelist and blacklist can be active at the same time. |
| -disable (-d) | Disables the whitelist. |
Can contain multiple of the following actions:
| Command | Meaning |
|---|---|
| <-add / -a> <-name / -n / -id / -i> | Adds an entry to the whitelist. |
| <-remove / -r> <-name / -n / -id / -i> | Removes an entry from the whitelist. |
The parameters are used as follows:
| Parameter | Content of identifier |
|---|---|
| -name (-n) | identifier is a name of a user. |
| -id (-i) | identifier is an user identifier. |
Modifies the blacklist.
Syntax: blacklist [enabled] [parameters]
One of these values:
| Value | Meaning |
|---|---|
| -enable (-e) | Enables the blacklist. Only one of whitelist and blacklist can be active at the same time. |
| -disable (-d) | Disables the whitelist. |
Can contain multiple of the following actions:
| Command | Meaning |
|---|---|
| <-add / -a> <-name / -n / -id / -i> | Adds an entry to the blacklist. |
| <-remove / -r> <-name / -n / -id / -i> | Removes an entry from the blacklist. |
The parameters are used as follows:
| Parameter | Content of identifier |
|---|---|
| -name (-n) | identifier is a name of a user. |
| -id (-i) | identifier is an user identifier. |
Restarts the server.
Syntax: restart
Finishes all actions and shuts the server down.
Syntax: shutdown
Runs a maintenance (may decrease server performance and restart the server).
Syntax: maintenance
Installs a previously downloaded update (if any) or searches for a new update and installs it.
Syntax: update