11.1 Service Manager Configuration Utilities

Note

The parameters listed here, with the exception of the four repository connection parameters, correspond to those displayed on the Welcome to MySQL Enterprise Monitor page used for initial setup. For more information, see Section 14.1, “Initial Log-In”.

Important

These parameters enable you to configure MySQL Enterprise Service Manager from script or command line and should only be run while the MySQL Enterprise Service Manager is stopped.

The config.sh / config.bat script is used to configure the MySQL Server Repository for the Service Monitor. Its default location is as follows:

Table 11.1 Default Location of Agent Configuration Utility

Operating System	File Location
Microsoft Windows	C:\Program Files\MySQL\Enterprise\Monitor\bin\config.bat
UNIX/Linux	/opt/mysql/enterprise/monitor/bin/config.sh
macOS	/Applications/mysql/enterprise/monitor/bin/config.sh

Use --help to view the options.

The Service Manager configuration utility contains the following sets of commands:

• Service Manager Configuration Utilities: define or change the configuration of MySQL Enterprise Service Manager.

• Service Manager Certificate Utilities: modify or upgrade MySQL Enterprise Service Manager SSL certificates.

Service Manager Configuration Utilities

The config script enables you to define or change any of the system configuration parameters such as credentials used to connect to the repository, proxy connection details, and MySQL Enterprise Service Manager user credentials.

Table 11.2 Service Manager Configuration Utilities

Name	Description
--mysql-user=<value> --mu=<value>	MySQL username for the Service Manager repository. The password is requested via STDIN when the command is run. The default value is service_manager.
--mysql-port=<value> --mp=<value>	MySQL port for the Service Manager repository. The port the target MySQL server listens on. The default is 13306.
--mysql-db=<value> --md=<value>	MySQL database for the Service Manager repository. The name of the database used for the repository. The default is mem.
--mysql-server=<value> --ms=<value>	MySQL server for the Service Manager repository. This must be a resolvable name or IP address of the server where the MySQL instance is running.
--mysql-check-requirements	Checks your repository to ensure compatibility with MySQL Enterprise Service Manager. For more information on the checks performed, see Section 4.2.4, “MySQL Enterprise Monitor Repository”.
--mysql-upgrade	Runs mysql_upgrade on the repository defined in --mysql-basedir.
--mysql-basedir	Base directory of the local MySQL installation.
--sm-admin-user=<value>	Service Manager manager username. The user defined here is added to the manager role.
--sm-agent-user=<value>	Service Manager agent username. The user defined here is added to the agent role.
--auto-update	Enable automatic checking for online updates.
--purge-quan=<value>	Defines the Query Analyzer data retention policy. Query Analyzer data older than the number of days defined here is deleted. Default is 28 days.
--purge-data=<value>	Defines the historical data retention policy. Historical data older than the number of days defined here is deleted. Default is 28 days.
--proxy-host=<value>	HTTP Proxy host.
--proxy-port=<value>	HTTP Proxy port.
--proxy-user=<value	HTTP Proxy username.

Important

Passwords are always requested via STDIN and are requested in the order manager, agent, and proxy, regardless of the order in which they are defined on the command line or in script.

The following example instructs MySQL Enterprise Service Manager to use a locally installed instance, listening on port 3306, the mem database, and connect using the user service_manager.:

config.sh --mysql-server=localhost --mysql-port=3306 --mysql-db=mem 
          --mysql-user=service_manager

The following is an example of a basic setup, defining the admin and agent users, only. :

config.sh --sm-admin-user=admin --sm-agent-user=agent

All other parameters are set to their default values.

Important

You are prompted to define passwords for each of the users defined. Passwords are only accepted through STDIN.

Passwords are always requested in the order manager, agent, proxy, regardless of the order defined on the command line or in the script.

All other values are set to their defaults.

The following is an example of a complete setup, defining all available options:

config.sh --sm-admin-user=admin --sm-agent-user=agent --purge-quan=7 
          --purge-data=14 --proxy-host=localhost --proxy-port=9190 
          --proxy-user=proxy --auto-update

Service Manager Certificate Utilities

The certificate utilities enable you to modify, renew, import, and upgrade your SSL certificates.

Important

It is strongly recommended you use this utility to modify your SSL certificates and not attempt to modify them with any other tool.

Table 11.3 Service Manager Certificate Utilities

Name	Description
--tomcat-backup-path=<value> --tbp=<value>	Tomcat backup path to be used to perform upgrade
--upgrade --upg	Upgrades certificates on non-OS X platforms. That is, Microsoft Windows, Linux, and so on.
--upgrade-osx --upgo	Upgrades certificates on OS X platforms.
--new-install --ni	Generates a keystore with a new self-signed certificate for a new installation
--accept-keystore-password --akp	If specified, the user is prompted to enter the keystore password. If not specified, the default password changeit is used to access the keystore.
--renew	Renew an existing, self-signed certificate. If the certificate is not self-signed, an error is returned.
--import-certificate=<value>	Imports the specified certificate. For example: --import-certificate=/path/to/client.crt
--import-key=<value>	Imports the specified private key. For example: --import-key=/path/to/client.key