Doc Menu

tiup dm stop

The tiup dm stop command is used to stop all or part of the services of the specified cluster.

Note:

The cluster cannot provide services after the core service is stopped.

Syntax

tiup dm stop <cluster-name> [flags]

<cluster-name>: the name of the cluster to operate on. If you forget the cluster name, you can check it with the cluster list command.

Options

-N, --node

  • Specifies the nodes to be stopped. If not specified, all nodes are stopped. The value of this option is a comma-separated list of node IDs. You can get the node IDs from the first column of the cluster status table returned by the tiup dm display command.
  • Data type: STRINGS
  • If this option is not specified in the command, all nodes are selected by default.

Note:

If the -R, --role option is specified at the same time, only the service nodes that match both the specifications of -N, --node and -R, --role are stopped.

-R, --role

  • Specifies the roles to be stopped. If not specified, all roles are stopped. The value of this option is a comma-separated list of node roles. You can get the roles of nodes from the second column of the cluster status table returned by the tiup dm display command.
  • Data type: STRINGS
  • If this option is not specified in the command, all roles are selected by default.

Note:

If the -N, --node option is specified at the same time, only the service nodes that match both the specifications of -N, --node and -R, --role are stopped.

-h, --help

  • Prints the help information.
  • Data type: BOOLEAN
  • Default: false

Output

The log of stopping the service.

<< Back to the previous page - TiUP DM command list