Copyright (c) 2007, Sun Microsystems, Inc. All rights reserved.
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.
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.
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]
scmadm
scmadm -h
scmadm -e
scmadm -d
scmadm -v
scmadm -C [parameter [= [value]]...]
scmadm -o {system | cd | device} [option]
scmadm -m {cd | diskname | all}
The scmadm command provides various options for controlling and gathering information about a storage device cache.
If no options are specified, scmadm displays a list of configured cache descriptors with disknames, options, and global options. The scmadm command supports the following options:
-h
Displays usage information for the scmadm command.
-e
Reads the configuration and enables the storage device cache with those parameters. See dscfg(1M).
-d
Shuts down the storage device cache.
-v
Displays the cache version number.
-C [parameter[=[value]] ...]
Sets or displays the configuration parameters. If the -C option is specified with no arguments the current cache configuration parameters are displayed. If parameter is specified, the current value of parameter is displayed. If parameter=value is specified, the current value of parameter is displayed and the parameter is changed to value. If value is omitted, or if value is specified as the null string, " ", or as "-", the parameter is deleted from the configuration and the system uses the default value. Multiple parameters can be specified in a single invocation of the scmadm command. A change in a configuration parameter takes effect only when the cache is next restarted.
-o { system | cd | diskname } [option]
Sets or displays the options for the system or for the cache device specified by cd or diskname. If the option rdcache or nordcache is specified, the system or specified cache device is set to that option. The option is saved as part of the configuration so that the option persists. See dscfg(1M). To notify the system to "forget" about a saved option, use the forget option. This does not change the option; it just removes the option from the saved configuration. If no option is specified, current options are displayed. The rdcache option is set as the default. The options are defined as follows:
rdcache
Data blocks are likely to be referenced again and should remain in cache.
nordcache
Data blocks are unlikely to be referenced again and should be treated as least recently used, so that other blocks can remain in the cache longer.
-m { cd | diskname | all }
Displays the cache descriptor and diskname map for the device specified by cd or diskname or, if you specify all, displays the cache descriptors and diskname map for all storage devices on the system.
The scmadm command returns 0 for success, non-zero for error.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| Interface Stability | Evolving |
dscfg(1M), attributes(5)
scmadm fails if there is insufficient contiguous memory.