'\" t
.\"     Title: \fBndb_config\fR
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
.\"      Date: 11/04/2013
.\"    Manual: MySQL Database System
.\"    Source: MySQL 5.1
.\"  Language: English
.\"
.TH "\FBNDB_CONFIG\FR" "1" "11/04/2013" "MySQL 5\&.1" "MySQL Database System"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.\" ndb_config
.SH "NAME"
ndb_config \- extract MySQL Cluster configuration information
.SH "SYNOPSIS"
.HP \w'\fBndb_config\ \fR\fB\fIoptions\fR\fR\ 'u
\fBndb_config \fR\fB\fIoptions\fR\fR
.SH "DESCRIPTION"
.PP
This tool extracts current configuration information for data nodes, SQL nodes, and API nodes from one of a number of sources: a MySQL Cluster management node, or its
config\&.ini
or
my\&.cnf
file\&. By default, the management node is the source for the configuration data; to override the default, execute ndb_config with the
\fB\-\-config\-file\fR
or
\fB\-\-mycnf\fR
option\&. Beginning with MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16, it is also possible to use a data node as the source by specifying its node ID using
\fB\-\-config_from_node=\fR\fB\fInode_id\fR\fR\&.
.PP
Beginning with MySQL Cluster NDB 6\&.3\&.25 and MySQL Cluster NDB 7\&.0\&.6,
\fBndb_config\fR
can also provide an offline dump of all configuration parameters which can be used, along with their default, maximum, and minimum values and other information\&. The dump can be produced in either text or XML format; for more information, see the discussion of the
\fB\-\-configinfo\fR
and
\fB\-\-xml\fR
options later in this section)\&.
.PP
Beginning with MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16, you can filter the results by section (DB,
SYSTEM, or
CONNECTIONS) using one of the options
\fB\-\-nodes\fR,
\fB\-\-system\fR, or
\fB\-\-connections\fR\&.
.PP
The following table includes options that are specific to
\fBndb_config\fR\&. Additional descriptions follow the table\&. For options common to most MySQL Cluster programs (including
\fBndb_config\fR), see
Options Common to MySQL Cluster Programs(1)\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&17.15.\ \&ndb_config Options and Variables: MySQL 5.1, MySQL Cluster NDB 6.3-7.1
.TS
allbox tab(:);
lB lB lB.
T{
Format
T}:T{
Description
T}:T{
Added / Removed
T}
.T&
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l.
T{
.PP
--nodes
T}:T{
Print node information (DB section) only\&.
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--connections
T}:T{
Print CONNECTIONS section information only\&. Cannot be used with \-\-nodes
            or \-\-system option\&.
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--query=string,
.PP
-q
T}:T{
One or more query options (attributes)
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--host=name
T}:T{
Specify host
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--type=name
T}:T{
Specify node type
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--nodeid,
.PP
--id
T}:T{
Get configuration of node with this ID
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--fields=string,
.PP
-f
T}:T{
Field separator
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--rows=string,
.PP
-r
T}:T{
Row separator
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--config-file=path
T}:T{
Set the path to config\&.ini file
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
--mycnf
T}:T{
Read configuration data from my\&.cnf file
T}:T{
.PP
All MySQL 5\&.1 based releases
T}
T{
.PP
-c
T}:T{
Short form for \-\-ndb\-connectstring
T}:T{
.PP
ADDED: 5\&.1\&.12
T}
T{
.PP
--configinfo
T}:T{
Dumps information about all NDB configuration parameters in text format
            with default, maximum, and minimum values\&. Use with \-\-xml to
            obtain XML output\&.
T}:T{
.PP
ADDED: NDB 6\&.3\&.25, NDB 7\&.0\&.6
T}
T{
.PP
--configinfo --xml
T}:T{
Use \-\-xml with \-\-configinfo to obtain a dump of all NDB configuration
            parameters in XML format with default, maximum, and minimum
            values\&.
T}:T{
.PP
ADDED: NDB 6\&.3\&.25, NDB 7\&.0\&.6
T}
T{
.PP
--system
T}:T{
Print SYSTEM section information only\&. Cannot be used with \-\-nodes or
            \-\-connections option\&.
T}:T{
.PP
ADDED: NDB 7\&.0\&.27, NDB 7\&.1\&.16
T}
T{
.PP
--config_from_node=#
T}:T{
Obtain configuration data from the node having this ID (must be a data
            node)\&.
T}:T{
.PP
ADDED: NDB 7\&.0\&.27, NDB 7\&.1\&.16
T}
.TE
.sp 1
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: usage option
.\" usage option: ndb_config
\fB\-\-usage\fR,
\fB\-\-help\fR, or
\fB\-?\fR
.TS
allbox tab(:);
l l s s
l l s s
l l s s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-help
T}
T{
\ \&
T}:T{
\-\-usage
T}
T{
\ \&
T}:T{
\-?
T}
.TE
.sp 1
Causes
\fBndb_config\fR
to print a list of available options, and then exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: config_from_node option
.\" config_from_node option: ndb_config
\fB\-\-config_from_node=#\fR
.TS
allbox tab(:);
l l s s
l l s s
l l s s
^ l l s
^ l l s
^ l l s.
T{
\fBIntroduced\fR
T}:T{
5\&.1\&.56\-ndb\-7\&.1\&.16
T}
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-config_from_node=#
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
numeric
T}
:T{
\fBDefault\fR
T}:T{
none
T}
:T{
\fBRange\fR
T}:T{
1 \&.\&. 48
T}
.TE
.sp 1
Obtain the cluster\*(Aqs configuration data from the data node that has this ID\&.
.sp
If the node having this ID is not a data node,
\fBndb_config\fR
fails with an error\&. (To obtain configuration data from the management node instead, simply omit this option\&.)
.sp
\fB\-\-config_from_node\fR
was added in MySQL Cluster NDB 7\&.0\&.27 and MySQL NDB 7\&.1\&.16\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: version option
.\" version option: ndb_config
\fB\-\-version\fR,
\fB\-V\fR
.TS
allbox tab(:);
l l s s
l l s s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-version
T}
T{
\ \&
T}:T{
\-V
T}
.TE
.sp 1
Causes
\fBndb_config\fR
to print a version information string, and then exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: ndb-connectstring option
.\" ndb-connectstring option: ndb_config
\fB\-\-ndb\-connectstring=\fR\fB\fIconnect_string\fR\fR
.TS
allbox tab(:);
l l s s
l l s s
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-ndb\-connectstring=connectstring
T}
T{
\ \&
T}:T{
\-\-connect\-string=connectstring
T}
T{
\ \&
T}:T{
\-c
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
localhost:1186
T}
.TE
.sp 1
Specifies the connection string to use in connecting to the management server\&. The format for the connection string is the same as described in
Section\ \&17.3.2.3, \(lqMySQL Cluster Connection Strings\(rq, and defaults to
localhost:1186\&.
.sp
The use of
\fB\-c\fR
as a short version for this option is supported for
\fBndb_config\fR
beginning with MySQL 5\&.1\&.12\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: config-file option
.\" config-file option: ndb_config
\fB\-\-config\-file=\fR\fB\fIpath\-to\-file\fR\fR
.TS
allbox tab(:);
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-config\-file=path
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
file name
T}
:T{
\fBDefault\fR
T}:T{
T}
.TE
.sp 1
Gives the path to the management server\*(Aqs configuration file (config\&.ini)\&. This may be a relative or absolute path\&. If the management node resides on a different host from the one on which
\fBndb_config\fR
is invoked, then an absolute path must be used\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: mycnf option
.\" mycnf option: ndb_config
\fB\-\-mycnf\fR
.TS
allbox tab(:);
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-mycnf
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
FALSE
T}
.TE
.sp 1
Read configuration data from the
my\&.cnf
file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: query option
.\" query option: ndb_config
\fB\-\-query=\fR\fB\fIquery\-options\fR\fR,
\fB\-q\fR
\fIquery\-options\fR
.TS
allbox tab(:);
l l s s
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-query=string
T}
T{
\ \&
T}:T{
\-q
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
T}
.TE
.sp 1
This is a comma\-delimited list of
query options\(emthat is, a list of one or more node attributes to be returned\&. These include
id
(node ID), type (node type\(emthat is,
ndbd,
mysqld, or
ndb_mgmd), and any configuration parameters whose values are to be obtained\&.
.sp
For example,
.\" ndb_config: query option
.\" query option: ndb_config
\fB\-\-query=id,type,indexmemory,datamemory\fR
returns the node ID, node type,
DataMemory, and
IndexMemory
for each node\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
If a given parameter is not applicable to a certain type of node, than an empty string is returned for the corresponding value\&. See the examples later in this section for more information\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: host option
.\" host option: ndb_config
\fB\-\-host=\fR\fB\fIhostname\fR\fR
.TS
allbox tab(:);
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-host=name
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
T}
.TE
.sp 1
Specifies the host name of the node for which configuration information is to be obtained\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
While the hostname
localhost
usually resolves to the IP address
127\&.0\&.0\&.1, this may not necessarily be true for all operating platforms and configurations\&. This means that it is possible, when
localhost
is used in
config\&.ini, for
\fBndb_config \fR\fB\fB\-\-host=localhost\fR\fR
to fail if
\fBndb_config\fR
is run on a different host where
localhost
resolves to a different address (for example, on some versions of SUSE Linux, this is
127\&.0\&.0\&.2)\&. In general, for best results, you should use numeric IP addresses for all MySQL Cluster configuration values relating to hosts, or verify that all MySQL Cluster hosts handle
localhost
in the same fashion\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: id option
.\" id option: ndb_config
\fB\-\-id=\fR\fB\fInode_id\fR\fR
.sp
.\" ndb_config: nodeid option
.\" nodeid option: ndb_config
\fB\-\-nodeid=\fR\fB\fInode_id\fR\fR
.TS
allbox tab(:);
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-ndb\-nodeid=#
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
numeric
T}
:T{
\fBDefault\fR
T}:T{
0
T}
.TE
.sp 1
Either of these options can be used to specify the node ID of the node for which configuration information is to be obtained\&.
\fB\-\-nodeid\fR
is the preferred form\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: nodes option
.\" nodes option: ndb_config
\fB\-\-nodes\fR
.TS
allbox tab(:);
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-nodes
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
FALSE
T}
.TE
.sp 1
Tells
\fBndb_config\fR
to print information from parameters defined in
DB
sections only\&. Prior to MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16, this option had no affect\&. This option cannot be used together with
\fB\-\-connections\fR
or
\fB\-\-system\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: connections option
.\" connections option: ndb_config
\fB\-\-connections\fR
.TS
allbox tab(:);
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-connections
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
FALSE
T}
.TE
.sp 1
Tells
\fBndb_config\fR
to print
CONNECTIONS
information only\&. This option existed prior to MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16, but had no affect before then\&. This option cannot be used together with
\fB\-\-nodes\fR
or
\fB\-\-system\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: system option
.\" system option: ndb_config
\fB\-\-system\fR
.TS
allbox tab(:);
l l s s
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBIntroduced\fR
T}:T{
5\&.1\&.56\-ndb\-7\&.1\&.16
T}
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-system
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
FALSE
T}
.TE
.sp 1
Tells
\fBndb_config\fR
to print
SYSTEM
information only\&.
.sp
This option was introduced in MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16\&. It cannot be used together with the
\fB\-\-nodes\fR
or
\fB\-\-system\fR
options\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: type option
.\" type option: ndb_config
\fB\-\-type=\fR\fB\fInode_type\fR\fR
.TS
allbox tab(:);
l l s s
l l s s
^ l l s
^ l l s
^ lt l s
^ ^ l s
^ ^ l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-type=name
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
enumeration
T}
:T{
\fBDefault\fR
T}:T{
T}
:T{
\fBValid Values\fR
T}:T{
ndbd
T}
::T{
mysqld
T}
::T{
ndb_mgmd
T}
.TE
.sp 1
Filters results so that only configuration values applying to nodes of the specified
\fInode_type\fR
(ndbd,
mysqld, or
ndb_mgmd) are returned\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: fields option
.\" fields option: ndb_config
\fB\-\-fields=\fR\fB\fIdelimiter\fR\fR,
\fB\-f\fR
\fIdelimiter\fR
.TS
allbox tab(:);
l l s s
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-fields=string
T}
T{
\ \&
T}:T{
\-f
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
T}
.TE
.sp 1
Specifies a
\fIdelimiter\fR
string used to separate the fields in the result\&. The default is
\(lq,\(rq
(the comma character)\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
If the
\fIdelimiter\fR
contains spaces or escapes (such as
\en
for the linefeed character), then it must be quoted\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: rows option
.\" rows option: ndb_config
\fB\-\-rows=\fR\fB\fIseparator\fR\fR,
\fB\-r\fR
\fIseparator\fR
.TS
allbox tab(:);
l l s s
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-rows=string
T}
T{
\ \&
T}:T{
\-r
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
T}
.TE
.sp 1
Specifies a
\fIseparator\fR
string used to separate the rows in the result\&. The default is a space character\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
If the
\fIseparator\fR
contains spaces or escapes (such as
\en
for the linefeed character), then it must be quoted\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_config: configinfo option
.\" configinfo option: ndb_config
\fB\-\-configinfo\fR
.sp
The
\fB\-\-configinfo\fR
option, added in MySQL Cluster NDB 6\&.3\&.25 and MySQL Cluster NDB 7\&.0\&.6, causes
\fBndb_config\fR
to dump a list of each MySQL Cluster configuration parameter supported by the MySQL Cluster distribution of which
\fBndb_config\fR
is a part, including the following information:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A brief description of each parameter\*(Aqs purpose, effects, and usage
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The section of the
config\&.ini
file where the parameter may be used
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The parameter\*(Aqs data type or unit of measurement
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Where applicable, the parameter\*(Aqs default, minimum, and maximum values
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A brief description of the parameter\*(Aqs purpose, effects, and usage
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
MySQL Cluster release version and build information
.RE
.sp
By default, this output is in text format\&. Part of this output is shown here:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBndb_config \-\-configinfo\fR
****** SYSTEM ******
Name (String)
Name of system (NDB Cluster)
MANDATORY
PrimaryMGMNode (Non\-negative Integer)
Node id of Primary ndb_mgmd(MGM) node
Default: 0 (Min: 0, Max: 4294967039)
ConfigGenerationNumber (Non\-negative Integer)
Configuration generation number
Default: 0 (Min: 0, Max: 4294967039)
****** DB ******
MaxNoOfSubscriptions (Non\-negative Integer)
Max no of subscriptions (default 0 == MaxNoOfTables)
Default: 0 (Min: 0, Max: 4294967039)
MaxNoOfSubscribers (Non\-negative Integer)
Max no of subscribers (default 0 == 2 * MaxNoOfTables)
Default: 0 (Min: 0, Max: 4294967039)
\&...
.fi
.if n \{\
.RE
.\}
.sp
.\" ndb_config: xml option
.\" xml option: ndb_config
\fB\-\-configinfo\fR
\fB\-\-xml\fR
.TS
allbox tab(:);
l l s s
l l s s
l l s s
^ l l s
^ l l s.
T{
\fBIntroduced\fR
T}:T{
5\&.1\&.34\-ndb\-7\&.0\&.6
T}
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-configinfo \-\-xml
T}
T{
\ \&
T}:T{
\fBPermitted Values\fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
false
T}
.TE
.sp 1
You can obtain the output of
\fBndb_config\fR
\fB\-\-configinfo\fR
as XML by adding the
\fB\-\-xml\fR
option (like the
\fB\-\-configinfo\fR
option, available beginning with MySQL Cluster NDB 6\&.3\&.25 and MySQL Cluster NDB 7\&.0\&.6)\&. A portion of the resulting output is shown in this example:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBndb_config \-\-configinfo \-\-xml\fR
<configvariables protocolversion="1" ndbversionstring="5\&.1\&.72\-ndb\-7\&.1\&.30"
                    ndbversion="458758" ndbversionmajor="7" ndbversionminor="0"
                    ndbversionbuild="6">
  <section name="SYSTEM">
    <param name="Name" comment="Name of system (NDB Cluster)" type="string"
              mandatory="true"/>
    <param name="PrimaryMGMNode" comment="Node id of Primary ndb_mgmd(MGM) node"
              type="unsigned" default="0" min="0" max="4294967039"/>
    <param name="ConfigGenerationNumber" comment="Configuration generation number"
              type="unsigned" default="0" min="0" max="4294967039"/>
  </section>
  <section name="NDBD">
    <param name="MaxNoOfSubscriptions" 
              comment="Max no of subscriptions (default 0 == MaxNoOfTables)"
              type="unsigned" default="0" min="0" max="4294967039"/>
    <param name="MaxNoOfSubscribers" 
              comment="Max no of subscribers (default 0 == 2 * MaxNoOfTables)"
              type="unsigned" default="0" min="0" max="4294967039"/>
    \&...
  </section>
  \&...
</configvariables>
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
Normally, the XML output produced by
\fBndb_config\fR
\fB\-\-configinfo\fR
\fB\-\-xml\fR
is formatted using one line per element; we have added extra whitespace in the previous example, as well as the next one, for reasons of legibility\&. This should not make any difference to applications using this output, since most XML processors either ignore nonessential whitespace as a matter of course, or can be instructed to do so\&.
.sp .5v
.RE
Beginning with MySQL Cluster NDB 6\&.3\&.29 and MySQL Cluster NDB 7\&.0\&.10, the XML output also indicates when changing a given parameter requires that data nodes be restarted using the
\fB\-\-initial\fR
option\&. This is shown by the presence of an
initial="true"
attribute in the corresponding
<param>
element\&. In addition (also beginning with MySQL Cluster NDB 6\&.3\&.29 and MySQL Cluster NDB 7\&.0\&.10), the restart type (system
or
node) is also shown; if a given parameter requires a system restart, this is indicated by the presence of a
restart="system"
attribute in the corresponding
<param>
element\&. For example, changing the value set for the
Diskless
parameter requires a system initial restart, as shown here (with the
restart
and
initial
attributes highlighted for visibility):
.sp
.if n \{\
.RS 4
.\}
.nf
<param name="Diskless" comment="Run wo/ disk" type="bool" default="false" 
          \fIrestart="system" initial="true"\fR/>
.fi
.if n \{\
.RE
.\}
.sp
Currently, no
initial
attribute is included in the XML output for
<param>
elements corresponding to parameters which do not require initial restarts; in other words,
initial="false"
is the default, and the value
false
should be assumed if the attribute is not present\&. Similarly, the default restart type is
node
(that is, an online or
\(lqrolling\(rq
restart of the cluster), but the
restart
attribute is included only if the restart type is
system
(meaning that all cluster nodes must be shut down at the same time, then restarted)\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBImportant\fR
.ps -1
.br
The
\fB\-\-xml\fR
option can be used only with the
\fB\-\-configinfo\fR
option\&. Using
\fB\-\-xml\fR
without
\fB\-\-configinfo\fR
fails with an error\&.
.sp .5v
.RE
Unlike the options used with this program to obtain current configuration data,
\fB\-\-configinfo\fR
and
\fB\-\-xml\fR
use information obtained from the MySQL Cluster sources when
\fBndb_config\fR
was compiled\&. For this reason, no connection to a running MySQL Cluster or access to a
config\&.ini
or
my\&.cnf
file is required for these two options\&.
.sp
Combining other
\fBndb_config\fR
options (such as
\fB\-\-query\fR
or
\fB\-\-type\fR) with
\fB\-\-configinfo\fR
or
\fB\-\-xml\fR
is not supported\&. Currently, if you attempt to do so, the usual result is that all other options besides
\fB\-\-configinfo\fR
or
\fB\-\-xml\fR
are simply ignored\&.
\fIHowever, this behavior is not guaranteed and is subject to change at any time\fR\&. In addition, since
\fBndb_config\fR, when used with the
\fB\-\-configinfo\fR
option, does not access the MySQL Cluster or read any files, trying to specify additional options such as
\fB\-\-ndb\-connectstring\fR
or
\fB\-\-config\-file\fR
with
\fB\-\-configinfo\fR
serves no purpose\&.
.RE
        Examples
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
To obtain the node ID and type of each node in the cluster:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fB\&./ndb_config \-\-query=id,type \-\-fields=\*(Aq:\*(Aq \-\-rows=\*(Aq\en\*(Aq\fR
1:ndbd
2:ndbd
3:ndbd
4:ndbd
5:ndb_mgmd
6:mysqld
7:mysqld
8:mysqld
9:mysqld
.fi
.if n \{\
.RE
.\}
.sp
In this example, we used the
\fB\-\-fields\fR
options to separate the ID and type of each node with a colon character (:), and the
\fB\-\-rows\fR
options to place the values for each node on a new line in the output\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
To produce a connection string that can be used by data, SQL, and API nodes to connect to the management server:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fB\&./ndb_config \-\-config\-file=usr/local/mysql/cluster\-data/config\&.ini \e 
\-\-query=hostname,portnumber \-\-fields=: \-\-rows=, \-\-type=ndb_mgmd\fR
192\&.168\&.0\&.179:1186
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
This invocation of
\fBndb_config\fR
checks only data nodes (using the
\fB\-\-type\fR
option), and shows the values for each node\*(Aqs ID and host name, as well as the values set for its
DataMemory,
IndexMemory, and
DataDir
parameters:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fB\&./ndb_config \-\-type=ndbd \-\-query=id,host,datamemory,indexmemory,datadir \-f \*(Aq : \*(Aq \-r \*(Aq\en\*(Aq\fR
1 : 192\&.168\&.0\&.193 : 83886080 : 18874368 : /usr/local/mysql/cluster\-data
2 : 192\&.168\&.0\&.112 : 83886080 : 18874368 : /usr/local/mysql/cluster\-data
3 : 192\&.168\&.0\&.176 : 83886080 : 18874368 : /usr/local/mysql/cluster\-data
4 : 192\&.168\&.0\&.119 : 83886080 : 18874368 : /usr/local/mysql/cluster\-data
.fi
.if n \{\
.RE
.\}
.sp
In this example, we used the short options
\fB\-f\fR
and
\fB\-r\fR
for setting the field delimiter and row separator, respectively\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  4." 4.2
.\}
To exclude results from any host except one in particular, use the
\fB\-\-host\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fB\&./ndb_config \-\-host=192\&.168\&.0\&.176 \-f : \-r \*(Aq\en\*(Aq \-q id,type\fR
3:ndbd
5:ndb_mgmd
.fi
.if n \{\
.RE
.\}
.sp
In this example, we also used the short form
\fB\-q\fR
to determine the attributes to be queried\&.
.sp
Similarly, you can limit results to a node with a specific ID using the
\fB\-\-id\fR
or
\fB\-\-nodeid\fR
option\&.
.RE
.SH "COPYRIGHT"
.br
.PP
Copyright \(co 1997, 2013, Oracle and/or its affiliates. All rights reserved.
.PP
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.
.PP
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.
.PP
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/.
.sp
.SH "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/.
.SH AUTHOR
Oracle Corporation (http://dev.mysql.com/).