usr/src/man/man1m/scmadm.1m

   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 SCMADM 1M "Aug 3, 2006"
   7 .SH NAME
   8 scmadm \- storage cache manager administration utility
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBscmadm\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBscmadm\fR \fB-h\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBscmadm\fR \fB-e\fR
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBscmadm\fR \fB-d\fR
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBscmadm\fR \fB-v\fR
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBscmadm\fR \fB-C\fR [\fIparameter\fR [= [\fIvalue\fR]]...]
  38 .fi
  39
  40 .LP
  41 .nf
  42 \fBscmadm\fR \fB-o\fR {system | \fIcd\fR | \fIdevice\fR} [\fIoption\fR]
  43 .fi
  44
  45 .LP
  46 .nf
  47 \fBscmadm\fR \fB-m\fR {\fIcd\fR |  \fIdiskname\fR |  all}
  48 .fi
  49
  50 .SH DESCRIPTION
  51 .sp
  52 .LP
  53 The \fBscmadm\fR command provides various options for controlling and gathering
  54 information about a storage device cache.
  55 .SH OPTIONS
  56 .sp
  57 .LP
  58 If no options are specified, \fBscmadm\fR displays a list of configured cache
  59 descriptors with disknames, options, and global options. The \fBscmadm\fR
  60 command supports the following options:
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-h\fR\fR
  65 .ad
  66 .sp .6
  67 .RS 4n
  68 Displays usage information for the \fBscmadm\fR command.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-e\fR\fR
  75 .ad
  76 .sp .6
  77 .RS 4n
  78 Reads the configuration and enables the storage device cache with those
  79 parameters. See \fBdscfg\fR(1M).
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fB-d\fR\fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 Shuts down the storage device cache.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB-v\fR\fR
  96 .ad
  97 .sp .6
  98 .RS 4n
  99 Displays the cache version number.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB-C\fR [\fIparameter\fR[=[\fIvalue\fR]] ...]\fR
 106 .ad
 107 .sp .6
 108 .RS 4n
 109 Sets or displays the configuration parameters. If the \fB-C\fR option is
 110 specified with no arguments the current cache configuration parameters are
 111 displayed. If \fIparameter\fR is specified, the current value of
 112 \fIparameter\fR is displayed. If \fIparameter=value\fR is specified, the
 113 current value of \fIparameter\fR is displayed and the parameter is changed to
 114 \fIvalue\fR.  If \fIvalue\fR is omitted, or if \fIvalue\fR is specified as the
 115 null string, " ", or as "-", the parameter is deleted from the configuration
 116 and the system uses the default value. Multiple parameters can be specified in
 117 a single invocation of the \fBscmadm\fR command. A change in a configuration
 118 parameter takes effect only when the cache is next restarted.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB-o\fR { \fBsystem\fR | \fBcd\fR | \fIdiskname\fR } [\fIoption\fR]\fR
 125 .ad
 126 .sp .6
 127 .RS 4n
 128 Sets or displays the options for the system or for the cache device specified
 129 by \fBcd\fR or \fIdiskname\fR. If the \fIoption\fR \fBrdcache\fR or
 130 \fBnordcache\fR is specified, the system or specified cache device is set to
 131 that option. The option is saved as part of the configuration so that the
 132 option persists. See \fBdscfg\fR(1M). To notify the system to "forget" about a
 133 saved option, use the \fBforget\fR option. This does not change the option; it
 134 just removes the option from the saved configuration. If no option is
 135 specified, current options are displayed. The \fBrdcache\fR option is set as
 136 the default. The \fIoption\fRs are defined as follows:
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBrdcache\fR\fR
 141 .ad
 142 .sp .6
 143 .RS 4n
 144 Data blocks are likely to be referenced again and should remain in cache.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBnordcache\fR\fR
 151 .ad
 152 .sp .6
 153 .RS 4n
 154 Data blocks are unlikely to be referenced again and should be treated as least
 155 recently used, so that other blocks can remain in the cache longer.
 156 .RE
 157
 158 .RE
 159
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fB-m\fR { \fBcd\fR | \fIdiskname\fR | \fBall\fR }\fR
 164 .ad
 165 .sp .6
 166 .RS 4n
 167 Displays the cache descriptor and diskname map for the device specified by
 168 \fBcd\fR or \fIdiskname\fR or, if you specify \fBall\fR, displays the cache
 169 descriptors and diskname map for all storage devices on the system.
 170 .RE
 171
 172 .SH EXIT STATUS
 173 .sp
 174 .LP
 175 The \fBscmadm\fR command returns 0 for success, non-zero for error.
 176 .SH FILES
 177 .sp
 178 .LP
 179 \fB/dev/sdbc\fR
 180 .SH ATTRIBUTES
 181 .sp
 182 .LP
 183 See \fBattributes\fR(5) for descriptions of the following attributes:
 184 .sp
 185
 186 .sp
 187 .TS
 188 box;
 189 c | c
 190 l | l .
 191 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 192 _
 193 Interface Stability     Evolving
 194 .TE
 195
 196 .SH SEE ALSO
 197 .sp
 198 .LP
 199 \fBdscfg\fR(1M), \fBattributes\fR(5)
 200 .SH DIAGNOSTICS
 201 .sp
 202 .LP
 203 \fBscmadm\fR fails if there is insufficient contiguous memory.