xref: /freebsd/usr.sbin/mpsutil/mpsutil.8 (revision 2830819497fb2deae3dd71574592ace55f2fbdba)
1.\"
2.\" Copyright (c) Baptiste Daroussin <bapt@FreeBSD.org>
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd October 28, 2015
28.Dt MPSUTIL 8
29.Os
30.Sh NAME
31.Nm mpsutil ,
32.Nm mprutil
33.Nd Utility for managing LSI Fusion-MPT 2/3 controllers
34.Sh SYNOPSIS
35.Nm
36.Cm version
37.Nm
38.Op Fl u Ar unit
39.Cm show adapter
40.Nm
41.Op Fl u Ar unit
42.Cm show adapters
43.Nm
44.Op Fl u Ar unit
45.Cm show all
46.Nm
47.Op Fl u Ar unit
48.Cm show cfgpages page
49.Op Ar num
50.Op Ar addr
51.Nm
52.Op Fl u Ar unit
53.Cm show devices
54.Nm
55.Op Fl u Ar unit
56.Cm show enclosures
57.Nm
58.Op Fl u Ar unit
59.Cm show expanders
60.Nm
61.Op Fl u Ar unit
62.Cm show iocfacts
63.Sh DESCRIPTION
64The
65.Nm
66utility can be used to display or modify various parameters on LSI
67Fusion-MPS 2 controllers.
68.Pp
69The
70.Nm mprutil
71utility can be used to display or modify various parameters on LSI
72Fusion-MPS 3 controllers.
73.Pp
74The
75.Nm mprutil
76utility behave identically to
77.Nm .
78(same program)
79.Pp
80Each invocation of
81.Nm
82consists of zero or more global options followed by a command.
83Commands may support additional optional or required arguments after the
84command.
85.Pp
86Currently one global option is supported:
87.Bl -tag -width indent
88.It Fl u Ar unit
89.Ar unit
90specifies the unit of the controller to work with.
91If no unit is specified,
92then unit 0 is used.
93.El
94.Pp
95The
96.Nm
97utility currently only supports informational commands.
98.Pp
99The informational commands include:
100.Bl -tag -width indent
101.It Cm version
102Displays the version of
103.Nm .
104.It Cm show adapter
105Displays information about the controller such as the model number or firmware
106version.
107.It Cm show adapters
108Displays a summary of all adapters.
109.It Cm show all
110Displays all devices, expanders and enclosures.
111.It Cm show devices
112Displays all devices.
113.It Cm show expanders
114Displays all expanders.
115.It Cm show enclosures
116Displays all enclosures.
117.It Cm show iocfacts
118Displays IOC Facts messages.
119.It Cm show cfgpage page Oo Ar num Oc Op Ar addr
120Show IOC Facts Message
121.El
122.Sh SEE ALSO
123.Xr mpr 4
124.Xr mps 4
125.Sh HISTORY
126The
127.Nm
128utility first appeared in
129.Fx 11.0 .
130