<head><META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="mof.css" xmlns:lxslt="http://xml.apache.org/xslt">
<title>DMTF Schema Documentation Schema Documentation</title>
</head><html>
<body bgcolor="White">
<hr>
</hr>
<a name="CIM_StorageNameBinding"></a>
<H1>Class CIM_StorageNameBinding<BR>extends <a href="CIM_SettingData.html">CIM_SettingData</a>
</H1>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.<h3>
Table of Contents<br>
<a href="#c_hierarchy">Hierarchy</a>
<br>
<a href="#c_subclasses">Direct Known Subclasses</a>
<br>
<a href="#c_qualifiers">Class Qualifiers</a>
<br>
<a href="#c_properties">Class Properties</a>
<br>
<a href="#c_methods">Class Methods</a>
<br>
</h3>
<hr>
</hr>
<H2>
<a name="c_hierarchy">Class Hierarchy</a>
</H2>
<a href="CIM_ManagedElement.html">CIM_ManagedElement</a>
<br data="@NAME"> |<br> +--<a href="CIM_SettingData.html">CIM_SettingData</a>
<br data="@NAME"> |<br> +--<b>CIM_StorageNameBinding</b>
<br data="CIM_StorageNameBinding -- CIM_SettingData">
<H2>
<a name="c_subclasses">Direct Known Subclasses</a>
</H2>
<a href="CIM_OSStorageNameBinding.html">CIM_OSStorageNameBinding</a>
<BR>
<a href="CIM_StorageBridgeNameBinding.html">CIM_StorageBridgeNameBinding</a>
<BR>
<H2>
<a name="c_qualifiers">Class Qualifiers</a>
</H2>
<TABLE BORDER="1" CELLPADDING="1" WIDTH="100%">
<TR>
<TH>Name</TH><TH>Data Type</TH><TH>Value</TH>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD>
</TR>
<TR>
<TD VALIGN="TOP">Experimental</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD>
</TR>
<TR>
<TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::Device::StorageNameBinding</TD>
</TR>
<TR>
<TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.8.1000</TD>
</TR>
</TABLE>
<H2>
<a name="c_properties">Class Properties</a>
</H2>
<H3>Local Class Properties</H3>
<TABLE WIDTH="100%" CELLPADDING="1" BORDER="1">
<TR>
<TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Data Type</B></TH><TH ROWSPAN="2"><B>Default Value</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH>
</TR>
<TR>
<TH>Name</TH><TH>Data Type</TH><TH>Value</TH>
</TR>
<TR>
<TH ROWSPAN="4" VALIGN="TOP">BindAllLogicalUnits</TH><TD ROWSPAN="4" VALIGN="TOP">boolean</TD><TD ROWSPAN="4" VALIGN="TOP">false</TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">If true, then all target logical units are bound to the OS. Not valid to set this if BindingType is BindToLUID.</TD>
</TR>
<TR>
<TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">FC API.INCITS-T11| HBA_BIND_TARGETS</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_StorageNameBinding.LogicalUnitNumber, CIM_StorageNameBinding.BindingType</TD>
</TR>
<TR>
<TH ROWSPAN="5" VALIGN="TOP">BindingType</TH><TD ROWSPAN="5" VALIGN="TOP">uint16</TD><TD ROWSPAN="5" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD>
</TR>
<TR>
<TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">FC API.INCITS-T11| HBA_BIND_TYPE</TD>
</TR>
<TR>
<TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2, 3, 4, 5, 6, 7, 8</TD>
</TR>
<TR>
<TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">FcApiBindToDID, FcApiBindToWWPN, FcApiBindToWWNN, BindToLUID, iSCSI Target Name, iSCSI Network Address, Bridge Binding</TD>
</TR>
<TR>
<TH ROWSPAN="2" VALIGN="TOP">Hide</TH><TD ROWSPAN="2" VALIGN="TOP">boolean</TD><TD ROWSPAN="2" VALIGN="TOP">false</TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD>
</TR>
<TR>
<TH ROWSPAN="4" VALIGN="TOP">LocalPortName</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD><TD ROWSPAN="4" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The port name on the current system associated with this persistent binding.</TD>
</TR>
<TR>
<TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">FC API.INCITS-T11|hbaPortWWN</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_StorageNameBinding.LocalPortNameType</TD>
</TR>
<TR>
<TH ROWSPAN="5" VALIGN="TOP">LocalPortNameType</TH><TD ROWSPAN="5" VALIGN="TOP">uint16</TD><TD ROWSPAN="5" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The type of the port in LocalPortName.</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_StorageNameBinding.LocalPortName</TD>
</TR>
<TR>
<TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2, 3</TD>
</TR>
<TR>
<TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">FC Port WWN, iSCSI Name</TD>
</TR>
<TR>
<TH ROWSPAN="4" VALIGN="TOP">LogicalUnitNumber</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD><TD ROWSPAN="4" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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 .</TD>
</TR>
<TR>
<TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">FC API.INCITS-T11| HBA_FcpId | FcpLun</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_StorageNameBinding.BindAllLogicalUnits</TD>
</TR>
<TR>
<TH ROWSPAN="3" VALIGN="TOP">OtherStatus</TH><TD ROWSPAN="3" VALIGN="TOP">string</TD><TD ROWSPAN="3" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A string describing the status if Status is 'Other'.</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_StorageNameBinding.Status</TD>
</TR>
<TR>
<TH ROWSPAN="6" VALIGN="TOP">Status</TH><TD ROWSPAN="6" VALIGN="TOP">uint32</TD><TD ROWSPAN="6" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD>
</TR>
<TR>
<TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">FC API.INCITS-T11|HBA_FCPBINDING2|Status</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_StorageNameBinding.OtherStatus</TD>
</TR>
<TR>
<TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10</TD>
</TR>
<TR>
<TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unknown, Other, OK, BadOSBus, BadOSTarget, BadOSLun, BadFcId, BadWWNN, BadWWPN, BadTargetLU, BadLUID</TD>
</TR>
<TR>
<TH ROWSPAN="3" VALIGN="TOP">TargetName</TH><TD ROWSPAN="3" VALIGN="TOP">string</TD><TD ROWSPAN="3" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD>
</TR>
<TR>
<TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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</TD>
</TR>
</TABLE>
<H3>Inherited Properties</H3>
<TABLE BORDER="1" CELLPADDING="1" WIDTH="60%">
<TR>
<TH>Name</TH><TH>Data Type</TH><TH>Class Origin</TH>
</TR>
<TR>
<TH VALIGN="TOP">Caption</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">ChangeableType</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_SettingData.html">CIM_SettingData</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">ConfigurationName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_SettingData.html">CIM_SettingData</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">Description</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">ElementName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_SettingData.html">CIM_SettingData</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">Generation</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">InstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_SettingData.html">CIM_SettingData</a></TD>
</TR>
</TABLE>
<h2>
<a name="c_methods">Class Methods</a>
</h2>
</body>
</html>
