Sign InTry Free

tiup cluster rename

The cluster name is specified when the cluster is deployed. If you want to change the cluster name after the cluster is deployed, you can use the command tiup cluster rename.


tiup cluster rename <old-cluster-name> <new-cluster-name> [flags]
  • <old-cluster-name>: The old cluster name.
  • <new-cluster-name>: The new cluster name.


-h, --help

  • Prints help information.
  • Data type: BOOLEAN
  • This option is disabled by default with the false value. To enable this option, add this option to the command, and either pass the true value or do not pass any value.


The execution log of the tiup-cluster.

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

Download PDFRequest docs changesAsk questions on TiDB Forum
Was this page helpful?
TiDB Cloud
Get Demo
© 2023 PingCAP. All Rights Reserved.