Copyright (c) 2009, 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]
cc [ flag... ] file... -lstmf [ library... ] #include <libstmf.h> int stmfSetLuProp(luResource hdl, uint32_t prop, const char *propVal);
int stmfGetLuProp(luResource hdl, uint32_t prop, char *propVal, size_t *propLen);
hdl
A logical unit resource previously allocated by stmfCreateLuResource(3STMF) or stmfGetLuResource(3STMF).
prop
A property type value. See DESCRIPTION for valid values.
propVal
A property value.
propLen
The length of the specified property value. If propLen was of an insufficient size to hold the returned property value, propLen will contain the required size of the buffer and STMF_ERROR_INVALID_ARG will be returned.
These functions set or get property values. All property values are expressed in human-readable form. Boolean properties are expressed in case insensitive form of "true" or "false". Properties that are represented by ASCII hexadecimal contain no leading characters to indicate a base hexadecimal representation (that is, no leading "0x"). The prop argument can be one of the following values:
STMF_LU_PROP_ALIAS
Up to 255 characters representing a user defined name for the device. Default: Set to file name of backing store.
STMF_LU_PROP_BLOCK_SIZE
Numeric value for block size in bytes in 2^n. Default: 512
STMF_LU_PROP_COMPANY_ID
Organizational Unique Identifier. 6 hexadecimal ASCII characters representing the IEEE OUI company id assignment. This will be used to generate the device identifier (GUID). Default: 00144F
STMF_LU_PROP_DATA_FILENAME
Character value representing the file name of the backing store device. Default: None
STMF_LU_PROP_GUID
ASCII hexadecimal string of 32 characters representing the unique identifier for the device. This must be of valid 32 hexadecimal ASCII characters representing a valid NAA Registered Extended Identifier. Default: Set by framework to a generated value.
STMF_LU_PROP_META_FILENAME
Metadata file name. When specified, will be used to hold the SCSI metadata for the logical unit. Default: None. If this value is not specified, the value specified in STMF_LU_PROP_DATA_FILENAME will be used.
STMF_LU_PROP_MGMT_URL
Up to 1024 characters representing Management Network Address URLs. More than one URL can be passed using space delimited URLs.
STMF_LU_PROP_PID
Up to 16 characters of product identification that will be reflected in the Standard INQUIRY data returned for the device. Default: sSet to COMSTAR.
STMF_LU_PROP_PRODUCT_REV
Up to 4 characters of revision information that will be reflected in the Standard INQUIRY data returned for the device. Default: Set to 1.0.
STMF_LU_PROP_SERIAL_NUM
Serial Number. Specifies the SCSI Vital Product Data Serial Number (page 80h). It is a character value up to 252 bytes in length. Default: None
STMF_LU_PROP_SIZE
Numeric value w/optional suffix, e.g. 100G, 1T, to specify unit of size. Default: Size of the device specified in the STMF_LU_PROP_DATA_FILENAME property value.
STMF_LU_PROP_VID
8 characters of vendor identification per SCSI SPC-3 and will be reflected in the Standard INQUIRY data returned for the device. Default: Set to SUN.
STMF_LU_PROP_WRITE_CACHE_DISABLE
Write back cache disable. When specified as "true" or "false", specifies write back cache disable behavior. Default: Writeback cache setting of the backing store device specified by STMF_LU_PROP_DATA_FILENAME.
STMF_LU_PROP_WRITE_PROTECT
Write protect bit. When specified as "true" or "false", specifies whether the device behaves as a write protected device. Default: "false"
The following values are returned:
STMF_STATUS_SUCCESS
The API call was successful.
STMF_ERROR_INVALID_ARG
Either prop or propVal is unrecognized.
STMF_ERROR_INVALID_PROPSIZE
The size of propVal is invalid.
STMF_ERROR_NO_PROP
The value of prop is unknown for this resource type.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| Interface Stability | Committed |
| MT-Level | Safe |
libstmf(3LIB), stmfCreateLuResource(3STMF), stmfGetLuResource(3STMF), attributes(5)