1 '\" te 2 .\" Copyright (c) 2007, 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 NSCADM 1M "Oct 2, 2007" 7 .SH NAME 8 nscadm \- network storage control utility 9 .SH SYNOPSIS 10 .LP 11 .nf 12 \fBnscadm\fR freeze \fIdevice\fR 13 .fi 14 15 .LP 16 .nf 17 \fBnscadm\fR unfreeze \fIdevice\fR 18 .fi 19 20 .LP 21 .nf 22 \fBnscadm\fR isfrozen \fIdevice\fR 23 .fi 24 25 .SH DESCRIPTION 26 .sp 27 .LP 28 The \fBnscadm\fR command performs several network storage control functions. 29 .sp 30 .LP 31 The \fBnscadm\fR \fBfreeze\fR command closes existing references to the 32 specified device, and blocks future accesses. This allows maintenance of 33 virtual volume device drivers (for example, RAID 0, RAID 1, RAID 5) to be 34 performed without shutting down the system. 35 .sp 36 .LP 37 The \fBnscadm\fR \fBunfreeze\fR command reverses the effects of \fBnscadm\fR 38 \fBfreeze\fR for the specified device. 39 .sp 40 .LP 41 The \fBnscadm\fR \fBisfrozen\fR command returns the current status of the 42 specified device. 43 .SH OPTIONS 44 .sp 45 .LP 46 The \fBnscadm\fR command supports the following option. 47 .sp 48 .ne 2 49 .na 50 \fB\fB-h\fR\fR 51 .ad 52 .RS 13n 53 Display the usage menu. 54 .RE 55 56 .SH OPERANDS 57 .sp 58 .LP 59 The \fBnscadm\fR command line supports the following operand. 60 .sp 61 .ne 2 62 .na 63 \fB\fIdevice\fR\fR 64 .ad 65 .sp .6 66 .RS 4n 67 Specifies the storage device to be acted upon by \fBnscadm\fR. 68 .RE 69 70 .SH EXIT STATUS 71 .sp 72 .LP 73 For the \fBfreeze\fR and \fBunfreeze\fR, subcommands \fBnscadm\fR returns the 74 following exit values: 75 .sp 76 .ne 2 77 .na 78 \fB\fB0\fR\fR 79 .ad 80 .RS 13n 81 Success 82 .RE 83 84 .sp 85 .ne 2 86 .na 87 \fB\fB255\fR\fR 88 .ad 89 .RS 13n 90 Error 91 .RE 92 93 .sp 94 .LP 95 For the \fBisfrozen\fR subcommand, \fBnscadm\fR returns the following exit 96 values: 97 .sp 98 .ne 2 99 .na 100 \fB\fB0\fR\fR 101 .ad 102 .RS 13n 103 Device is currently frozen. 104 .RE 105 106 .sp 107 .ne 2 108 .na 109 \fB\fB1\fR\fR 110 .ad 111 .RS 13n 112 Device is not currently frozen. 113 .RE 114 115 .sp 116 .ne 2 117 .na 118 \fB\fB255\fR\fR 119 .ad 120 .RS 13n 121 Error 122 .RE 123 124 .SH ATTRIBUTES 125 .sp 126 .LP 127 See \fBattributes\fR(5) for descriptions of the following attributes: 128 .sp 129 130 .sp 131 .TS 132 box; 133 c | c 134 l | l . 135 ATTRIBUTE TYPE ATTRIBUTE VALUE 136 _ 137 Interface Stability Evolving 138 .TE 139 140 .SH SEE ALSO 141 .sp 142 .LP 143 \fBscmadm\fR(1M), \fBattributes\fR(5)