NDB_MGM(1)

NAME
ndb_mgm - the NDB Cluster management client

SYNOPSIS

ndb_mgm options

DESCRIPTION

The ndb_mgm management client process is actually not needed to run the cluster. Its value lies in providing a set of commands for checking the cluster's status, starting backups, and performing other administrative functions. The management client accesses the management server using a C API. Advanced users can also employ this API for programming dedicated management processes to perform tasks similar to those performed by ndb_mgm.

To start the management client, it is necessary to supply the host name and port number of the management server:

    shell> ndb_mgm [host_name [port_num]]

For example:

    shell> ndb_mgm ndb_mgmd.mysql.com 1186

The default host name and port number are localhost and 1186, respectively.

The following table includes options that are specific to the NDB Cluster management client program ndb_mgm. Additional descriptions follow the table. For options common to most NDB Cluster programs (including ndb_mgm), see Options Common to NDB Cluster Programs(1).

Table 18.21. Command-line options used with the program ndb_mgm
Format | Description | Added, Deprecated, or Removed
--connect-retries=# | Set number of times to retry connection before giving up; 0 means 1 attempt only (and no retries) | ADDED: NDB 7.4.9
--execute=name, -e | Execute command and exit | (Supported in all NDB releases based on MySQL 5.6)
--try-reconnect=#, -t | Set number of times to retry connection before giving up; synonym for --connect-retries | DEPRECATED: NDB 7.4.9

    • --connect-retries=#
    Command-Line Format | --connect-retries=#
    Introduced | 5.6.28-ndb-7.4.9
    Type | Numeric
    Default Value | 3
    Minimum Value | 0
    Maximum Value | 4294967295

    This option specifies the number of times following the first attempt to retry a connection before giving up (the client always tries the connection at least once). The length of time to wait per attempt is set using --connect-retry-delay.

    This option was added in NDB 7.4.9, and is synonymous with the --try-reconnect option, which is now deprecated.

    The default for this option this option differs from its default when used with other NDB programs. See Options Common to NDB Cluster Programs(1), for more information.

    • --execute=command, -e command
    Command-Line Format | --execute=name

    This option can be used to send a command to the NDB Cluster management client from the system shell. For example, either of the following is equivalent to executing SHOW in the management client:

        shell> ndb_mgm -e "SHOW"
        shell> ndb_mgm --execute="SHOW"

    This is analogous to how the --execute or -e option works with the mysql command-line client. See Section 4.2.2.1, “Using Options on the Command Line”.

        Note
        If the management client command to be passed using this option contains any space characters, then the command must be enclosed in quotation marks. Either single or double quotation marks may be used. If the management client command contains no space characters, the quotation marks are optional.

    • --try-reconnect=number
    Command-Line Format | --try-reconnect=#
    Deprecated | 5.6.28-ndb-7.4.9
    Type | Integer
    Default Value | 3
    Minimum Value | 0
    Maximum Value | 4294967295

    If the connection to the management server is broken, the node tries to reconnect to it every 5 seconds until it succeeds. By using this option, it is possible to limit the number of attempts to number before giving up and reporting an error instead.

    This option is deprecated in NDB 7.4.9 and later, and is superseded by --connect-retries.

Additional information about using ndb_mgm can be found in Section 18.5.1, “Commands in the NDB Cluster Management Client”.

COPYRIGHT

Copyright © 1997, 2021, Oracle and/or its affiliates.

This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.

SEE ALSO
For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/.

AUTHOR
Oracle Corporation (http://dev.mysql.com/).