3.1 mcmd, the MySQL Cluster Manager Agent

mcmd is the MySQL Cluster Manager agent program; invoking this executable starts the MySQL Cluster Manager Agent, to which you can connect using the mcm client (see Section 3.3, “Starting the MySQL Cluster Manager Client”, and Chapter 4, MySQL Cluster Manager Client Commands, for more information).

You can modify the behavior of the agent in a number of different ways by specifying one or more of the options discussed in this sections. Most of these options can be specified either on the command line or in the agent configuration file (normally etc/mcmd.ini). (Some exceptions include the --defaults-file and --bootstrap options, which, if used, must be specified on the command line, and which are mutually exclusive with one another.) For example, you can set the agent's cluster logging level to warning instead than the default message in either one of the following two ways:

The following table contains a summary of agent options that are read on startup by mcmd. More detailed information about each of these options, such as allowed range of values, can be found in the list following the table.

Table 3.1 MySQL Cluster Manager Agent (mcmd) Option Summary

FormatOption FileDescription
--agent-uuid=uuidagent-uuidSet the agent's UUID; needed only when running multiple agent processes on the same host.
--basedir=dirnamebasedirDirectory to use as prefix for relative paths in the configuration
--bootstrap Bootstrap a default cluster on startup.
--daemondaemonRun in daemon mode.
--defaults-file=file Configuration file to use
--event-threads=#event-threadsNumber of event handler threads to use.
--help Show application options.
--help-all Show all options (application options and manager module options).
--help-manager Show manager module options.
--keepalivekeepaliveTry to restart mcmd in the event of a crash.
--log-backtrace-on-crashlog-backtrace-on-crashAttempt to load debugger in case of a crash.
--log-file=filelog-fileName of the file to write the log to.
--log-level=levellog-levelSet the cluster logging level.
--log-use-sysloglog-use-syslogLog to syslog.
--manager-directory=dirmanager-directoryDirectory used for manager data storage.
--manager-password=passwordmanager-passwordPassword used for the manager account.
--manager-port=portmanager-portPort for client to use when connecting to manager.
--manager-username=namemanager-usernameUser account name to run the manager under.
--max-open-files=#max-open-filesMaximum number of open files (ulimit -n).
--pid-file=filepid-fileSpecify PID file (used if running as daemon)
--plugin-dir=pathplugin-dirDirectory in which to look for plugins
--plugins=listpluginsComma-separated list of plugins to load; must include "manager".
--verbose-shutdownverbose-shutdownAlways log the exit code when shutting down.
--version Show the manager version.
--xcom-port=portxcom-portSpecify the XCOM port.

MySQL Cluster Manager Agent (mcmd) Option Descriptions

The following list contains descriptions of each startup option available for use with mcmd, including allowed and default values. Options noted as boolean need only be specified in order to take effect; you should not try to set a value for these.