usr/src/man/man3stmf/stmfModifyLu.3stmf

   1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH STMFMODIFYLU 3STMF "May 8, 2009"
   7 .SH NAME
   8 stmfModifyLu, stmfModifyLuByFname \- modify a logical uni
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... -lstmf [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfModifyLu\fR(\fBstmfGuid *\fR\fIluGuid\fR, \fBuint32_t\fR \fIprop\fR, \fBconst char *\fR\fIpropVal\fR)
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBstmfModifyLu\fR(\fBuint16_t\fR \fIdType\fR, \fBconst char *\fR\fIfname\fR, \fBuint32_t\fR \fIprop\fR,
  21      \fBconst char *\fR\fIpropVal\fR)
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIluGuid\fR\fR
  29 .ad
  30 .RS 11n
  31 The guid of logical unit to modify.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIfname\fR\fR
  38 .ad
  39 .RS 11n
  40 The filename of logical unit to modify.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIdType\fR\fR
  47 .ad
  48 .RS 11n
  49 Type of logical unit. See \fBstmfCreateLuResource\fR(3STMF).
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIprop\fR\fR
  56 .ad
  57 .RS 11n
  58 A property type value. See DESCRIPTION for valid values.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIpropVal\fR\fR
  65 .ad
  66 .RS 11n
  67 A property value.
  68 .RE
  69
  70 .SH DESCRIPTION
  71 .sp
  72 .LP
  73 The \fBstmfModifyLu()\fR and \fBstmfModifyLuByFname()\fR functions modify the
  74 properties of a logical unit device.
  75 .sp
  76 .LP
  77 Valid properties for modify \fBSTMF_DISK\fR:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBSTMF_LU_PROP_ALIAS\fR\fR
  82 .ad
  83 .sp .6
  84 .RS 4n
  85 Up to 255 characters representing a user defined name for the device.
  86 .sp
  87 Default: Set to file name of backing store.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBSTMF_LU_PROP_SIZE\fR\fR
  94 .ad
  95 .sp .6
  96 .RS 4n
  97 Numeric value with optional suffix (for example, 100G, 1T) to specify unit of
  98 size.
  99 .sp
 100 Default: Size of device specified in the \fBSTMF_LU_PROP_DATA_FILENAME\fR
 101 property value.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBSTMF_LU_PROP_WRITE_CACHE_DISABLE\fR\fR
 108 .ad
 109 .sp .6
 110 .RS 4n
 111 Write back cache disable. When specified as "true" or "false", specifies write
 112 back cache disable behavior.
 113 .sp
 114 Default: Writeback cache setting of the backing store device specified by
 115 \fBSTMF_LU_PROP_DATA_FILENAME\fR.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBSTMF_LU_PROP_WRITE_PROTECT\fR\fR
 122 .ad
 123 .sp .6
 124 .RS 4n
 125 Write protect bit. When specified as "true" or "false", specifies whether the
 126 device behaves as a write protected device.
 127 .sp
 128 Default: "false"
 129 .RE
 130
 131 .SH RETURN VALUES
 132 .sp
 133 .LP
 134 The following values are returned:
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
 139 .ad
 140 .sp .6
 141 .RS 4n
 142 The API call was successful.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBSTMF_ERROR_INVALID_ARG\fR\fR
 149 .ad
 150 .sp .6
 151 .RS 4n
 152 Either \fIprop\fR or \fIpropVal\fR is unrecognized.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBSTMF_ERROR_INVALID_PROPSIZE\fR\fR
 159 .ad
 160 .sp .6
 161 .RS 4n
 162 The size of \fIpropVal\fR is invalid.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBSTMF_ERROR_NO_PROP\fR\fR
 169 .ad
 170 .sp .6
 171 .RS 4n
 172 The value of \fIprop\fR is unknown for this resource type.
 173 .RE
 174
 175 .SH ATTRIBUTES
 176 .sp
 177 .LP
 178 See \fBattributes\fR(5) for descriptions of the following attributes:
 179 .sp
 180
 181 .sp
 182 .TS
 183 box;
 184 c | c
 185 l | l .
 186 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 187 _
 188 Interface Stability     Committed
 189 _
 190 MT-Level        Safe
 191 .TE
 192
 193 .SH SEE ALSO
 194 .sp
 195 .LP
 196 \fBlibstmf\fR(3LIB), \fBstmfCreateLuResource\fR(3STMF), \fBattributes\fR(5)