removeNode

Syntax

removeNode(alias, [force=false])

Details

[Linux Only] Remove compute nodes from a cluster. It can only be executed by an administrator.

Arguments

alias is a STRING scalar or vector indicating the node alias(es).

force (optional) is a BOOL scalar indicating whether to forcibly remove the nodes.

  • false (default): Nodes will only be removed if they are shut down.

  • true: Nodes will be forcibly shut down by the system and then removed. This may cause running tasks on the nodes to terminate.

Examples

Remove a compute node "cnode1". The node must be shut down before removal:

removeNode(alias="cnode1")

Force remove the compute nodes "cnode2" and "cnode3":

removeNode(alias=`cnode2`cnode3, force=true)