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 SVADM 1M "Oct 2, 2007"
   7 .SH NAME
   8 svadm \- command line interface to control Availability Suite Storage Volume
   9 operations
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBsvadm\fR \fB-h\fR
  14 .fi
  15 
  16 .LP
  17 .nf
  18 \fBsvadm\fR \fB-v\fR
  19 .fi
  20 
  21 .LP
  22 .nf
  23 \fBsvadm\fR [\fB-C\fR \fItag\fR]
  24 .fi
  25 
  26 .LP
  27 .nf
  28 \fBsvadm\fR [\fB-C\fR \fItag\fR] \fB-i\fR
  29 .fi
  30 
  31 .LP
  32 .nf
  33 \fBsvadm\fR [\fB-C\fR \fItag\fR] \fB-e\fR {\fB-f\fR \fIconfig_file\fR | volume}
  34 .fi
  35 
  36 .LP
  37 .nf
  38 \fBsvadm\fR [\fB-C\fR \fItag\fR] \fB-d\fR {\fB-f\fR \fIconfig_file\fR | volume}
  39 .fi
  40 
  41 .LP
  42 .nf
  43 \fBsvadm\fR [\fB-C\fR \fItag\fR] \fB-r\fR {\fB-f\fR \fIconfig_file\fR | volume}
  44 .fi
  45 
  46 .SH DESCRIPTION
  47 .LP
  48 The \fBsvadm\fR command controls the Storage Volume (SV) driver by providing
  49 facilities to enable and disable the SV driver for specified volumes, and to
  50 dynamically reconfigure the system.
  51 .SH OPTIONS
  52 .LP
  53 If you specify no arguments to an \fBsvadm\fR command, the utility displays the
  54 list of volumes currently under SV control. \fBsvadm\fR supports the following
  55 options:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB-C\fR \fItag\fR\fR
  60 .ad
  61 .sp .6
  62 .RS 4n
  63 On a clustered node, limits operations to only those volumes belonging to the
  64 cluster resource group, or disk group name, specified by tag. This option is
  65 illegal on a system that is not clustered. The special \fItag\fR, \fBlocal\fR,
  66 can be used to limit operations to only those volumes that cannot switch over
  67 to other nodes in the cluster.
  68 .RE
  69 
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-d\fR\fR
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 Disables the SV devices specified on the command line or in the configuration
  78 file. If \fB-C\fR tag is specified with this option, then the volume should be
  79 in this cluster disk group.
  80 .RE
  81 
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fB-e\fR\fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 Enables the SV devices specified on the command line or in the configuration
  90 file. Details of the volume are saved in the current configuration. See
  91 \fBdscfg\fR(1M). If \fB-C\fR tag is specified with this option, then the volume
  92 should be in this cluster disk group.
  93 .RE
  94 
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB-f\fR \fIconfig_file\fR\fR
  99 .ad
 100 .sp .6
 101 .RS 4n
 102 Specifies a configuration file that contains a list of volumes. A command reads
 103 this volume list and then perform the operation. The format of the
 104 \fIconfig_file\fR is a simple list of volume pathnames, one per line. Blank
 105 lines and lines starting with the comment character (#) are ignored.
 106 .RE
 107 
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB-h\fR\fR
 112 .ad
 113 .sp .6
 114 .RS 4n
 115 Displays the \fBsvadm\fR usage summary.
 116 .RE
 117 
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB-i\fR\fR
 122 .ad
 123 .sp .6
 124 .RS 4n
 125 Displays extended status for the volumes currently under SV control.
 126 .RE
 127 
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fB-r\fR\fR
 132 .ad
 133 .sp .6
 134 .RS 4n
 135 When a \fIconfig_file\fR is specified, reconfigure the running system to match
 136 the configuration specified in the \fIconfig_file\fR. When the \fB-C\fR option
 137 is specified, compare the cluster tag for each volume and change it to
 138 \fIcluster_tag\fR. If a volume is specified with this option, it is valid only
 139 to reconfigure the cluster tag associated with the volume. The \fB-e\fR or
 140 \fB-d\fR options should be used to enable or disable single volumes.
 141 .RE
 142 
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fB-v\fR\fR
 147 .ad
 148 .sp .6
 149 .RS 4n
 150 Displays the SV version number.
 151 .RE
 152 
 153 .SH USAGE
 154 .LP
 155 When an SV volume is enabled, normal system call access to the device (see
 156 \fBIntro\fR(2)) is redirected into the StoreEdge architecture software. This
 157 allows standard applications to use StorageTek features such as Sun StorageTek
 158 Point-in-Time Copy and Remote Mirror Software.
 159 .sp
 160 .LP
 161 The \fBsvadm\fR command generates an entry in the Availability Suite log file,
 162 \fB/var/adm/ds.log\fR (see \fBds.log\fR(4)), when performing enable (\fB-e\fR)
 163 and disable (\fB-d\fR) operations.
 164 .SH ATTRIBUTES
 165 .LP
 166 See \fBattributes\fR(5) for descriptions of the following attributes:
 167 .sp
 168 
 169 .sp
 170 .TS
 171 box;
 172 c | c
 173 l | l .
 174 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 175 _
 176 Interface Stability     Evolving
 177 .TE
 178 
 179 .SH SEE ALSO
 180 .LP
 181 \fBdscfg\fR(1M), \fBds.log\fR(4), \fBattributes\fR(5), \fBsv\fR(7D)