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

FormatDescription
--agent-uuid=uuidSet the agent's UUID; needed only when running multiple agent processes on the same host.
--basedir=dirnameDirectory to use as prefix for relative paths in the configuration
--bootstrapBootstrap a default cluster on startup.
--daemonRun in daemon mode.
--defaults-file=fileConfiguration file to use
--event-threads=#Number of event handler threads to use.
--helpShow application options.
--help-allShow all options (application options and manager module options).
--help-managerShow manager module options.
--keepaliveTry to restart mcmd in the event of a crash.
--log-backtrace-on-crashAttempt to load debugger in case of a crash.
--log-file=fileName of the file to write the log to.
--log-level=levelSet the cluster logging level.
--log-use-syslogLog to syslog.
--manager-directory=dirDirectory used for manager data storage.
--manager-password=passwordPassword used for the manager account.
--manager-port=portPort for client to use when connecting to manager.
--manager-username=nameUser account name to run the manager under.
--max-open-files=#Maximum number of open files (ulimit -n).
--pid-file=fileSpecify PID file (used if running as daemon)
--plugin-dir=pathDirectory in which to look for plugins
--plugins=listComma-separated list of plugins to load; must include "manager".
--verbose-shutdownAlways log the exit code when shutting down.
--versionShow the manager version.
--xcom-port=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.