Documentation Home
MySQL Enterprise Monitor 3.0 Manual
Related Documentation Download this Manual
PDF (US Ltr) - 5.2Mb
PDF (A4) - 5.2Mb
EPUB - 3.7Mb
HTML Download (TGZ) - 3.6Mb
HTML Download (Zip) - 3.6Mb


8.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 8.2 MySQL Enterprise Monitor Agent Installer Options

Format Description Removed
--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  
--ignore-old-proxy-aggr Whether to ignore the Proxy and Aggregator while executing an upgrade. 3.0.14
--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
    Permitted Values Type string

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

  • --createBackup

    Command-Line Format --createBackup
    Permitted Values Type boolean
    Default 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
    Permitted Values Type boolean
    Default 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
    Permitted Values Type string
    Default agent

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

  • --checkmysqlhost

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

    Validate the MySQL hostname or IP address

  • --debuglevel

    Command-Line Format --debuglevel
    Permitted Values Type numeric
    Default 2
    Min Value 0
    Max Value 4

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

  • --debugtrace

    Command-Line Format --debugtrace
    Permitted Values Type string

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

  • --installdir

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

    Specify the directory into which to install the software.

  • --installer-language

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

    Set the language to use for the installation process.

  • --managerhost

    Command-Line Format --managerhost
    Permitted Values Type string

    The hostname or IP address of the MySQL Enterprise Service Manager.

  • --managerport

    Command-Line Format --managerport
    Permitted Values Type numeric
    Default 18443

    Tomcat SSL Port

  • --mode

    Command-Line Format --mode
    Permitted Values (Linux) Type string
    Default gtk
    Valid Values gtk (GTK (X Windows))
    xwindow (X Windows (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
    Permitted Values (OS X) Type string
    Default osx
    Valid Values osx (Mac OS X (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
    Permitted Values (Unix) Type string
    Default xwindow
    Valid Values xwindow (X Windows (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
    Permitted Values (Windows) Type string
    Default win32
    Valid Values 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
    Permitted Values Type string
    Default 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
    Permitted Values Type string
    Default 127.0.0.1

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

  • --mysqlpassword

    Command-Line Format --mysqlpassword
    Permitted Values Type string

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

  • --mysqlport

    Command-Line Format --mysqlport
    Permitted Values Type numeric
    Default 3306

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

  • --mysqlsocket

    Command-Line Format --mysqlsocket
    Permitted Values Type string

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

  • --mysqluser

    Command-Line Format --mysqluser
    Permitted Values Type string

    The MySQL Server administrative user for the MySQL instance to be monitored. This user must already exist.

  • --agent_autocreate

    Command-Line Format --agent_autocreate
    Permitted Values 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
    Permitted Values Type string

    The username for the general user.

  • --generalpassword

    Command-Line Format --generalpassword
    Permitted Values Type string

    Password for the --generaluser.

  • --limiteduser

    Command-Line Format --limiteduser
    Permitted Values Type string

    The username for the limited user.

  • --limitedpassword

    Command-Line Format --limitedpassword
    Permitted Values 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
    Permitted Values Type string
    Default 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.

  • --use-external-glib

    Removed 3.0.14
    Permitted Values Type string

    Specifies to use the glib library already present on the installation machine, and not to install the one bundled with MySQL Enterprise Monitor Agent.

  • --version

    Command-Line Format --version

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

  • --agent_installtype

    Command-Line Format --agent-installtype
    Permitted Values Type string
    Default 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.

  • --ignore-old-proxy-aggr

    Removed 3.0.14
    Command-Line Format --ignore-old-proxy-aggr
    Permitted Values Type boolean
    Default 0

    Ignores Proxy and Aggregator while running an upgrade.

    Note

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

  • --mysqlconnectiongroup

    Command-Line Format --mysqlconnectiongroup
    Permitted Values 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
    Permitted Values (Linux) Type string
    Default mysql-monitor-agent
    Permitted Values (OS X) Type string
    Default mysql.monitor.agent
    Permitted Values (Unix) Type string
    Default mysql-monitor-agent
    Permitted Values (Windows) Type string
    Default MySQL Enterprise Monitor Agent

    When the 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.


User Comments
Sign Up Login You must be logged in to post a comment.