"Fossies" - the Fresh Open Source Software Archive

Member "refman-8.0-en.man-gpl/ndb_mgm.1" (25 Oct 2021, 16859 Bytes) of package /linux/misc/mysql-refman/mysql-refman-8.0-en.man-gpl.tar.gz:


Caution: As a special service "Fossies" has tried to format the requested manual source page into HTML format but links to other man pages may be missing or even erroneous. Alternatively you can here view or download the uninterpreted manual source code. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

NDB_MGM

NAME
SYNOPSIS
DESCRIPTION
COPYRIGHT
SEE ALSO
AUTHOR

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.

All options that can be used with ndb_mgm are shown in the following table. Additional descriptions follow the table.

Table 23.27. Command−line options used with the program ndb_mgm

−−backup−password−from−stdin[=TRUE|FALSE]

This option enables input of the backup password from the system shell (stdin) when using −−execute "START BACKUP" or similar to create a backup. Use of this option requires use of −−execute as well.

−−character−sets−dir

Directory containing character sets.

−−connect−retries=#

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 is synonymous with the −−try−reconnect option, which is now deprecated.

−−connect−retry−delay

Number of seconds to wait between attempts to contact management server.

−−connect−string

Same as −−ndb−connectstring.

−−core−file

Write core file on error; used in debugging.

−−defaults−extra−file

Read given file after global files are read.

−−defaults−file

Read default options from given file only.

−−defaults−group−suffix

Also read groups with concat(group, suffix).

−−encrypt−backup

When used, this option causes all backups to be encrypted. To make this happen whenever ndb_mgm is run, put the option in the [ndb_mgm] section of the my.cnf file.

−−execute=command, −e command

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.

−−help

Display help text and exit.

−−login−path

Read given path from login file.

−−ndb−connectstring

Set connect string for connecting to ndb_mgmd. Syntax: "[nodeid=id;][host=]hostname[:port]". Overrides entries in NDB_CONNECTSTRING and my.cnf.

−−ndb−nodeid

Set node ID for this node, overriding any ID set by −−ndb−connectstring.

−−ndb−mgmd−host

Same as −−ndb−connectstring.

−−ndb−optimized−node−selection

Enable optimizations for selection of nodes for transactions. Enabled by default; use −−skip−ndb−optimized−node−selection to disable.

−−no−defaults

Do not read default options from any option file other than login file.

−−print−defaults

Print program argument list and exit.

−−try−reconnect=number

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 and subject to removal in a future release. Use −−connect−retries, instead.

−−usage

Display help text and exit; same as −−help.

−−version

Display version information and exit.

Additional information about using ndb_mgm can be found in Section 23.6.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/).