mysqlserverinfo(1)

1MYSQLSERVERINFO                 MySQL Utilities                MYSQLSERVERINFO
2
3
4

NAME

6       mysqlserverinfo - Display Common Diagnostic Information from a Server
7

SYNOPSIS

9       mysqlserverinfo [options] db1 [:db2] ...
10

DESCRIPTION

12       This utility displays critical information about a server for use in
13       diagnosing problems. The information displayed includes the following:
14
15       ·   Server connection information
16
17       ·   Server version number
18
19       ·   Data directory path name
20
21       ·   Base directory path name
22
23       ·   Plugin directory path name
24
25       ·   Configuration file location and name
26
27       ·   Current binary log coordinates (file name and position)
28
29       ·   Current relay log coordinates (file name and position)
30
31       This utility can be used to see the diagnostic information for servers
32       that are running or offline. If you want to see information about an
33       offline server, the utility starts the server in read-only mode. In
34       this case, you must specify the --basedir, --datadir, and --start
35       options to prevent the utility from starting an offline server
36       accidentally. Note: Be sure to consider the ramifications of starting
37       an offline server on the error and similar logs. It is best to save
38       this information prior to running this utility.
39
40       To specify how to display output, use one of the following values with
41       the --format option:
42
43       ·   grid (default)
44
45           Display output in grid or table format like that of the mysql
46           client command-line tool.
47
48       ·   csv
49
50           Display output in comma-separated values format.
51
52       ·   tab
53
54           Display output in tab-separated format.
55
56       ·   vertical
57
58           Display output in single-column format like that of the \G command
59           for the mysql client command-line tool.
60
61       To turn off the headers for grid, csv, or tab display format, specify
62       the --no-headers option.
63
64       To see the common default settings for the local server's configuration
65       file, use the --show-defaults option. This option reads the
66       configuration file on the machine where the utility is run, not the
67       machine for the host that the --server option specifies.
68
69       To run the utility against several servers, specify the --server option
70       multiple times. In this case, the utility attempts to connect to each
71       server and read the information.
72
73       To see the MySQL servers running on the local machine, use the
74       --show-servers option. This shows all the servers with their process ID
75       and data directory. On Windows, the utility shows only the process ID
76       and port.  OPTIONS.PP mysqlserverinfo accepts the following
77       command-line options:
78
79       ·   --help
80
81           Display a help message and exit.
82
83       ·   --license
84
85           Display license information and exit.
86
87       ·   --basedir=<basedir>
88
89           The base directory for the server. This option is required for
90           starting an offline server.
91
92           Is also used to access server tools, such as my_print_defaults that
93           is required to read the login-path values from the login
94           configuration file (.mylogin.cnf).
95
96       ·   --datadir=<datadir>
97
98           The data directory for the server. This option is required for
99           starting an offline server.
100
101       ·   --format=<format>, -f<format>
102
103           Specify the output display format. Permitted format values are
104           grid, csv, tab, and vertical. The default is grid.
105
106       ·   --no-headers, -h
107
108           Do not display column headers. This option applies only for grid,
109           csv, and tab output.
110
111       ·   --port-range=<start:end>
112
113           The port range to check for finding running servers. This option
114           applies only to Windows and is ignored unless --show-servers is
115           given. The default range is 3306:3333.
116
117       ·   --server=<server>
118
119           Connection information for a server. Use this option multiple times
120           to see information for multiple servers.
121
122           To connect to a server, it is necessary to specify connection
123           parameters such as user name, host name, password, and either a
124           port or socket. MySQL Utilities provides a number of ways to
125           provide this information. All of the methods require specifying
126           your choice via a command-line option such as --server, --master,
127           --slave, etc. The methods include the following in order of most
128           secure to least secure.
129
130           ·   Use login-paths from your .mylogin.cnf file (encrypted, not
131               visible). Example : <login-path>[:<port>][:<socket>]
132
133           ·   Use a configuration file (unencrypted, not visible) Note:
134               available in release-1.5.0. Example :
135               <configuration-file-path>[:<section>]
136
137           ·   Specify the data on the command-line (unencrypted, visible).
138               Example : <user>[:<passwd>]@<host>[:<port>][:<socket>]
139
140
141       ·   --show-defaults, -d
142
143           Display default settings for mysqld from the local configuration
144           file. It uses my_print_defaults to obtain the options.
145
146       ·   --show-servers
147
148           Display information about servers running on the local host. The
149           utility examines the host process list to determine which servers
150           are running.
151
152       ·   --ssl-ca
153
154           The path to a file that contains a list of trusted SSL CAs.
155
156       ·   --ssl-cert
157
158           The name of the SSL certificate file to use for establishing a
159           secure connection.
160
161       ·   --ssl-cert
162
163           The name of the SSL key file to use for establishing a secure
164           connection.
165
166       ·   --ssl
167
168           Specifies if the server connection requires use of SSL. If an
169           encrypted connection cannot be established, the connection attempt
170           fails. Default setting is 0 (SSL not required).
171
172       ·   --start, -s
173
174           Start the server in read-only mode if it is offline. With this
175           option, you must also give the --basedir and --datadir options.
176
177       ·   --start-timeout
178
179           Number of seconds to wait for the server to be online when started
180           in read-only mode using the --start option. The default value is 10
181           seconds.
182
183           The --start-timeout option is available as of MySQL Utilities 1.2.4
184           / 1.3.3.
185
186       ·   --verbose, -v
187
188           Specify how much information to display. Use this option multiple
189           times to increase the amount of information. For example, -v =
190           verbose, -vv = more verbose, -vvv = debug.
191
192       ·   --version
193
194           Display version information and exit.
195
196       For the --format option, the permitted values are not case sensitive.
197       In addition, values may be specified as any unambiguous prefix of a
198       valid value. For example, --format=g specifies the grid format. An
199       error occurs if a prefix matches more than one valid value.
200
201       The path to the MySQL client tools should be included in the PATH
202       environment variable in order to use the authentication mechanism with
203       login-paths. This will allow the utility to use the my_print_defaults
204       tools which is required to read the login-path values from the login
205       configuration file (.mylogin.cnf).  EXAMPLES.PP To display the server
206       information for the local server and the settings for mysqld in the
207       configuration file with the output in a vertical list, use this
208       command:
209
210           shell> mysqlserverinfo --server=root:pass@localhost -d --format=vertical
211           # Source on localhost: ... connected.
212           *************************       1. row *************************
213                    server: localhost:3306
214                   version: 5.1.50-log
215                   datadir: /usr/local/mysql/data/
216                   basedir: /usr/local/mysql-5.1.50-osx10.6-x86_64/
217                plugin_dir: /usr/local/mysql-5.1.50-osx10.6-x86_64/lib/plugin
218               config_file: /etc/my.cnf
219                binary_log: my_log.000068
220            binary_log_pos: 212383
221                 relay_log: None
222             relay_log_pos: None
223           1 rows.
224           Defaults for server localhost:3306
225             --port=3306
226             --basedir=/usr/local/mysql
227             --datadir=/usr/local/mysql/data
228             --server_id=5
229             --log-bin=my_log
230             --general_log
231             --slow_query_log
232             --innodb_data_file_path=ibdata1:778M;ibdata2:50M:autoextend
233           #...done.
234
235       PERMISSIONS REQUIRED.PP The permissions required include the ability to
236       read the mysql database and to have read access to the data directory.
237
238       The user must have permissions to read the data directory or use an
239       administrator or super user (sudo) account to obtain access to the data
240       directory.
241

COPYRIGHT

243       Copyright © 2006, 2015, Oracle and/or its affiliates. All rights
244       reserved.
245
246       This documentation is free software; you can redistribute it and/or
247       modify it only under the terms of the GNU General Public License as
248       published by the Free Software Foundation; version 2 of the License.
249
250       This documentation is distributed in the hope that it will be useful,
251       but WITHOUT ANY WARRANTY; without even the implied warranty of
252       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
253       General Public License for more details.
254
255       You should have received a copy of the GNU General Public License along
256       with the program; if not, write to the Free Software Foundation, Inc.,
257       51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
258       http://www.gnu.org/licenses/.
259
260

AUTHOR

267       Oracle Corporation (http://dev.mysql.com/).
268
269
270
271MySQL 1.5.6                       09/15/2015                   MYSQLSERVERINFO

NAME

SYNOPSIS

DESCRIPTION

COPYRIGHT

SEE ALSO

AUTHOR