Skip navigation links
5.5 Postinstallation Considerations »
Section Navigation      [Toggle]

5.4.3. MySQL Enterprise 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 5.2. MySQL Enterprise Agent Installer Options

Format Option File Description
--agentpassword   Password of the agent user for connecting to the monitored MySQL server
--agentuser   Username of the agent for connecting to the monitored MySQL server
--aggregatorport   TCP/IP port for the Aggregator component
--aggregatorsslcafile   CA certificate file for SSL support in the Aggregator component
--aggregatorsslcertfile   PEM certificate file for SSL support in the Aggregator component
--aggregatorsslport   SSL port for the Aggregator component
--checkmysqlhost   Validate the supplied MySQL hostname
--createaccount   Create an account on the monitored MySQL server to be used by the agent
--debuglevel   Set the debug information level
--debugtrace   File for a debug trace of the installation
--enableagent   Enable the agent to monitor a MySQL server
--enableaggregator   Enable the Aggregator to aggregate Query Analyzer data from an external source
--enableproxy   Enable query analyzer data to be captured using the proxy service
--installdir   Installation directory
--installer-language   Language selection
--managerhost   Hostname of IP address of the MySQL Enterprise Monitor server
--managerport   TCP/IP port of the MySQL Enterprise Monitor server
--managersslport   TCP/IP port of the MySQL Enterprise Monitor server for SSL communication
--mode   Installation mode
--mysqlconnmethod   Connection method to the monitored MySQL server
--mysqlhost   MySQL hostname/IP address
--mysqlpassword   MySQL password for the monitored MySQL server
--mysqlport   TCP/IP port for the monitored MySQL server
--mysqlsocket   Unix socket/Named pipe for the monitored MySQL server
--mysqluser   MySQL username for the monitored MySQL server
--optionfile   Installation option file
--proxyport   TCP/IP port for the Proxy module
--proxyuser   User account for the proxy service
--rootpassword   Password for root user
--rootuser   User with root privileges on the monitored MySQL server
--servicename   Service name
--unattendedmodeui   Unattended mode user interface
--usessl   Enable use of SSL communication with MySQL Enterprise Monitor server
--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.

  • --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.

  • --aggregatorport

    Command-Line Format --aggregatorport
      Permitted Values
    Type numeric
    Default 14000

    Specify the TCP/IP port to use to communicate with the MySQL Enterprise Service Manager. Enter the same TCP/IP port number as in the MySQL Enterprise Service Manager installation.

  • --aggregatorsslcafile

    Command-Line Format --aggregatorsslcafile
      Permitted Values
    Type string

    Specify the path to the CA certificate file for SSL support in the Aggregator component. Only needed when using SSL.

  • --aggregatorsslcertfile

    Command-Line Format --aggregatorsslcertfile
      Permitted Values
    Type string

    Specify the path to the PEM certificate file for SSL support in the Aggregator component. Only needed when using SSL.

  • --aggregatorsslport

    Command-Line Format --aggregatorsslport
      Permitted Values
    Type numeric
    Default 14443

    Specify the SSL port for the Aggregator component to use to communicate with the MySQL Enterprise Service Manager. Enter the same SSL port number as in the MySQL Enterprise Service Manager installation.

  • --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

  • --createaccount

    Command-Line Format --createaccount
      Permitted Values
    Type boolean
    Default 1

    Create the user account specified by the agentuser and agentpassword options to use when the agent connects to the monitored MySQL server. To use this option, you must also specify a suitable root account with privileges to create the new user using the rootuser and rootpassword options.

    The user create will have the correct privileges for the agent to collect all the necessary information. For more information, see Section 5.3.1, “Creating a MySQL User Account for the Monitor Agent”.

  • --debuglevel

    Command-Line Format --debuglevel
      Permitted Values
    Type numeric
    Default 2
    Range 0 .. 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.

  • --enableagent

    Command-Line Format --enableagent
      Permitted Values
    Type boolean
    Default 1

    Enable the agent to monitor a MySQL server. If this option is set to false, the agent is installed without enabling the monitoring of MySQL server. You can use this to configure a proxy service using an agent for collecting Query Analyzer information.

  • --enableaggregator

    Command-Line Format --enableaggregator
      Permitted Values
    Type boolean
    Default 0

    Enable the optional Aggregator component that collects data from certain data sources, such as user-written scripts or instrumented application servers.

  • --enableproxy <enableproxy>

    Command-Line Format --enableproxy
      Permitted Values
    Type boolean
    Default 1

    Enable the Proxy service. The proxy service can be used to collect query data to use through the Query Analyzer. For more information, see Section 3.1.5, “Using the Agent Proxy”.

  • --installdir

    Command-Line Format --installdir
      Permitted Values
    Type (windows) string
    Default C:\Program Files\MySQL\Enterprise\Agent
      Permitted Values
    Type (macosx) string
    Default /Applications/mysql/enterprise/agent/
      Permitted Values
    Type (unix) string
    Default /opt/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 18080

    The port number of the MySQL Enterprise Service Manager.

  • --managersslport

    The port number of the MySQL Enterprise Service Manager to use for SSL-based communication

  • --mode

    Command-Line Format --mode
      Permitted Values
    Type (macosx) string
    Default osx
    Valid Values osx (Mac OS X (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
      Permitted Values
    Type (linux) string
    Default gtk
    Valid Values gtk (GTK (X Windows))
    xwindow (X Windows (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
      Permitted Values
    Type (unix) string
    Default xwindow
    Valid Values xwindow (X Windows (native))
    text (Text (command-line))
    unattended (Unattended (no dialogs/prompts))
      Permitted Values
    Type (windows) string
    Default win32
    Valid Values win32 (Windows (native))
    unattended (Unattended (no dialogs/prompts))

    Specify the installation mode to use for this installation.

  • --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.

  • --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 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

    Specify the username to use when connecting to the monitored MySQL instance.

  • --optionfile <optionfile>

    Command-Line Format --optionfile

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

  • --proxyport

    Command-Line Format --proxyport
      Permitted Values
    Type numeric
    Default 6446

    Specify the TCP/IP port to use for the MySQL Enterprise Agent Proxy Service, if you also specified the --enableproxy option.

  • --proxyuser

    Command-Line Format --proxyuser
      Permitted Values
    Type string
    Default root

    The OS user that the MySQL Enterprise Agent Proxy Service runs as. For example, you can specify a special account such as daemon. Applies to Unix, Linux, and Mac OS X, but not to Windows where the proxy runs as a service. For this option to work, run the installer as root and also specify the --enableproxy option.

  • --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

    Version Introduced 2.3.0
      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 Agent.

  • --usessl

    Command-Line Format --usessl
      Permitted Values
    Type boolean
    Default 0

    Specifies whether SSL should be used to communicate with the MySQL Enterprise Service Manager.

  • --version

    Command-Line Format --version

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

  • --rootpassword

    Command-Line Format --rootpassword
      Permitted Values
    Type string

    The password of a root account for the installer to use to create the agent user.

  • --rootuser

    Command-Line Format --rootuser
      Permitted Values
    Type string
    Default root

    The root account for the installer to use to create the agent user.

  • --servicename

    Command-Line Format --servicename
      Permitted Values
    Type (macosx) string
    Default mysql.monitor.agent
      Permitted Values
    Type (unix) string
    Default mysql-monitor-agent
      Permitted Values
    Type (linux) string
    Default mysql-monitor-agent
      Permitted Values
    Type (windows) string
    Default MySQL Enterprise Monitor Agent

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

  • --help

    Command-Line Format --help

    Display the list of valid options to the installer.

Copyright © 2006, 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices