MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.
The MySQL Instance Manager supports a number of command options.
For a brief listing, invoke mysqlmanager with
--help option. Options
may be given on the command line or in the Instance Manager
configuration file. On Windows, the standard configuration file
my.ini in the directory where Instance
Manager is installed. On Unix, the standard file is
/etc/my.cnf. To specify a different
configuration file, start Instance Manager with the
mysqlmanager supports the following options. The options for managing entries in the password file are described further in Section 126.96.36.199, “Instance Manager User and Password Management”.
Display a help message and exit.
Add a new user (specified with the
--usernameoption) to the password file. This option was added in MySQL 5.1.12.
The file in which the angel process records its process ID when mysqlmanager runs in daemon mode (that is, when the
--run-as-serviceoption is given). The default file name is
--angel-pid-fileoption is not given, the default angel PID file has the same name as the PID file except that any PID file extension is replaced with an extension of
.angel.pid. (For example,
This option was added in MySQL 5.1.11.
The IP address to bind to.
Check the validity and consistency of the password file. This option was added in MySQL 5.1.12.
Drop all users from the password file. This option was added in MySQL 5.1.12.
Write a debugging log. A typical
d:t:o,. This option was added in MySQL 5.1.10.
The path name of the MySQL Server binary. This path name is used for all server instance sections in the configuration file for which no
mysqld-pathoption is present. The default value of this option is the compiled-in path name, which depends on how the MySQL distribution was configured. Example:
Read Instance Manager and MySQL Server settings from the given file. All configuration changes made by the Instance Manager will be written to this file. This must be the first option on the command line if it is used, and the file must exist.
If this option is not given, Instance Manager uses its standard configuration file. On Windows, the standard file is
my.iniin the directory where Instance Manager is installed. On Unix, the standard file is
Drop a user (specified with the
--usernameoption) from the password file. This option was added in MySQL 5.1.12.
Change an entry for an existing user (specified with the
--usernameoption) in the password file. This option was added in MySQL 5.1.12.
On Windows, install Instance Manager as a Windows service. The service name is
List the users in the password file. This option was added in MySQL 5.1.12.
The path to the Instance Manager log file. This option has no effect unless the
--run-as-serviceoption is also given. If the file name specified for the option is a relative name, the log file is created under the directory from which Instance Manager is started. To ensure that the file is created in a specific directory, specify it as a full path name.
--run-as-serviceis not given, log messages go to the standard output. To capture log output, you can redirect Instance Manager output to a file:
mysqlmanager > im.log
The interval in seconds for monitoring server instances. The default value is 20 seconds. Instance Manager tries to connect to each monitored (guarded) instance using the nonexisting
MySQL_Instance_Manageruser account to check whether it is available/not hanging. If the result of the connection attempt indicates that the instance is unavailable, Instance Manager performs several attempts to restart the instance.
MySQL_Instance_Manageraccount does not exist, so the connection attempts by Instance Manager cause the monitored instance to produce messages in its general query log similar to the following:
Access denied for user 'MySQL_Instance_M'@'localhost' » (using password: YES)
nonguardedoption in the appropriate server instance section disables monitoring for a particular instance. If the instance dies after being started, Instance Manager will not restart it. Instance Manager tries to connect to a nonguarded instance only when you request the instance's status (for example, with the
See Section 188.8.131.52, “MySQL Server Instance Status Monitoring”, for more information.
Run in a mysqld_safe-compatible manner. For details, see Section 184.108.40.206, “Starting the MySQL Server with MySQL Instance Manager”. This option was added in MySQL 5.1.12.
Specify the password for an entry to be added to or modified in the password file. Unlike the
-Poption for most MySQL programs, the password value is required, not optional. See also Section 220.127.116.11, “Instance Manager User and Password Management”. This option was added in MySQL 5.1.12.
The name of the file where the Instance Manager looks for users and passwords. On Windows, the default is
mysqlmanager.passwdin the directory where Instance Manager is installed. On Unix, the default file is
/etc/mysqlmanager.passwd. See also Section 18.104.22.168, “Instance Manager User and Password Management”.
The process ID file to use. On Windows, the default file is
mysqlmanager.pidin the directory where Instance Manager is installed. On Unix, the default is
mysqlmanager.pidin the data directory.
The port number to use when listening for TCP/IP connections from clients. The default port number (assigned by IANA) is 2273.
Print the current defaults and exit. This must be the first option on the command line if it is used.
Prepare an entry for the password file, print it to the standard output, and exit. You can redirect the output from Instance Manager to a file to save the entry in the file.
Prior to MySQL 5.1.12, this option was named
On Windows, removes Instance Manager as a Windows service. This assumes that Instance Manager has been run with
On Unix, daemonize and start an angel process. The angel process monitors Instance Manager and restarts it if it crashes. (The angel process itself is simple and unlikely to crash.)
On Unix, the socket file to use for incoming connections. The default file is named
/tmp/mysqlmanager.sock. This option has no meaning on Windows.
This option is used on Windows to run Instance Manager in standalone mode. You should specify it when you start Instance Manager from the command line.
On Unix, the user name of the system account to use for starting and running mysqlmanager. This option generates a warning and has no effect unless you start mysqlmanager as
root(so that it can change its effective user ID), or as the named user. It is recommended that you configure mysqlmanager to run using the same account used to run the mysqld server. (“User” in this context refers to a system login account, not a MySQL user listed in the grant tables.)
Specify the user name for an entry to be added to or modified in the password file. This option was added in MySQL 5.1.12.
Display version information and exit.
The number of seconds to wait for activity on an incoming connection before closing it. The default is 28800 seconds (8 hours).
This option was added in MySQL 5.1.7. Before that, the timeout is 30 seconds and cannot be changed.