xref: /freebsd/usr.sbin/mpsutil/mpsutil.8 (revision b9f654b163bce26de79705e77b872427c9f2afa1)
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 November 17, 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.Nm
64.Op Fl u Ar unit
65.Cm flash save
66.Op Ar firmware Ns | Ns Ar bios
67.Op Ar file
68.Nm
69.Op Fl u Ar unit
70.Cm flash update
71.Op Ar firmware Ns | Ns Ar bios
72.Ar file
73.Sh DESCRIPTION
74The
75.Nm
76utility can be used to display or modify various parameters on LSI
77Fusion-MPS 2 controllers.
78.Pp
79The
80.Nm mprutil
81utility can be used to display or modify various parameters on LSI
82Fusion-MPS 3 controllers.
83.Pp
84The
85.Nm mprutil
86utility behave identically to
87.Nm .
88(same program)
89.Pp
90Each invocation of
91.Nm
92consists of zero or more global options followed by a command.
93Commands may support additional optional or required arguments after the
94command.
95.Pp
96Currently one global option is supported:
97.Bl -tag -width indent
98.It Fl u Ar unit
99.Ar unit
100specifies the unit of the controller to work with.
101If no unit is specified,
102then unit 0 is used.
103.El
104.Pp
105The
106.Nm
107utility supports several different groups of commands.
108The first group of commands provide information about the controller.
109The second group of commands are used to manager controller-wide operations.
110.Pp
111The informational commands include:
112.Bl -tag -width indent
113.It Cm version
114Displays the version of
115.Nm .
116.It Cm show adapter
117Displays information about the controller such as the model number or firmware
118version.
119.It Cm show adapters
120Displays a summary of all adapters.
121.It Cm show all
122Displays all devices, expanders and enclosures.
123.It Cm show devices
124Displays all devices.
125.It Cm show expanders
126Displays all expanders.
127.It Cm show enclosures
128Displays all enclosures.
129.It Cm show iocfacts
130Displays IOC Facts messages.
131.It Cm show cfgpage page Oo Ar num Oc Op Ar addr
132Show IOC Facts Message
133.El
134.Pp
135Controller management commands include:
136.Bl -tag -width indent
137.It Cm flash save Oo Ar firmware Ns | Ns Ar bios Oc Op Ar file
138Save the
139.Ar firmware
140or
141.Ar bios
142from the controller into a local
143.Ar file .
144If no
145.Ar file
146is specified then the file will be named
147.Pa firmware
148or
149.Pa bios .
150.It Cm flash update Oo Ar firmware Ns | Ns Ar bios Oc Ar file
151Replace the
152.Ar firmware
153or
154.Ar bios
155from the controller with the one specified via
156.Ar file .
157.El
158.Sh SEE ALSO
159.Xr mpr 4 ,
160.Xr mps 4
161.Sh HISTORY
162The
163.Nm
164utility first appeared in
165.Fx 11.0 .
166