9.1.3 MySQL Enterprise Monitor Agent Options

To view all the options available for an unattended agent installation, invoke the agent installer file passing in the help option. The available options are detailed in the following table.

Table 9.2 MySQL Enterprise Monitor Agent Installer Options

Option Name	Description
--agent_installtype	Installation type for the agent, which can be database or standalone.
--agent_autocreate	Create an account on the monitored MySQL server to be used by the agent
--agentpassword	Password of the agent user for connecting to the monitored MySQL server
--agentservicename	Service name for the Agent
--agentuser	Username of the agent for connecting to the monitored MySQL server
--checkmysqlhost	Validate the supplied MySQL hostname
--createBackup	(Upgrade only) Create backup.
--debuglevel	Set the debug information level
--debugtrace	File for a debug trace of the installation
--generalpassword	General user password for the --generaluser
--generaluser	General user username for the monitored MySQL server
--help	Display the list of valid options
--installdir	Installation directory
--installer-language	Language selection
--limitedpassword	Limited user password for the --limiteduser
--limiteduser	Limited user username for the monitored MySQL server
--managerhost	Hostname of IP address of the MySQL Enterprise Monitor server
--managerport	TCP/IP port of the MySQL Enterprise Monitor server
--mode	Installation mode
--mysql-identity-source	MySQL instance identify definition
--mysqlconnectiongroup	Sets the group for the provided MySQL connection
--mysqlconnmethod	Connection method to the monitored MySQL server
--mysqlhost	MySQL hostname/IP address
--mysqlpassword	MySQL password for the monitored --mysqluser.
--mysqlport	TCP/IP port for the monitored MySQL server
--mysqlsocket	Unix socket/Named pipe for the monitored MySQL server
--mysqluser	MySQL Administrative username for the monitored MySQL server
--optionfile	Installation option file
--restartImmediately	(Upgrade only) Restart Agent immediately after updating all files.
--unattendedmodeui	Unattended mode user interface
--version	Display the product information

• --agentpassword

  Command-Line Format	--agentpassword
  Type	String

  Specify the agent password to use to communicate with the MySQL Enterprise Service Manager.

• --createBackup

  Command-Line Format	--createBackup
  Type	Boolean
  Default Value	1

  Whether to backup the data.

  Note

  This option is only available when upgrading the Agent, and not when performing a new Agent installation.

• --restartImmediately

  Command-Line Format	--restartImmediately
  Type	Boolean
  Default Value	1

  Restart Agent immediately after updating all files.

  Note

  This option is only available when upgrading the Agent, and not when performing a new Agent installation.

• --agentuser

  Command-Line Format	--agentuser
  Type	String
  Default Value	agent

  Specify the agent username to use to communicate with the MySQL Enterprise Service Manager.

• --checkmysqlhost

  Command-Line Format	--checkmysqlhost
  Type	String
  Default Value	yes
  Valid Values	yes (Check host) no (Do not check host)

  Validate the MySQL hostname or IP address

• --debuglevel

  Command-Line Format	--debuglevel
  Type	Numeric
  Default Value	2
  Minimum Value	0
  Maximum Value	4

  Set the debug information level for log data written to the file specified by debugtrace.

• --debugtrace

  Command-Line Format	--debugtrace
  Type	String

  Set the filename to use when recording debug information during the installation.

• --installdir

  Command-Line Format	--installdir
  Type	String
  Default Value (OS X)	/Applications/mysql/enterprise/agent/
  Default Value (Unix)	/opt/mysql/enterprise/agent/
  Default Value (Windows)	C:\Program Files\MySQL\Enterprise\Agent

  Specify the directory into which to install the software.

• --installer-language

  Command-Line Format	--installer-language
  Type	String
  Default Value	en
  Valid Values	en (English) ja (Japanese)

  Set the language to use for the installation process.

• --managerhost

  Command-Line Format	--managerhost
  Type	String

  The hostname or IP address of MySQL Enterprise Service Manager.

• --managerport

  Command-Line Format	--managerport
  Type	Numeric
  Default Value	18443

  Tomcat SSL Port

• --mode

  Command-Line Format	--mode
  Type	String
  Default Value (Linux)	gtk
  Default Value (OS X)	osx
  Default Value (Unix)	xwindow
  Default Value (Windows)	win32
  Valid Values (Linux)	gtk (GTK (X Windows)) xwindow (X Windows (native)) text (Text (command-line)) unattended (Unattended (no dialogs/prompts))
  Valid Values (OS X)	osx (Mac OS X (native)) text (Text (command-line)) unattended (Unattended (no dialogs/prompts))
  Valid Values (Unix)	xwindow (X Windows (native)) text (Text (command-line)) unattended (Unattended (no dialogs/prompts))
  Valid Values (Windows)	win32 (Windows (native)) unattended (Unattended (no dialogs/prompts))

  Specify the installation mode to use for this installation. The GUI is executed by default, with the possible values including text and unattended. On Linux, the GUI options are gtk (default) and xwindow.

• --mysqlconnmethod

  Command-Line Format	--mysqlconnmethod
  Type	String
  Default Value	tcpip
  Valid Values	tcpip (Use TCP/IP) socket (Use Unix Socket/Named Pipe)

  Specify the connection method to use to connect to MySQL. If you specify tcpip, the value of the mysqlport option is used. If you specify socket, the value of the mysqlsocket option is used to connect to the MySQL server to be monitored.

  Note

  This option is only available when installing the Agent, and not when performing an Agent upgrade.

• --mysqlhost

  Command-Line Format	--mysqlhost
  Type	String
  Default Value	127.0.0.1

  Hostname or IP address of the MySQL server to be monitored.

• --mysqlpassword

  Command-Line Format	--mysqlpassword
  Type	String

  Specify the password to use when connecting the Admin user to the monitored MySQL instance.

• --mysqlport

  Command-Line Format	--mysqlport
  Type	Numeric
  Default Value	3306

  The TCP/IP port to use when connecting to the monitored MySQL server.

• --mysqlsocket

  Command-Line Format	--mysqlsocket
  Type	String

  Specify the filename of the MySQL socket to use when communicating with the monitored MySQL instance.

• --mysqluser

  Command-Line Format	--mysqluser
  Type	String

  An MySQL Server administrative user for the MySQL instance to monitor. This user must already exist.

• --agent_autocreate

  Command-Line Format	--agent_autocreate
  Type	Boolean

  Auto-create the less privileged users (--generaluser and -limiteduser) using the --mysqluser user. Use this option if the limited and general users do not already exist on your system.

  The default value depends on the context. For new installations, it is "1", and for upgrades it is "0".

• --generaluser

  Command-Line Format	--generaluser
  Type	String

  The username for the general user.

• --generalpassword

  Command-Line Format	--generalpassword
  Type	String

  Password for the --generaluser.

• --limiteduser

  Command-Line Format	--limiteduser
  Type	String

  The username for the limited user.

• --limitedpassword

  Command-Line Format	--limitedpassword
  Type	String

  Password for the --limitedpassword.

• --optionfile <optionfile>

  Command-Line Format	--optionfile

  Specify the location of an option file containing the configuration options for this installation.

• --unattendedmodeui

  Command-Line Format	--unattendedmodeui
  Type	String
  Default Value	none
  Valid Values	none (No dialogs) minimal (Critical dialogs) minimalWithDialogs (Minimal UI with dialogs)

  The UI elements to use when performing an unattended installation. The options are none, show no UI elements during the installation; minimal, show minimal elements during installation; minimalWithDialogs, show minimal UI elements, but include the filled-dialog boxes.

• --version

  Command-Line Format	--version

  Display product information, including the version number of the installer.

• --agent_installtype

  Command-Line Format	--agent_installtype
  Type	String
  Default Value	database

  Installation type for the Agent. Passing in standalone configures the Agent to only monitor the Host itself. Passing in database configures the Agent to monitor both the Host and a specific MySQL Instance.

  This option is typically used when setting --mode to unattended.

  Note

  Additional MySQL Instances can be added for monitoring in the future.

• --mysqlconnectiongroup

  Command-Line Format	--mysqlconnectiongroup
  Type	String

  Optionally sets the MySQL instance group for the connection.

  As of 3.0.5, multiple groups can be assigned in a single installation by passing in a comma-separated list of group names.

• --agentservicename

  Command-Line Format	--agentservicename
  Type	String
  Default Value (Linux)	mysql-monitor-agent
  Default Value (OS X)	mysql.monitor.agent
  Default Value (Unix)	mysql-monitor-agent
  Default Value (Windows)	MySQL Enterprise Monitor Agent

  When MySQL Enterprise Monitor Agent is installed, a new service is created (Windows), or on Unix or OS X a new startup script is created within the corresponding startup directory (for example /etc/init.d on Unix or /Library/LaunchDaemons on OS X). When installing multiple agents on the same host, you can use this option to create each agent installation with a unique identifier. During an upgrade installation, you then use this identifier to specify which installation of the agent to update.

  The default value is mysql-monitor-agent.

  Note

  This option is only available when installing the Agent, and not when performing an Agent upgrade.

• --help

  Command-Line Format	--help

  Display the list of valid options to the installer.