Skip to main content

Tasks Command

The tasks command is used to manage the configurations of all persistent tasks.

Permission: cloudnet.command.tasks
Aliases: tasks

info

This command can be used as a command in the node console or as a command ingame with the prefix /cloud

This is a basic overview about the tasks command.
Please have a look below for any further information.

COMMAND: - tasks setup
COMMAND: - tasks reload
COMMAND: - tasks list | name=NAME
COMMAND: - tasks create <name> <MINECRAFT_SERVER, GLOWSTONE, NUKKIT, GO_MINT, BUNGEECORD, VELOCITY, WATERDOG>
COMMAND: - tasks delete <name>
COMMAND: - tasks task <name>
COMMAND: - tasks task <name> set minServiceCount <amount>
COMMAND: - tasks task <name> set maintenance <enabled>
COMMAND: - tasks task <name> set maxHeapMemory <memory>
COMMAND: - tasks task <name> set startPort <startPort>
COMMAND: - tasks task <name> set autoDeleteOnStop <autoDeleteOnStop>
COMMAND: - tasks task <name> set staticServices <staticServices>
COMMAND: - tasks task <name> set environment <MINECRAFT_SERVER, GLOWSTONE, NUKKIT, GO_MINT, BUNGEECORD, VELOCITY, WATERDOG>
COMMAND: - tasks task <name> set disableIpRewrite <value>
COMMAND: - tasks task <name> add node <uniqueId>
COMMAND: - tasks task <name> add group <name>
COMMAND: - tasks task <name> remove node <uniqueId>
COMMAND: - tasks task <name> remove group <name>
COMMAND: - tasks task <name> add deployment <storage:prefix/name> [excludedFiles separated by ";"]
COMMAND: - tasks task <name> add template <storage:prefix/name>
COMMAND: - tasks task <name> add inclusion <url> <targetPath>
COMMAND: - tasks task <name> add jvmOption <value> ...
COMMAND: - tasks task <name> add processParameter <value> ...
COMMAND: - tasks task <name> remove deployment <storage:prefix/name>
COMMAND: - tasks task <name> remove template <storage:prefix/name>
COMMAND: - tasks task <name> remove inclusion <url> <targetPath>
COMMAND: - tasks task <name> remove jvmOption <value> ...
COMMAND: - tasks task <name> remove processParameter <value> ...
COMMAND: - tasks task <name> clear jvmOptions

tasks setup#

Usage: tasks setup

This command is used to start an interactive setup for a new task.

Warning

This specific command can only be used in the node console, since it starts an interactive setup which is not possible ingame!

tasks reload#

Usage: tasks reload

This command reloads all task configurations, to apply changes made to the files manually.

tasks list#

Usage: tasks list | name=NAME

This command lists all available tasks on the current node.
The argument | name=NAME is optional and can be omitted. It can be used to filter the output.

tasks create#

Usage: tasks create <name> <MINECRAFT_SERVER, GLOWSTONE, NUKKIT, GO_MINT, BUNGEECORD, VELOCITY, WATERDOG>

This command creates a new task with the given name for the specified software type.

tasks delete#

Usage: tasks delete <name>

This command deletes the task with the given name.

tasks task#

Usage: tasks task <name>

This command prints the configuration of the task with the given name.

tasks task set minServiceCount#

Usage: tasks task <name> set minServiceCount <amount>

This command sets the minServiceCount specified in amount for the task with the given name.

tasks task set maintenance#

Usage: tasks task <name> set maintenance <enabled>

This command enables (true) or disables (false) the maintenance mode of the task with the given name.

tasks task set maxHeapMemory#

Usage: tasks task <name> set maxHeapMemory <memory>

This command sets the max heap memory specified in memory (in MB) for the task with the given name.

tasks task set startPort#

Usage: tasks task <name> set startPort <startPort>

This command sets the start port specified in startPort for the task with the given name.

tasks task set autoDeleteOnStop#

Usage: tasks task <name> set autoDeleteOnStop <autoDeleteOnStop>

This command enables (true) or disables (false) [auto delete on stop](/docs/3.3/components/tasks#autodeleteonstop for the task with the given name.

tasks task set staticServices#

Usage: tasks task <name> set staticServices <staticServices>

This command enables (true) or disables (false) static services for the task with the given name.

tasks task set environment#

Usage: tasks task <name> set environment <MINECRAFT_SERVER, GLOWSTONE, NUKKIT, GO_MINT, BUNGEECORD, VELOCITY, WATERDOG>

This command sets the specified environment for the task with the given name.

tasks task set disableIpRewrite#

Usage: tasks task <name> set disableIpRewrite <value>

This command disables (true) or enables (false) the ip rewrite of the task.

:::Caution Warning We recommend the usage of this feature just in very special cases.
For example, when you want to have several proxies for the Bedrock Edition. (Unfortunately, the Bedrock Edition does not support SRV-Records. Please contact us in that case for further assistance!) :::

tasks task add node#

Usage: tasks task <name> add node <uniqueId>

This command allows the task with the given name to start on the node with the specified uniqueId.

tasks task add group#

Usage: tasks task <name> add group <name>

This command adds the given group to the specified task.

tasks task remove node#

Usage: tasks task <name> remove node <uniqueId>

This command removes the given node from the task specified with name. Therefore, the task will no longer start services on that node.

tasks task remove group#

Usage: tasks task <name> remove group <name>

This command removes the specified group from task with the given name.

tasks task add deployment#

Usage: tasks task <name> add deployment <storage:prefix/name> [excludedFiles separated by ";"]

This command creates a new deployment for the task with the given name. Example: tasks task Lobby add deployment local:Lobby/default [spigot.jar;log.txt]

note

The excluded files can be omitted. In that case, all files are copied.

tasks task add template#

Usage: tasks task <name> add template <storage:prefix/name>

This command adds a new template to the task with the given name.

tasks task add inclusion#

Usage: tasks task <name> add inclusion <url> <targetPath>

This command adds a new inclusion to the task with the given name.
Please refer to the linked site for further information on the arguments.

tasks task add jvmOption#

Usage: tasks task <name> add jvmOption <value> ...

This command adds the given jvm option(s) to the task specified with name.

tasks task add processParameter#

Usage: tasks task <name> add processParameter <value> ...

This command adds the given process parameter(s) to the task specified with name.

tasks task remove deployment#

Usage: tasks task <name> remove deployment <storage:prefix/name>

This command removes the specified deployment from the task with the given name.

tasks task remove template#

Usage: tasks task <name> remove template <storage:prefix/name>

This command removes the specified template from the task with the given name.

tasks task remove inclusion#

Usage: tasks task <name> remove inclusion <url> <targetPath>

This command removes the specified inclusion from the task with the given name.

tasks task remove jvmOption#

Usage: tasks task <name> remove jvmOption <value> ...

This command removes the specified jvm option(s) from the task with the given name.

tasks task remove processParameter#

Usage: tasks task <name> remove processParameter <value> ...

This command removes the specified process parameter(s) from the task with the given name.

tasks task clear jvmOptions#

Usage: tasks task <name> clear jvmOptions

This command removes all jvm options from the task with the given name.

Last updated on