MySQL Cluster Manager 8.4.2 User Manual


This is the User Manual for the MySQL Cluster Manager, version 8.4.2. It documents the MySQL Cluster Manager Agent and MySQL Cluster Manager Client software applications, which can be used to administer MySQL NDB Cluster, a version of the MySQL Database System (referred to hereafter as MySQL Server or simply MySQL) that incorporates the NDB storage engine for high availability and data redundancy in a distributed computing environment.

This manual applies to MySQL Cluster Manager 8.4.2 and contains information that may not apply to older versions of the MySQL Cluster Manager software. For documentation covering previous MySQL Cluster Manager releases, see MySQL Documentation: MySQL NDB Cluster, on the MySQL website.

MySQL Cluster Manager features.  This manual describes features that may not be included in every version of MySQL Cluster Manager, and such features may not be included in the version of MySQL Cluster Manager licensed to you. If you have any questions about the features included in your version of MySQL Cluster Manager, refer to your MySQL Cluster Manager license agreement or contact your Oracle sales representative.

MySQL Cluster Manager, MySQL Server, and MySQL NDB Cluster features.  This manual contains certain basic information about MySQL Server and MySQL NDB Cluster; however, it is not in any way intended as an exhaustive reference for either of these products.

Current versions of MySQL NDB Cluster compatible with MySQL Cluster Manager are based on versions 8.4, 8.0, and 7.6 of the NDB storage engine; these versions of MySQL NDB Cluster are known as MySQL NDB Cluster 8.4,, MySQL NDB Cluster 8.0, and MySQL NDB Cluster 7.6 respectively. MySQL NDB Cluster functionality varies between MySQL NDB Cluster releases; MySQL Cluster Manager cannot supply or emulate MySQL NDB Cluster features that are not present in the version of the MySQL NDB Cluster software in use.

For complete information about MySQL Server and MySQL NDB Cluster see MySQL NDB Cluster 8.4, MySQL NDB Cluster 8.0, or MySQL NDB Cluster 7.5 and NDB Cluster 7.6.

If you do not have the MySQL Server and MySQL NDB Cluster documentation, you can obtain it free of charge from the MySQL Documentation Library, on the MySQL website.

For notes detailing the changes in each release of MySQL Cluster Manager , see MySQL Cluster Manager 8.4 Release Notes.

For legal information, see the Legal Notices.

For help with using MySQL, please visit the MySQL Forums, where you can discuss your issues with other MySQL users.

Document generated on: 2024-07-23 (revision: 79091)

Table of Contents

Preface and Legal Notices
1 Overview of MySQL Cluster Manager
1.1 MySQL Cluster Manager Terminology
1.2 MySQL Cluster Manager Architecture
1.3 Basic Operational Concepts for MySQL Cluster Manager
1.3.1 Quorum Requirement
1.3.2 Eventual Consistency
2 What Is New in MySQL Cluster Manager 8.4
3 MySQL Cluster Manager Installation, Configuration, Cluster Setup
3.1 Obtaining MySQL Cluster Manager
3.2 Supported Platforms and MySQL NDB Cluster Versions
3.3 MySQL Cluster Manager Installation
3.3.1 Installing MySQL Cluster Manager on Unix-like Platforms
3.3.2 Installing MySQL Cluster Manager on Windows Platforms
3.3.3 Setting the MySQL Cluster Manager Agent User Name and Password
3.4 MySQL Cluster Manager Configuration File
3.5 Upgrading MySQL Cluster Manager
4 Using MySQL Cluster Manager
4.1 mcmd, the MySQL Cluster Manager Agent
4.2 Starting and Stopping the MySQL Cluster Manager Agent
4.2.1 Starting and Stopping the Agent on Linux
4.2.2 Starting and Stopping the MySQL Cluster Manager Agent on Windows
4.3 Starting the MySQL Cluster Manager Client
4.4 Setting Up MySQL NDB Clusters with MySQL Cluster Manager
4.4.1 Creating a MySQL NDB Cluster with MySQL Cluster Manager
4.5 Importing MySQL NDB Clusters into MySQL Cluster Manager
4.5.1 Importing a Cluster Into MySQL Cluster Manager: Basic Procedure
4.5.2 Importing a Cluster Into MySQL Cluster Manager: Example
4.6 MySQL NDB Cluster Backup and Restore Using MySQL Cluster Manager
4.6.1 Requirements for Backup and Restore
4.6.2 Basic MySQL NDB Cluster Backup and Restore Using MySQL Cluster Manager
4.7 Backing Up and Restoring MySQL Cluster Manager Agents
4.8 Restoring a MySQL Cluster Manager Agent with Data from Other Agents
4.9 Setting Up MySQL NDB Cluster Replication with MySQL Cluster Manager
4.10 Using Encrypted Connections for MySQL Cluster Manager Agents and Clients
4.11 Using TLS Connections for NDB Clusters
5 MySQL Cluster Manager Client Commands
5.1 Online Help and Information Commands
5.2 MySQL Cluster Manager Site and Agent Commands
5.2.1 The add hosts Command
5.2.2 The remove hosts Command
5.2.3 The change log-level Command
5.2.4 The rotate log Command
5.2.5 The collect logs Command
5.2.6 The create site Command
5.2.7 The delete site Command
5.2.8 The list sites Command
5.2.9 The list hosts Command
5.2.10 The show settings Command
5.2.11 The stop agents Command
5.2.12 The version Command
5.2.13 The show warnings Command
5.2.14 The list warnings Command
5.3 MySQL Cluster Manager Package Commands
5.3.1 The add package Command
5.3.2 The delete package Command
5.3.3 The list packages Command
5.4 MySQL Cluster Manager Cluster Commands
5.4.1 The create cluster Command
5.4.2 The delete cluster Command
5.4.3 The list clusters Command
5.4.4 The list nextnodeids Command
5.4.5 The restart cluster Command
5.4.6 The show status Command
5.4.7 The start cluster Command
5.4.8 The stop cluster Command
5.4.9 The autotune Command
5.4.10 The upgrade cluster Command
5.5 MySQL Cluster Manager Configuration Commands
5.5.1 The get Command
5.5.2 The reset Command
5.5.3 The set Command
5.5.4 The show variables Command
5.6 MySQL Cluster Manager Process Commands
5.6.1 The add process Command
5.6.2 The change process Command
5.6.3 The list processes Command
5.6.4 The start process Command
5.6.5 The stop process Command
5.6.6 The update process Command
5.6.7 The remove process Command
5.7 MySQL Cluster Manager TLS Connection Commands
5.7.1 The create certs Command
5.8 MySQL Cluster Manager Backup and Restore Commands
5.8.1 The abort backup Command
5.8.2 The backup cluster Command
5.8.3 The list backups Command
5.8.4 The delete backup Command
5.8.5 The restore cluster Command
5.8.6 The backup agents Command
5.9 MySQL Cluster Manager Cluster Importation Commands
5.9.1 The import cluster Command
5.9.2 The import config Command
6 MySQL Cluster Manager Limitations and Known Issues
6.1 MySQL Cluster Manager Usage and Design Limitations
6.2 MySQL Cluster Manager 8.4.2 Limitations Relating to the MySQL Server
6.3 MySQL Cluster Manager Limitations Relating to MySQL NDB Cluster
6.4 Syntax and Related Issues in MySQL Cluster Manager
A Attribute Summary Tables
A.1 Management Node Configuration Parameters
A.2 Data Node Configuration Parameters
A.3 API Node Configuration Parameters
A.4 Other Node Configuration Parameters
A.5 MySQL Server Option and Variable Reference for MySQL Cluster