Documentation Home
MySQL Enterprise Monitor 4.0 Manual
Related Documentation Download this Manual

8.1.2 MySQL Enterprise Service Manager Options

The following options let you customize the installation process for MySQL Enterprise Service Manager. MySQL Enterprise Service Manager supports using a bundled MySQL server, or a separate MySQL server provided by the user. To use your own MySQL server, the server must be installed and running before installation. For more information, see Section 3.2.4, “MySQL Enterprise Monitor Repository”.

Table 8.1 MySQL Enterprise Service Manager Installer Options

Option Name Description
--adminpassword Password for the database repository
--adminuser Username for the database repository
--backupdir Backup directory path.
--createDataBackup Backup stored data. Upgrade process only.
--dbhost Hostname or IP address of the MySQL server
--dbname Name of the repository database.
--dbport TCP/IP port for the MySQL server
--debuglevel Set the debug information level
--debugtrace File for a debug trace of the installation
--forceRestart Upgrade only. Restarts the services after the upgrade process completes.
--help Display the list of valid options
--installdir Installation directory
--installer-language Language selection
--mode Installation mode
--mysql_installation_type MySQL server to be used by the MySQL Enterprise Monitor
--optionfile Installation option file
--system_size Defines Tomcat and MySQL repository configuration based on installation size.
--tomcatport Server port for the Tomcat component
--tomcatsslport SSL TCP/IP port for the Tomcat component
--unattendedmodeui Unattended mode user interface
--version Display the product information

  • --help

    Property Value
    Command-Line Format --help

    Display the list of valid installer options.

  • --version

    Property Value
    Command-Line Format --version

    Display product and version information.

  • --backupdir

    Property Value
    Command-Line Format --backupdir
    Type String

    Upgrade only. The backup directory.

  • --createDataBackup

    Property Value
    Command-Line Format --createDataBackup
    Type Boolean
    Default Value 1
    Valid Values

    0 (Do not create data backup)

    1 (Create data backup)

    Upgrade only. Specifies whether the upgrade process should create a backup of the existing data. If --backupdir is not defined, a Backup directory is created in the root of the installation directory.

  • --optionfile

    Property Value
    Command-Line Format --optionfile

    The path to the option file containing the information for the installation.

  • --mode

    Property Value
    Command-Line Format --mode
    Type String
    Default Value (Windows) win32
    Default Value (Unix) xwindow
    Default Value (OS X) osx
    Default Value (Linux) gtk
    Valid Values (Windows)

    win32 (Windows (native))

    unattended (Unattended (no dialogs/prompts))

    Valid Values (Unix)

    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 (Linux)

    gtk (GTK (X Windows))

    xwindow (X Windows (native))

    text (Text (command-line))

    unattended (Unattended (no dialogs/prompts))

    The installation mode to use for this installation.

  • --debugtrace

    Property Value
    Command-Line Format --debugtrace
    Type String

    The filename to use for a debug trace of the installation.

  • --debuglevel

    Property Value
    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.

  • --installer-language

    Property Value
    Command-Line Format --installer-language
    Type String
    Default Value en
    Valid Values

    en (English)

    ja (Japanese)

    The installer language.

  • --installdir

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

    The installation directory for MySQL Enterprise Service Manager, or the previous installation directory when performing an update. Installation only. It is not possible to change the installation directory in an upgrade.

  • --system-size

    Property Value
    Command-Line Format --system_size
    Type String
    Default Value medium
    Valid Values

    small (5 to 10 MySQL Servers monitored from a laptop or low-end server with no more than 4GB of RAM.)

    medium (Up to 100 MySQL Servers monitored from a medium-sized, but shared, server with 4 to 8GB of RAM.)

    large (More than 100 MySQL Servers monitored from a high-end, dedicated server, with more than 8GB RAM.)

    Defines the installation type. This choice sets parameters which suit your installation type. Installation only. It is not possible to change the system size in an upgrade.

  • --tomcatport

    Property Value
    Command-Line Format --tomcatport
    Type Numeric
    Default Value 18080

    The TCP/IP port for MySQL Enterprise Service Manager. This port is used by MySQL Enterprise Monitor Agent and as the port for the interface to the MySQL Enterprise Monitor User Interface. Installation only. It is not possible to change the Tomcat port in an upgrade.

  • --tomcatsslport

    Property Value
    Command-Line Format --tomcatsslport
    Type Numeric
    Default Value 18443

    The TCP/IP port to use for SSL communication to the MySQL Enterprise Service Manager. Installation only. It is not possible to change the Tomcat SSL port in an upgrade.

  • --mysql-identity-source

    Property Value
    Command-Line Format --mysql-identity-source
    Type String
    Default Value default
    Valid Values

    default (Default)

    host_plus_datadir (host_plus_datadir)

    The mechanism used to generate a unique identity for the MySQL instance if one does not already exist. Passing in default uses either the server_uuid variable if present, or generates a random new one. Passing in host_plus_datadir uses a hash of the host identity and the path to the MySQL instance's data directory, to create a unique identity.

    Note

    This option is only available in unattended installation mode.

    Note

    host_plus_datadir is not allowed when the Agent is remote monitoring a MySQL instance, as MySQL Enterprise Monitor is unable to definitively compute a known-unique host identity in this case.

  • --adminuser

    Property Value
    Command-Line Format --adminuser
    Type String
    Default Value service_manager

    The user name to use for connecting to the database repository used by MySQL Enterprise Service Manager. If you install the bundled MySQL server, this user is configured in the new database. If you use an existing MySQL server, specify an existing user with rights to access the database.

    Note

    The repository user name and encrypted password are stored in the config.properties configuration file.

  • --unattendedmodeui

    Property Value
    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.

  • --adminpassword

    Property Value
    Command-Line Format --adminpassword
    Type String

    MySQL Enterprise Service Manager password for connecting to the MySQL database repository.

  • --mysql_installation_type

    Property Value
    Command-Line Format --mysql_installation_type
    Type String
    Default Value bundled
    Valid Values

    bundled (Use the bundled MySQL server)

    existing (Use an existing (user supplied) MySQL server)

    Specifies whether the installer should configure MySQL Enterprise Service Manager to install the bundled MySQL server, or use a MySQL server that you have already installed to store the repository data.

  • --dbport

    Property Value
    Command-Line Format --dbport
    Type Numeric
    Default Value 13306

    The TCP/IP port for the MySQL database used to store MySQL Enterprise Service Manager repository data. If you install the bundled MySQL server, this is the port where the new database listens for connections. If you use an existing MySQL server, specify the port used for connections by that MySQL server.

  • --dbhost

    Property Value
    Command-Line Format --dbhost
    Type String
    Default Value 127.0.0.1

    The hostname for the MySQL database. When installing MySQL Enterprise Service Manager to use an existing MySQL server, this should be the hostname of the server that stores the database repository.

  • --dbname

    Property Value
    Command-Line Format --dbname
    Type String
    Default Value mem

    The name of MySQL Enterprise Service Manager repository.

  • --forceRestart

    Property Value
    Command-Line Format --forceRestart
    Type Boolean
    Default Value 0
    Valid Values

    0 (Do not restart services)

    1 (Restart services)

    Force a restart of MySQL Enterprise Service Manager services.