| blob | 5b650f6f89a9c8005783f1829a90523bd15f12d4 |
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SBDADM 8 "April 9, 2016"
7 .SH NAME
8 sbdadm \- SCSI Block Disk command line interface
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBsbdadm\fR \fBcreate-lu\fR [\fB-s\fR, \fB--size\fR \fIsize\fR] \fIfilename\fR
13 .fi
15 .LP
16 .nf
17 \fBsbdadm\fR \fBdelete-lu\fR \fIlu_name\fR
18 .fi
20 .LP
21 .nf
22 \fBsbdadm\fR \fBimport-lu\fR \fIlu_name\fR
23 .fi
25 .LP
26 .nf
27 \fBsbdadm\fR \fBlist-lu\fR \fIlu_name\fR
28 .fi
30 .LP
31 .nf
32 \fBsbdadm\fR \fBmodify-lu\fR [\fB-s\fR, \fB--size\fR \fIsize\fR] \fIlu_name\fR | \fIfilename\fR
33 .fi
35 .SH DESCRIPTION
36 .LP
37 The \fBsbdadm\fR command creates and manages SCSI-block-device-based logical
38 units that are registered with the SCSI Target Mode Framework (STMF).
39 .SH SUBCOMMANDS
40 .LP
41 The \fBsbdadm\fR command supports the subcommands listed below. Note that if
42 you enter a question mark as an argument to the command (\fBsbdadm ?\fR),
43 \fBsbdadm\fR responds with a help display.
44 .sp
45 .ne 2
46 .na
47 \fB\fBcreate-lu\fR [\fB-s\fR, \fB--size\fR \fIsize\fR] \fIfilename\fR\fR
48 .ad
49 .sp .6
50 .RS 4n
51 Create a logical unit that can be registered with the STMF. For the \fB-s\fR
52 option, \fIsize\fR is an integer followed by one of the following letters, to
53 indicate a unit of size:
54 .sp
55 .ne 2
56 .na
57 \fB\fBk\fR\fR
58 .ad
59 .RS 5n
60 kilobyte
61 .RE
63 .sp
64 .ne 2
65 .na
66 \fB\fBm\fR\fR
67 .ad
68 .RS 5n
69 megabyte
70 .RE
72 .sp
73 .ne 2
74 .na
75 \fB\fBg\fR\fR
76 .ad
77 .RS 5n
78 gigabyte
79 .RE
81 .sp
82 .ne 2
83 .na
84 \fB\fBt\fR\fR
85 .ad
86 .RS 5n
87 terabyte
88 .RE
90 .sp
91 .ne 2
92 .na
93 \fB\fBp\fR\fR
94 .ad
95 .RS 5n
96 petabyte
97 .RE
99 .sp
100 .ne 2
101 .na
102 \fB\fBe\fR\fR
103 .ad
104 .RS 5n
105 exabyte
106 .RE
108 If you do not specify \fIsize\fR, the size defaults to the size of
109 \fIfilename\fR.
110 .sp
111 The size specified can exceed the size of the file or device.
112 .RE
114 .sp
115 .ne 2
116 .na
117 \fB\fBdelete-lu\fR \fIlu_name\fR\fR
118 .ad
119 .sp .6
120 .RS 4n
121 Deletes an existing logical unit that was created using \fBsbdadm create-lu\fR.
122 This effectively unloads the logical unit from the STMF framework. Any existing
123 data on the logical unit remains intact.
124 .RE
126 .sp
127 .ne 2
128 .na
129 \fB\fBimport-lu\fR \fIlu_name\fR\fR
130 .ad
131 .sp .6
132 .RS 4n
133 Imports and loads a logical unit into the STMF that was previously created
134 using \fBsbdadm create-lu\fR and was since deleted from the STMF using
135 \fBsbdadm delete-lu\fR. On success, the logical unit is again made available to
136 the STMF. \fIfilename\fR is the filename used in the \fBsbdadm create-lu\fR
137 command for this logical unit.
138 .RE
140 .sp
141 .ne 2
142 .na
143 \fB\fBlist-lu\fR\fR
144 .ad
145 .sp .6
146 .RS 4n
147 List all logical units that were created using the \fBsbdadm create-lu\fR
148 command.
149 .RE
151 .sp
152 .ne 2
153 .na
154 \fB\fBmodify-lu\fR [\fB-s\fR, \fB--size\fR \fIsize\fR] \fIlu_name\fR |
155 \fIfilename\fR\fR
156 .ad
157 .sp .6
158 .RS 4n
159 Modifies attributes of an logical unit created using the \fBsbdadm create-lu\fR
160 command. For the \fB-s\fR option, \fIsize\fR is an integer value followed by a
161 unit specifier. The unit specifiers are as described above under
162 \fBcreate-lu\fR. When this option is specified, the existing size of the
163 logical unit is changed to the new size.
164 .sp
165 The size specified can exceed the size of the file or device represented by
166 \fIlu_name\fR.
167 .RE
169 .SH OPERANDS
170 .LP
171 \fBsbdadm\fR use the following operands:
172 .sp
173 .ne 2
174 .na
175 \fB\fIfilename\fR\fR
176 .ad
177 .sp .6
178 .RS 4n
179 Name of an existing file or a fully qualified path to a raw block device.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fIlu_name\fR\fR
186 .ad
187 .sp .6
188 .RS 4n
189 The 32-byte hexadecimal representation of the logical unit.
190 .RE
192 .SH EXAMPLES
193 .LP
194 \fBExample 1 \fRCreating a Logical Unit
195 .sp
196 .LP
197 The following series of commands creates a 10-gigabyte logical unit.
199 .sp
200 .in +2
201 .nf
202 # \fBtouch /export/lun/0\fR
203 # \fBsbdadm create-lu -s 10g /export/lun/0\fR
204 # \fBsbdadm create-lu /dev/rdsk/c1t1d0s0\fR
205 .fi
206 .in -2
207 .sp
209 .LP
210 \fBExample 2 \fRListing Logical Units
211 .sp
212 .LP
213 The following command lists all logical units.
215 .sp
216 .in +2
217 .nf
218 # \fBsbdadm list-lu\fR
219 Found 2 LU(s)
221 GUID DATA SIZE SOURCE
222 -------------------------------- ----------- ------
223 6000ae4000144f21d92c47b0dd650002 10737352704 /export/lun/0
224 6000ae4000144f21d92c47b0de300032 134283264 /dev/rdsk/c1t1d0s0
225 .fi
226 .in -2
227 .sp
229 .SH EXIT STATUS
230 .ne 2
231 .na
232 \fB\fB0\fR\fR
233 .ad
234 .sp .6
235 .RS 4n
236 Successful completion.
237 .RE
239 .sp
240 .ne 2
241 .na
242 \fB\fBnon-zero\fR\fR
243 .ad
244 .sp .6
245 .RS 4n
246 An error occurred.
247 .RE
249 .SH ATTRIBUTES
250 .LP
251 See \fBattributes\fR(5) for descriptions of the following attributes:
252 .sp
254 .sp
255 .TS
256 box;
257 c | c
258 l | l .
259 ATTRIBUTE TYPE ATTRIBUTE VALUE
260 _
261 Interface Stability Obsolete Committed
262 .TE
264 .SH SEE ALSO
265 .LP
266 \fBstmfadm\fR(8), \fBattributes\fR(5)