Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_StorageNameBinding --> CIM_SettingData --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_SettingData NAME CIM_StorageNameBinding
Class CIM_StorageNameBinding Qualifiers Name Type Value From Class Experimental boolean true CIM_StorageNameBinding Version string 2.8.1000 CIM_StorageNameBinding Description string StorageNameBinding instances represent bindings between transport-specific devices names and either OS device names/addresses or virtual initiator names. Bindings are defined by administrators and are persistent. The binding defines names of other elements that may or may not correlate to other CIM classes. It must be possible to create these bindings in cases when CIM instances for these other elements are not available. This may be because the elements are temporarily unavailable or because the elements are managed by some other providers or because the binding represents a ’ black listed ’ device name. A SettingData models the persistence of the binding in the absence of the elements. In the descriptions below, FC API refers to the FC API as specified in the t11_5 workgroup, and IMA refers to the iSCSI Management API as specified in the SNIA IPS Management workgroup. Three types of bindings are modeled: - OSStorageNameBinding models a binding from a storage elements to OS device names or addresses (as used in FC API PersistentBindings and IMA ExposeLun. One side of the binding represents a device (as viewed from the system scoping the binding) and the name exposed by the scoping system. For example, Fibre Channel HBAs support binding of Fibre Channel port names (and optionally a SCSI logical unit identifier) to OS device names. Each time the system or device is stopped and restated, the same OS device name is bound to the device. - StorageBridgeNameBinding models gateways where a name valid for one transport is mapped to a name valid for a different transport. This binding is used in bridge devices that allow Infiniband or iSCSI host adapters to connect to Fibre Channel devices. - The third type of binding is similar to the first, but no OS device name or address is provided, the OS uses its usual rules to assign names. For this type of binding, the superclass can be used. CIM_StorageNameBinding Description string The SettingData class represents configuration-related and operational parameters for one or more ManagedElements. A ManagedElement can have multiple SettingData objects associated with it. The current operational values for the parameters of the element are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values that are present in the SettingData object. For example, a modem might have a SettingData baud rate of 56Kb/sec but be operating at 19.2Kb/sec. Note: The CIM_SettingData class is very similar to CIM_Setting, yet both classes are present in the model because many implementations have successfully used CIM_Setting. However, issues have arisen that could not be resolved without defining a new class. Therefore, until a new major release occurs, both classes will exist in the model. Refer to the Core White Paper for additional information. SettingData instances can be aggregated together into higher- level SettingData objects using ConcreteComponent associations. CIM_SettingData Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Properties Name Type Value Qualifiers ClassOrigin BindingType uint16 Description
ValueMap
Values
MappingStringsCIM_StorageNameBinding BindAllLogicalUnits boolean false Description
MappingStrings
ModelCorrespondenceCIM_StorageNameBinding Hide boolean false Description CIM_StorageNameBinding TargetName string Description
MappingStringsCIM_StorageNameBinding LogicalUnitNumber string Description
MappingStrings
ModelCorrespondenceCIM_StorageNameBinding Status uint32 Description
ValueMap
Values
MappingStrings
ModelCorrespondenceCIM_StorageNameBinding OtherStatus string Description
ModelCorrespondenceCIM_StorageNameBinding LocalPortNameType uint16 Description
ValueMap
Values
ModelCorrespondenceCIM_StorageNameBinding LocalPortName string Description
MappingStrings
ModelCorrespondenceCIM_StorageNameBinding InstanceID string Key
DescriptionCIM_SettingData ElementName string Required
Override
DescriptionCIM_SettingData Caption string Description
MaxLenCIM_ManagedElement Description string Description CIM_ManagedElement Property Qualifiers
Property BindingType Qualifiers Name Type Value From Class Description string BindingType describes the type of binding expressed by the setting data instance. It also defines the interpretation of TargetName. BindToFcDID, FcApiBindToWWPN, and FcApiBindToWWNW represent bindings in a fibre channel HBA to a D_ID (destination ID), WWPN (World Wide Port Name), or WWNW (World Wide Node Name). LUID is a binding based on a SCSI Inquiry VPD page 83, Association 0 logical unit identifier. ’ iSCSI Name ’ represents a binding to an iSCSI target as used in IMA for Static Configuration (if TargetLUNumberValid is false) or an IMA (Un)Exposed LUN record (if TargetLUNumberValid is true). ’ iSCSI Network Address ’ represents a binding to an iSCSI network entity. It is formatted as a host name or IP address optionally followed by a plus ( ’ + ’ ) and a TCP port number. If ’ +port < # > ’ is omitted, the iSCSI default (3260) is used. ’ Bridge Binding ’ represents a binding between initiator IDs in a transport bridge device. CIM_StorageNameBinding ValueMap string [See below.] CIM_StorageNameBinding Values string FcApiBindToDID
FcApiBindToWWPN
FcApiBindToWWNN
BindToLUID
iSCSI Target Name
iSCSI Network Address
Bridge BindingCIM_StorageNameBinding MappingStrings string FC API.INCITS-T11| HBA_BIND_TYPE CIM_StorageNameBinding
Name Value 2 FcApiBindToDID 3 FcApiBindToWWPN 4 FcApiBindToWWNN 5 BindToLUID 6 iSCSI Target Name 7 iSCSI Network Address 8 Bridge Binding
Property BindAllLogicalUnits Qualifiers Name Type Value From Class Description string If true, then all target logical units are bound to the OS. Not valid to set this if BindingType is BindToLUID. CIM_StorageNameBinding MappingStrings string FC API.INCITS-T11| HBA_BIND_TARGETS CIM_StorageNameBinding ModelCorrespondence string CIM_StorageNameBinding.LogicalUnitNumber
CIM_StorageNameBinding.BindingTypeCIM_StorageNameBinding
Property Hide Qualifiers Name Type Value From Class Description string If false (the default), the specified target unit(s) is exposed to the OS. If true, the OS-related properties are ignored, and the target related properties identify target unit(s) that are hidden from the OS. In most cases, this is false. CIM_StorageNameBinding
Property TargetName Qualifiers Name Type Value From Class Description string The name (dependent on BindingType) identifying the SCSI target. If BindingType is FcApiBindToDID, TargetName holds a hexadecimal-encoded representation of the 32-bit D_ID and corresponds to FC API HBA_FCPID.FcId. If BindingType is FcApiBindToWWPN or FcApiBindToWWNN, TargetName holds a hexadecimal-encoded representation of the 64-bit FC Port or Node World Wide Name. If BindingType is BindToLUID, TargetName holds a SCSI Logical Unit Name from Inquiry VPD page 83, Association 0 as defined in SCSI Primary Commands. If the identifier descriptor (in the SCSI response) has Code Set Binary, then TargetName is its hexadecimal-encoded value. CIM_StorageNameBinding MappingStrings string FC API.INCITS-T11| HBA_FcpId | FcId
FC API.INCITS-T11| HBA_FcpId | NodeWWN
FC API.INCITS-T11| HBA_FcpId | PortWWN
FC API.INCITS-T11| HBA_FcpId | FcId
FC API.INCITS-T11| HBA_LUIDCIM_StorageNameBinding
Property LogicalUnitNumber Qualifiers Name Type Value From Class Description string A string containing a hexadecimal-encoded representation of the 64-bit SCSI Logical Unit Number in the format described in the T10 SCSI Architecture Model specification. This format consists of four 2-byte fields. In most cases, the human-oriented logical unit number will be in the high- order two bytes and the low-order six bytes will be zero. This property is only valid if BindAllLogicalUnits is false and BindingType is not . CIM_StorageNameBinding MappingStrings string FC API.INCITS-T11| HBA_FcpId | FcpLun CIM_StorageNameBinding ModelCorrespondence string CIM_StorageNameBinding.BindAllLogicalUnits CIM_StorageNameBinding
Property Status Qualifiers Name Type Value From Class Description string A status associated with the previous attempt to enable the binding - this may be set many times after the binding is created. The first subset is defined by FC API: BadOSBus - request included a bad OS SCSI bus number BadOSTarget - request included a bad SCSI target number BadOSLun - request included a bad OS SCSI logical unit number OSAddressAlreadyBound - request included an OS SCSI ID that was already bound BadFcid - request included a bad or unlocatable FCP Target FCID BadWWNN - request included a bad FCP Target Node_Name BadWWPN - request included a bad FCP Target Port Name BadTargetLU - request included an FCP Logical Unit Number not defined by the identified Target. BadLUID - request included an undefined in inaccessible LUID. CIM_StorageNameBinding ValueMap string [See below.] CIM_StorageNameBinding Values string Unknown
Other
OK
BadOSBus
BadOSTarget
BadOSLun
BadFcId
BadWWNN
BadWWPN
BadTargetLU
BadLUIDCIM_StorageNameBinding MappingStrings string FC API.INCITS-T11|HBA_FCPBINDING2|Status CIM_StorageNameBinding ModelCorrespondence string CIM_StorageNameBinding.OtherStatus CIM_StorageNameBinding
Name Value 0 Unknown 1 Other 2 OK 3 BadOSBus 4 BadOSTarget 5 BadOSLun 6 BadFcId 7 BadWWNN 8 BadWWPN 9 BadTargetLU 10 BadLUID
Property OtherStatus Qualifiers Name Type Value From Class Description string A string describing the status if Status is ’ Other ’ . CIM_StorageNameBinding ModelCorrespondence string CIM_StorageNameBinding.Status CIM_StorageNameBinding
Property LocalPortNameType Qualifiers Name Type Value From Class Description string The type of the port in LocalPortName. CIM_StorageNameBinding ValueMap string [See below.] CIM_StorageNameBinding Values string FC Port WWN
iSCSI NameCIM_StorageNameBinding ModelCorrespondence string CIM_StorageNameBinding.LocalPortName CIM_StorageNameBinding
Name Value 2 FC Port WWN 3 iSCSI Name
Property LocalPortName Qualifiers Name Type Value From Class Description string The port name on the current system associated with this persistent binding. CIM_StorageNameBinding MappingStrings string FC API.INCITS-T11|hbaPortWWN CIM_StorageNameBinding ModelCorrespondence string CIM_StorageNameBinding.LocalPortNameType CIM_StorageNameBinding
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_SettingData Description string 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. CIM_SettingData
Property ElementName Qualifiers Name Type Value From Class Required boolean true CIM_SettingData Override string ElementName CIM_SettingData Description string 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.) CIM_SettingData
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. CIM_ManagedElement
Method Qualifiers
Parameters
Parameter Qualifiers