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


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

FormatDescription
--proxyservicenameService name for the Proxy

  • --agentpassword

    Command-Line Format--agentpassword
    Permitted ValuesTypestring

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

  • --createBackup

    Command-Line Format--createBackup
    Permitted ValuesTypeboolean
    Default1

    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 ValuesTypeboolean
    Default1

    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 ValuesTypestring
    Defaultagent

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

  • --checkmysqlhost

    Command-Line Format--checkmysqlhost
    Permitted ValuesTypestring
    Defaultyes
    Valid Valuesyes (Check host)
    no (Do not check host)

    Validate the MySQL hostname or IP address

  • --debuglevel

    Command-Line Format--debuglevel
    Permitted ValuesTypenumeric
    Default2
    Min Value0
    Max Value4

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

  • --debugtrace

    Command-Line Format--debugtrace
    Permitted ValuesTypestring

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

  • --installdir

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

    Specify the directory into which to install the software.

  • --installer-language

    Command-Line Format--installer-language
    Permitted ValuesTypestring
    Defaulten
    Valid Valuesen (English)
    ja (Japanese)

    Set the language to use for the installation process.

  • --managerhost

    Command-Line Format--managerhost
    Permitted ValuesTypestring

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

  • --managerport

    Command-Line Format--managerport
    Permitted ValuesTypenumeric
    Default18443

    Tomcat SSL Port

  • --mode

    Command-Line Format--mode
    Permitted Values (Linux)Typestring
    Defaultgtk
    Valid Valuesgtk (GTK (X Windows))
    xwindow (X Windows (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
    Permitted Values (OS X)Typestring
    Defaultosx
    Valid Valuesosx (Mac OS X (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
    Permitted Values (Unix)Typestring
    Defaultxwindow
    Valid Valuesxwindow (X Windows (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
    Permitted Values (Windows)Typestring
    Defaultwin32
    Valid Valueswin32 (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 ValuesTypestring
    Defaulttcpip
    Valid Valuestcpip (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 ValuesTypestring
    Default127.0.0.1

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

  • --mysqlpassword

    Command-Line Format--mysqlpassword
    Permitted ValuesTypestring

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

  • --mysqlport

    Command-Line Format--mysqlport
    Permitted ValuesTypenumeric
    Default3306

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

  • --mysqlsocket

    Command-Line Format--mysqlsocket
    Permitted ValuesTypestring

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

  • --mysqluser

    Command-Line Format--mysqluser
    Permitted ValuesTypestring

    An MySQL Server administrative user for the MySQL instance that will be monitored. This user must already exist.

  • --agent_autocreate

    Command-Line Format--agent_autocreate
    Permitted ValuesTypeboolean

    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 ValuesTypestring

    The username for the general user.

  • --generalpassword

    Command-Line Format--generalpassword
    Permitted ValuesTypestring

    Password for the --generaluser.

  • --limiteduser

    Command-Line Format--limiteduser
    Permitted ValuesTypestring

    The username for the limited user.

  • --limitedpassword

    Command-Line Format--limitedpassword
    Permitted ValuesTypestring

    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 ValuesTypestring
    Defaultnone
    Valid Valuesnone (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
    Permitted ValuesTypestring
    Defaultdatabase

    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

    Command-Line Format--ignore-old-proxy-aggr
    Permitted ValuesTypeboolean
    Default0

    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 ValuesTypestring

    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)Typestring
    Defaultmysql-monitor-agent
    Permitted Values (OS X)Typestring
    Defaultmysql.monitor.agent
    Permitted Values (Unix)Typestring
    Defaultmysql-monitor-agent
    Permitted Values (Windows)Typestring
    DefaultMySQL 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.