Device\CIM_StorageNameBinding.mof.mof (HTML version)

Return to index
CIM_StorageNameBinding Superclass: CIM_SettingData
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.
Qualifiers:Version ( "2.8.1000" ) Experimental UMLPackagePath ( "CIM::Device::StorageNameBinding" )
Parameters (local in grey)
ValueMap { "2" , "3" }
Values { "FC Port WWN" , "iSCSI Name" }
ModelCorrespondence { "CIM_StorageNameBinding.LocalPortName" }
uint16 LocalPortNameType ;
The type of the port in LocalPortName.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" }
Values { "Unknown" , "Other" , "OK" , "BadOSBus" , "BadOSTarget" , "BadOSLun" , "BadFcId" , "BadWWNN" , "BadWWPN" , "BadTargetLU" , "BadLUID" }
MappingStrings { "FC API.INCITS-T11|HBA_FCPBINDING2|Status" }
ModelCorrespondence { "CIM_StorageNameBinding.OtherStatus" }
uint32 Status ;
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.
MappingStrings { "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_LUID" }
String TargetName ;
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.
MappingStrings { "FC API.INCITS-T11| HBA_BIND_TARGETS" }
ModelCorrespondence { "CIM_StorageNameBinding.LogicalUnitNumber" , "CIM_StorageNameBinding.BindingType" }
boolean BindAllLogicalUnits = false ;
If true, then all target logical units are bound to the OS. Not valid to set this if BindingType is BindToLUID.
boolean Hide = false ;
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.
MappingStrings { "FC API.INCITS-T11| HBA_FcpId | FcpLun" }
ModelCorrespondence { "CIM_StorageNameBinding.BindAllLogicalUnits" }
string LogicalUnitNumber ;
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 .
MappingStrings { "FC API.INCITS-T11|hbaPortWWN" }
ModelCorrespondence { "CIM_StorageNameBinding.LocalPortNameType" }
string LocalPortName ;
The port name on the current system associated with this persistent binding.
ModelCorrespondence { "CIM_StorageNameBinding.Status" }
string OtherStatus ;
A string describing the status if Status is 'Other'.
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" }
Values { "FcApiBindToDID" , "FcApiBindToWWPN" , "FcApiBindToWWNN" , "BindToLUID" , "iSCSI Target Name" , "iSCSI Network Address" , "Bridge Binding" }
MappingStrings { "FC API.INCITS-T11| HBA_BIND_TYPE" }
uint16 BindingType ;
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.
ValueMap { "0" , "1" , "2" , "3" }
Values { "Not Changeable - Persistent" , "Changeable - Transient" , "Changeable - Persistent" , "Not Changeable - Transient" }
Experimental
uint16 ChangeableType ;
Enumeration indicating the type of setting.
0 'Not Changeable - Persistent' indicates the instance of SettingData represents primordial settings and shall not be modifiable. 1 'Changeable - Transient' indicates the SettingData represents modifiable settings that are not persisted. Establishing persistent settings from transient settings may be supported.
2 'Changeable - Persistent' indicates the SettingData represents a persistent configuration that may be modified.
3 'Not Changeable - Transient' indicates the SettingData represents a snapshot of the settings of the associated ManagedElement and is not persistent.
Required
Override ( "ElementName" )
string 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.)
Experimental
string ConfigurationName ;
An instance of CIM_SettingData may correspond to a well-known configuration that exists for an associated CIM_ManagedElement. If the ConfigurationName property is non-NULL, the instance of CIM_SettingData shall correspond to a well-known configuration for a Managed Element, the value of the ConfigurationName property shall be the name of the configuration, and the ChangeableType property shall have the value 0 or 2. A value of NULL for the ConfigurationName property shall mean that the instance of CIM_SettingData does not correspond to a well-known configuration for a Managed Element or that this information is unknown.
Key
string InstanceID ;
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.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string Description ;
The Description property provides a textual description of the object.