'\" te .\" Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved. .TH stmfSetLuProp 3STMF "18 Jan 2012" "SunOS 5.11" "SCSI Target Mode Framework Library Functions" .SH NAME stmfSetLuProp, stmfGetLuProp \- set or get a logical unit property .SH SYNOPSIS .LP .nf cc [ \fIflag\fR... ] \fIfile\fR... -lstmf [ \fIlibrary\fR... ] #include \fBint\fR \fBstmfSetLuProp\fR(\fBluResource\fR \fIhdl\fR, \fBuint32_t\fR \fIprop\fR, \fBconst char *\fR\fIpropVal\fR); .fi .LP .nf \fBint\fR \fBstmfGetLuProp\fR(\fBluResource\fR \fIhdl\fR, \fBuint32_t\fR \fIprop\fR, \fBchar *\fR\fIpropVal\fR, \fBsize_t *\fR\fIpropLen\fR); .fi .SH PARAMETERS .sp .ne 2 .mk .na \fB\fIhdl\fR\fR .ad .RS 11n .rt A logical unit resource previously allocated by \fBstmfCreateLuResource\fR(3STMF) or \fBstmfGetLuResource\fR(3STMF). .RE .sp .ne 2 .mk .na \fB\fIprop\fR\fR .ad .RS 11n .rt A property type value. See DESCRIPTION for valid values. .RE .sp .ne 2 .mk .na \fB\fIpropVal\fR\fR .ad .RS 11n .rt A property value. .RE .sp .ne 2 .mk .na \fB\fIpropLen\fR\fR .ad .RS 11n .rt The length of the specified property value. If \fIpropLen\fR was of an insufficient size to hold the returned property value, \fIpropLen\fR will contain the required size of the buffer and \fBSTMF_ERROR_INVALID_ARG\fR will be returned. .RE .SH DESCRIPTION .sp .LP 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 \fIprop\fR argument can be one of the following values: .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_ACCESS_STATE\fR\fR .ad .sp .6 .RS 4n Asymmetric access state for the logical unit. Set to one of: .sp .ne 2 .mk .na \fB0\fR .ad .RS 5n .rt Active .RE .sp .ne 2 .mk .na \fB1\fR .ad .RS 5n .rt Transition to Standby .RE .sp .ne 2 .mk .na \fB2\fR .ad .RS 5n .rt Standby .RE .sp .ne 2 .mk .na \fB3\fR .ad .RS 5n .rt Transition to Active .RE .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_ALIAS\fR\fR .ad .sp .6 .RS 4n Up to 255 characters representing a user defined name for the device. .sp Default: Set to file name of backing store. .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_BLOCK_SIZE\fR\fR .ad .sp .6 .RS 4n Numeric value for block size in bytes in 2^n. .sp Default: 512 .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_COMPANY_ID\fR\fR .ad .sp .6 .RS 4n Organizational Unique Identifier. 6 hexadecimal ASCII characters representing the IEEE OUI company id assignment. This will be used to generate the device identifier (GUID). .sp Default: 00144F .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_DATA_FILENAME\fR\fR .ad .sp .6 .RS 4n Character value representing the file name of the backing store device. .sp Default: None .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_GUID\fR\fR .ad .sp .6 .RS 4n 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. .sp Default: Set by framework to a generated value. .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_HOST_ID\fR\fR .ad .sp .6 .RS 4n 8 hexadecimal ASCII characters representing the host ID assignment. This will be used to generate the globally unique identifier (GUID) for the logical unit. .sp Default: identifer returned by \fBhostid\fR(1). .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_META_FILENAME\fR\fR .ad .sp .6 .RS 4n Metadata file name. When specified, will be used to hold the SCSI metadata for the logical unit. .sp Default: None. If this value is not specified, the value specified in \fBSTMF_LU_PROP_DATA_FILENAME\fR will be used. .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_MGMT_URL\fR\fR .ad .sp .6 .RS 4n Up to 1024 characters representing Management Network Address URLs. More than one URL can be passed using space delimited URLs. .sp Default: None .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_PID\fR\fR .ad .sp .6 .RS 4n Up to 16 characters of product identification that will be reflected in the Standard INQUIRY data returned for the device. .sp Default: sSet to COMSTAR. .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_SERIAL_NUM\fR\fR .ad .sp .6 .RS 4n Serial Number. Specifies the SCSI Vital Product Data Serial Number (page 80h). It is a character value up to 252 bytes in length. .sp Default: None .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_SIZE\fR\fR .ad .sp .6 .RS 4n Numeric value w/optional suffix, e.g. 100G, 1T, to specify unit of size. .sp Default: Size of the device specified in the \fBSTMF_LU_PROP_DATA_FILENAME\fR property value. .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_VID\fR\fR .ad .sp .6 .RS 4n 8 characters of vendor identification per SCSI SPC-3 and will be reflected in the Standard INQUIRY data returned for the device. .sp Default: Set to SUN. .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_WC_MODE_SELECT\fR\fR .ad .sp .6 .RS 4n Write cache setting changeable. Specified as "true" or "false". When "true", a SCSI MODE SELECT from the initiator can change the WRITE CACHE ENABLE bit on the caching mode page. When false, the WRITE CACHE ENABLE bit is not changeable. This setting does not impact the ability for \fBstmfadm\fR(1M) or \fBlibstmf\fR(3LIB) to modify the write cache disable setting. .sp Default: "true" .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_WRITE_CACHE_DISABLE\fR\fR .ad .sp .6 .RS 4n Write back cache disable. When specified as "true" or "false", specifies write back cache disable behavior. .sp Default: Writeback cache setting of the backing store device specified by \fBSTMF_LU_PROP_DATA_FILENAME\fR. .RE .sp .ne 2 .mk .na \fB\fBSTMF_LU_PROP_WRITE_PROTECT\fR\fR .ad .sp .6 .RS 4n Write protect bit. When specified as "true" or "false", specifies whether the device behaves as a write protected device. .sp Default: "false" .RE .SH RETURN VALUES .sp .LP The following values are returned: .sp .ne 2 .mk .na \fB\fBSTMF_STATUS_SUCCESS\fR\fR .ad .sp .6 .RS 4n The API call was successful. .RE .sp .ne 2 .mk .na \fB\fBSTMF_ERROR_INVALID_ARG\fR\fR .ad .sp .6 .RS 4n Either \fIprop\fR or \fIpropVal\fR is unrecognized. .RE .sp .ne 2 .mk .na \fB\fBSTMF_ERROR_INVALID_PROPSIZE\fR\fR .ad .sp .6 .RS 4n The size of \fIpropVal\fR is invalid. .RE .sp .ne 2 .mk .na \fB\fBSTMF_ERROR_INVALID_PROP\fR\fR .ad .sp .6 .RS 4n The value of \fIprop\fR is unknown for this resource type. .RE .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp .TS tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ Interface StabilityCommitted _ MT-LevelSafe .TE .SH SEE ALSO .sp .LP \fBhostid\fR(1), \fBstmfadm\fR(1M), \fBlibstmf\fR(3LIB), \fBstmfCreateLuResource\fR(3STMF), \fBstmfGetLuResource\fR(3STMF), \fBattributes\fR(5)