MySQL :: MySQL 8.0 Reference Manual :: 22.4.26 ndb_setup.py — Start browser-based Auto-Installer for NDB Cluster

5.7
5.6

MySQL 8.0 Reference Manual / ... / ndb_setup.py — Start browser-based Auto-Installer for NDB Cluster

22.4.26 ndb_setup.py — Start browser-based Auto-Installer for NDB Cluster

ndb_setup.py starts the NDB Cluster Auto-Installer and opens the installer's Start page in the default Web browser.

Important

This program is intended to be invoked as a normal user, and not with the mysql, system root or other administrative account.

This section describes usage of and program options for the command-line tool only. For information about using the Auto-Installer GUI that is spawned when ndb_setup.py is invoked, see The NDB Cluster Auto-Installer (NDB 7.5).

Usage

All platforms:

ndb_setup.py [options]

Additionally, on Windows platforms only:

setup.bat [options]

The following table includes all options that are supported by the NDB Cluster installation and configuration program ndb_setup.py. Additional descriptions follow the table.

Table 22.355 Command-line options for the ndb_setup.py program

Format	Description	Added, Deprecated, or Removed
`--browser-start-page=filename`, `-s`	Page that the web browser opens when starting.	All NDB 8.0 releases
`--ca-certs-file=filename`, `-a`	File containing list of client certificates allowed to connect to the server	All NDB 8.0 releases
`--cert-file=filename`, `-c`	File containing X509 certificate that identifies the server. (Default: cfg.pem)	All NDB 8.0 releases
`--debug-level=level`, `-d`	Python logging module debug level. One of DEBUG, INFO, WARNING (default), ERROR, or CRITICAL.	All NDB 8.0 releases
`--help`, `-h`	Print help message	All NDB 8.0 releases
`--key-file=file`, `-k`	Specify file containing private key (if not included in --cert-file)	All NDB 8.0 releases
`--no-browser`, `-n`	Do not open the start page in a browser, merely start the tool	All NDB 8.0 releases
`--port=#`, `-p`	Specify the port used by the web server	All NDB 8.0 releases
`--server-log-file=file`, `o`	Log requests to this file. Use '-' to force logging to stderr instead.	All NDB 8.0 releases
`--server-name=name`, `-N`	The name of the server to connect with	All NDB 8.0 releases
`--use-http`, `-H`	Use unencrypted (HTTP) client/server connection	All NDB 8.0 releases
`--use-https`, `-S`	Use encrypted (HTTPS) client/server connection	All NDB 8.0 releases

--browser-start-page=file, -s

Property Value
Command-Line Format --browser-start-page=filename
Type String
Default Value index.html

Specify the file to open in the browser as the installation and configuration Start page. The default is index.html.
--ca-certs-file=file, -a

Property Value
Command-Line Format --ca-certs-file=filename
Type File name
Default Value [none]

Specify a file containing a list of client certificates which are allowed to connect to the server. The default is an empty string, which means that no client authentication is used.
--cert-file=file, -c

Property Value
Command-Line Format --cert-file=filename
Type File name
Default Value /usr/share/mysql/mcc/cfg.pem

Specify a file containing an X509 certificate which identifies the server. It is possible for the certificate to be self-signed. The default is cfg.pem.
--debug-level=level, -d

Property Value
Command-Line Format --debug-level=level
Type Enumeration
Default Value WARNING
Valid Values
WARNING
DEBUG
INFO
ERROR
CRITICAL

Set the Python logging module debug level. This is one of DEBUG, INFO, WARNING, ERROR, or CRITICAL. WARNING is the default.
--help, -h

Property Value
Command-Line Format --help

Print a help message.
--key-file=file, -d

Property Value
Command-Line Format --key-file=file
Type File name
Default Value [none]

Specify a file containing the private key if this is not included in the X509 certificate file (--cert-file). The default is an empty string, which means that no such file is used.
--no-browser, -n

Property Value
Command-Line Format --no-browser

Start the installation and configuration tool, but do not open the Start page in a browser.
--port=#, -p

Property Value
Command-Line Format --port=#
Type Numeric
Default Value 8081
Minimum Value 1
Maximum Value 65535

Set the port used by the web server. The default is 8081.
--server-log-file=file, -o

Property Value
Command-Line Format --server-log-file=file
Type File name
Default Value ndb_setup.log
Valid Values
ndb_setup.log
- (Log to stderr)

Log requests to this file. The default is ndb_setup.log. To specify logging to stderr, rather than to a file, use a - (dash character) for the file name.
--server-name=host, -N

Property Value
Command-Line Format --server-name=name
Type String
Default Value localhost

Specify the host name or IP address for the browser to use when connecting. The default is localhost.
--use-http, -H

Property Value
Command-Line Format --use-http

Make the browser use HTTP to connect with the server. This means that the connection is unencrypted and not secured in any way.
--use-https, -S

Property Value
Command-Line Format --use-https

Make the browser use a secure (HTTPS) connection with the server.

Property	Value
Command-Line Format	`--browser-start-page=filename`
Type	String
Default Value	`index.html`

Property	Value
Command-Line Format	`--ca-certs-file=filename`
Type	File name
Default Value	`[none]`

Property	Value
Command-Line Format	`--cert-file=filename`
Type	File name
Default Value	`/usr/share/mysql/mcc/cfg.pem`

Property	Value
Command-Line Format	`--debug-level=level`
Type	Enumeration
Default Value	`WARNING`
Valid Values	`WARNING` `DEBUG` `INFO` `ERROR` `CRITICAL`

Property	Value
Command-Line Format	`--help`

Property	Value
Command-Line Format	`--key-file=file`
Type	File name
Default Value	`[none]`

Property	Value
Command-Line Format	`--no-browser`

Property	Value
Command-Line Format	`--port=#`
Type	Numeric
Default Value	`8081`
Minimum Value	`1`
Maximum Value	`65535`

Property	Value
Command-Line Format	`--server-log-file=file`
Type	File name
Default Value	`ndb_setup.log`
Valid Values	`ndb_setup.log` `-` (Log to stderr)

Property	Value
Command-Line Format	`--server-name=name`
Type	String
Default Value	`localhost`

Property	Value
Command-Line Format	`--use-http`

Property	Value
Command-Line Format	`--use-https`

PREV HOME UP NEXT