MYSQLSERVERINFO                 MySQL Utilities                MYSQLSERVERINFO



NAME
       mysqlserverinfo - Display Common Diagnostic Information from a Server

SYNOPSIS
       mysqlserverinfo [options] db1 [:db2] ...

DESCRIPTION
       This utility displays critical information about a server for use in
       diagnosing problems. The information displayed includes the following:

       o   Server connection information

       o   Server version number

       o   Data directory path name

       o   Base directory path name

       o   Plugin directory path name

       o   Configuration file location and name

       o   Current binary log coordinates (file name and position)

       o   Current relay log coordinates (file name and position)

       This utility can be used to see the diagnostic information for servers
       that are running or offline. If you want to see information about an
       offline server, the utility starts the server in read-only mode. In
       this case, you must specify the --basedir, --datadir, and --start
       options to prevent the utility from starting an offline server
       accidentally. Note: Be sure to consider the ramifications of starting
       an offline server on the error and similar logs. It is best to save
       this information prior to running this utility.

       To specify how to display output, use one of the following values with
       the --format option:

       o   grid (default)

           Display output in grid or table format like that of the mysql
           client command-line tool.

       o   csv

           Display output in comma-separated values format.

       o   tab

           Display output in tab-separated format.

       o   vertical

           Display output in single-column format like that of the \G command
           for the mysql client command-line tool.

       To turn off the headers for grid, csv, or tab display format, specify
       the --no-headers option.

       To see the common default settings for the local server's configuration
       file, use the --show-defaults option. This option reads the
       configuration file on the machine where the utility is run, not the
       machine for the host that the --server option specifies.

       To run the utility against several servers, specify the --server option
       multiple times. In this case, the utility attempts to connect to each
       server and read the information.

       To see the MySQL servers running on the local machine, use the
       --show-servers option. This shows all the servers with their process ID
       and data directory. On Windows, the utility shows only the process ID
       and port.  OPTIONS.PP mysqlserverinfo accepts the following
       command-line options:

       o   --help

           Display a help message and exit.

       o   --license

           Display license information and exit.

       o   --basedir=<basedir>

           The base directory for the server. This option is required for
           starting an offline server.

           Is also used to access server tools, such as my_print_defaults that
           is required to read the login-path values from the login
           configuration file (.mylogin.cnf).

       o   --datadir=<datadir>

           The data directory for the server. This option is required for
           starting an offline server.

       o   --format=<format>, -f<format>

           Specify the output display format. Permitted format values are
           grid, csv, tab, and vertical. The default is grid.

       o   --no-headers, -h

           Do not display column headers. This option applies only for grid,
           csv, and tab output.

       o   --port-range=<start:end>

           The port range to check for finding running servers. This option
           applies only to Windows and is ignored unless --show-servers is
           given. The default range is 3306:3333.

       o   --server=<server>

           Connection information for a server. Use this option multiple times
           to see information for multiple servers.

           To connect to a server, it is necessary to specify connection
           parameters such as user name, host name, password, and either a
           port or socket. MySQL Utilities provides a number of ways to
           provide this information. All of the methods require specifying
           your choice via a command-line option such as --server, --master,
           --slave, etc. The methods include the following in order of most
           secure to least secure.

           o   Use login-paths from your .mylogin.cnf file (encrypted, not
               visible). Example : <login-path>[:<port>][:<socket>]

           o   Use a configuration file (unencrypted, not visible) Note:
               available in release-1.5.0. Example :
               <configuration-file-path>[:<section>]

           o   Specify the data on the command-line (unencrypted, visible).
               Example : <user>[:<passwd>]@<host>[:<port>][:<socket>]


       o   --show-defaults, -d

           Display default settings for mysqld from the local configuration
           file. It uses my_print_defaults to obtain the options.

       o   --show-servers

           Display information about servers running on the local host. The
           utility examines the host process list to determine which servers
           are running.

       o   --ssl-ca

           The path to a file that contains a list of trusted SSL CAs.

       o   --ssl-cert

           The name of the SSL certificate file to use for establishing a
           secure connection.

       o   --ssl-cert

           The name of the SSL key file to use for establishing a secure
           connection.

       o   --ssl

           Specifies if the server connection requires use of SSL. If an
           encrypted connection cannot be established, the connection attempt
           fails. Default setting is 0 (SSL not required).

       o   --start, -s

           Start the server in read-only mode if it is offline. With this
           option, you must also give the --basedir and --datadir options.

       o   --start-timeout

           Number of seconds to wait for the server to be online when started
           in read-only mode using the --start option. The default value is 10
           seconds.

           The --start-timeout option is available as of MySQL Utilities 1.2.4
           / 1.3.3.

       o   --verbose, -v

           Specify how much information to display. Use this option multiple
           times to increase the amount of information. For example, -v =
           verbose, -vv = more verbose, -vvv = debug.

       o   --version

           Display version information and exit.

       For the --format option, the permitted values are not case sensitive.
       In addition, values may be specified as any unambiguous prefix of a
       valid value. For example, --format=g specifies the grid format. An
       error occurs if a prefix matches more than one valid value.

       The path to the MySQL client tools should be included in the PATH
       environment variable in order to use the authentication mechanism with
       login-paths. This will allow the utility to use the my_print_defaults
       tools which is required to read the login-path values from the login
       configuration file (.mylogin.cnf).  EXAMPLES.PP To display the server
       information for the local server and the settings for mysqld in the
       configuration file with the output in a vertical list, use this
       command:

           shell> mysqlserverinfo --server=root:pass@localhost -d --format=vertical
           # Source on localhost: ... connected.
           *************************       1. row *************************
                    server: localhost:3306
                   version: 5.1.50-log
                   datadir: /usr/local/mysql/data/
                   basedir: /usr/local/mysql-5.1.50-osx10.6-x86_64/
                plugin_dir: /usr/local/mysql-5.1.50-osx10.6-x86_64/lib/plugin
               config_file: /etc/my.cnf
                binary_log: my_log.000068
            binary_log_pos: 212383
                 relay_log: None
             relay_log_pos: None
           1 rows.
           Defaults for server localhost:3306
             --port=3306
             --basedir=/usr/local/mysql
             --datadir=/usr/local/mysql/data
             --server_id=5
             --log-bin=my_log
             --general_log
             --slow_query_log
             --innodb_data_file_path=ibdata1:778M;ibdata2:50M:autoextend
           #...done.

       PERMISSIONS REQUIRED.PP The permissions required include the ability to
       read the mysql database and to have read access to the data directory.

       The user must have permissions to read the data directory or use an
       administrator or super user (sudo) account to obtain access to the data
       directory.

COPYRIGHT
       Copyright (C) 2006, 2015, Oracle and/or its affiliates. All rights
       reserved.

       This documentation is free software; you can redistribute it and/or
       modify it only under the terms of the GNU General Public License as
       published by the Free Software Foundation; version 2 of the License.

       This documentation is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
       General Public License for more details.

       You should have received a copy of the GNU General Public License along
       with the program; if not, write to the Free Software Foundation, Inc.,
       51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
       http://www.gnu.org/licenses/.


SEE ALSO
       For more information, please refer to the MySQL Utilities and Fabric
       documentation, which is available online at
       http://dev.mysql.com/doc/index-utils-fabric.html

AUTHOR
       Oracle Corporation (http://dev.mysql.com/).



MySQL 1.5.6                       09/15/2015                   MYSQLSERVERINFO
