Windows Dev Center

Collapse the table of content
Expand the table of content
Expand Minimize

MSISCSITARGET_StorageClientSettingData class

Represents a model of host environment factors that influence the behavior of elements of a storage system.

Instances of this setting class can be associated with different elements by using a MSISCSITARGET_ElementSettingData instance. For example, CIM_LogicalPort, MSISCSITARGET_SCSIProtocolController, or MSISCSITARGET_StorageVolume instances can be associated with an MSISCSITARGET_StorageClientSettingData instance. The management instrumentation provider creates these associations to reflect the current configuration. The storage system exposes all supported setting instances to a Web-Based Enterprise Management (WBEM) Enumerate request.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Static, Version("1.0.0")]
class MSISCSITARGET_StorageClientSettingData : CIM_StorageClientSettingData
{
  string Caption;
  string Description;
  string InstanceID;
  string ElementName;
  uint16 ClientTypes[];
  string OtherClientTypeDescriptions[];
};

Members

The MSISCSITARGET_StorageClientSettingData class has these types of members:

Properties

The MSISCSITARGET_StorageClientSettingData class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

ClientTypes
Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed") , ModelCorrespondence ("CIM_StorageClientSettingData.OtherClientTypeDescriptions")

This enumeration defines operating system, version, driver, and other host environment factors that influence the behavior exposed by storage systems. Values in this array are combined with data from the OtherClientTypeDescriptions property to provide complete information on the host environment.

"Microsoft Windows" indicates generic Windows operating system. To utilize features of a specific Windows operating system, use the corresponding value for that Windows operating system, for example, "Microsoft Windows Server 2008".

This property is inherited from CIM_StorageClientSettingData.

Unknown (0)
Other (1)
Standard (2)
Solaris (3)
HPUX (4)
OpenVMS (5)
Tru64 (6)
Netware (7)
Sequent (8)
AIX (9)
DGUX (10)
Dynix (11)
Irix (12)
Cisco iSCSI Storage Router (13)
Linux (14)
Microsoft Windows (15)
OS400 (16)
TRESPASS (17)
HI-UX (18)
VMware ESXi (19)
Microsoft Windows Server 2008 (20)
Microsoft Windows Server 2003 (21)
DMTF Reserved (22–32767)
Vendor Specific (32768–65535)
Description
Data type: string
Access type: Read-only

Contains a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName
Data type: string
Access type: Read-only
Qualifiers: Required, Override ("ElementName")

The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)

This property is inherited from CIM_SettingData.

InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:

<OrgID>:<LocalID>

Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.

<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.

For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.

This property is inherited from CIM_SettingData.

OtherClientTypeDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed") , ModelCorrespondence ("CIM_StorageClientSettingData.ClientTypes")

When the the corresponding array entry in ClientTypes[] is "Other", this entry provides a string describing the manufacturer and OS/Environment. When the corresponding ClientTypes[] entry is not "Other", this entry allows variations or qualifications of ClientTypes - for example, different versions of Solaris.

This property is inherited from CIM_StorageClientSettingData.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 R2

Namespace

Root\cimv2\storage\iscsitarget

MOF

SmIscsiTarget.mof

DLL

SmIscsiTarg.dll

See also

CIM_StorageClientSettingData
iSCSI Target Server Reference
MSISCSITARGET_ReplicationService
MSISCSITARGET_ElementCapabilities
MSISCSITARGET_ElementSettingData

 

 

Show:
© 2015 Microsoft