Class CIM_StorageNameBinding

extends 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.
Details...
This class is not implemented.

Subclasses

CIM_OSStorageNameBinding CIM_StorageBridgeNameBinding

Class Qualifiers

Name	Data Type	Value	Scope	Flavors
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.	None	TRANSLATABLE= true
Experimental	boolean	true	TOSUBCLASS= false	None
UMLPackagePath	string	CIM::Device::StorageNameBinding	None	None
Version	string	2.8.1000	TOSUBCLASS= false	TRANSLATABLE= true

Local Class Properties

Name	Data Type	Qualifiers
Name	Data Type	Name	Data Type	Value	Scope	Flavors
BindAllLogicalUnits	boolean
		Description	string	If true, then all target logical units are bound to the OS. Not valid to set this if BindingType is BindToLUID.	None	TRANSLATABLE= true
		MappingStrings	string	FC API.INCITS-T11\| HBA_BIND_TARGETS	None	None
		ModelCorrespondence	string	CIM_StorageNameBinding.LogicalUnitNumber, CIM_StorageNameBinding.BindingType	None	None
BindingType	uint16
		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.	None	TRANSLATABLE= true
		MappingStrings	string	FC API.INCITS-T11\| HBA_BIND_TYPE	None	None
		ValueMap	string	2, 3, 4, 5, 6, 7, 8	None	None
		Values	string	FcApiBindToDID, FcApiBindToWWPN, FcApiBindToWWNN, BindToLUID, iSCSI Target Name, iSCSI Network Address, Bridge Binding	None	TRANSLATABLE= true
Caption	string
		Description	string	The Caption property is a short textual description (one- line string) of the object.	None	TRANSLATABLE= true
		MaxLen	uint32	64	None	None
ChangeableType	uint16
		Description	string	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.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
		ValueMap	string	0, 1, 2, 3	None	None
		Values	string	Not Changeable - Persistent, Changeable - Transient, Changeable - Persistent, Not Changeable - Transient	None	TRANSLATABLE= true
ConfigurationName	string
		Description	string	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.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
Description	string
Description	string	Description	string	The Description property provides a textual description of the object.	None	TRANSLATABLE= true
ElementName	string
		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.)	None	TRANSLATABLE= true
		Override	string	ElementName	TOSUBCLASS= false	None
		Required	boolean	true	None	OVERRIDABLE= false
Generation	uint64
		Description	string	Generation is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class. If Generation is supported by the implementation, its value shall not be null. Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation. After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification. Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update. Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance. Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated. Subclasses may define additional requirements for updates on some or all of related instances. For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years. This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail. The usage of this property is intended to be further specified by applicable management profiles. Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation. For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
Hide	boolean
Hide	boolean	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.	None	TRANSLATABLE= true
InstanceID	string
		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.	None	TRANSLATABLE= true
		Key	boolean	true	None	OVERRIDABLE= false
		Override	string	InstanceID	TOSUBCLASS= false	None
LocalPortName	string
		Description	string	The port name on the current system associated with this persistent binding.	None	TRANSLATABLE= true
		MappingStrings	string	FC API.INCITS-T11\|hbaPortWWN	None	None
		ModelCorrespondence	string	CIM_StorageNameBinding.LocalPortNameType	None	None
LocalPortNameType	uint16
		Description	string	The type of the port in LocalPortName.	None	TRANSLATABLE= true
		ModelCorrespondence	string	CIM_StorageNameBinding.LocalPortName	None	None
		ValueMap	string	2, 3	None	None
		Values	string	FC Port WWN, iSCSI Name	None	TRANSLATABLE= true
LogicalUnitNumber	string
		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 .	None	TRANSLATABLE= true
		MappingStrings	string	FC API.INCITS-T11\| HBA_FcpId \| FcpLun	None	None
		ModelCorrespondence	string	CIM_StorageNameBinding.BindAllLogicalUnits	None	None
OtherStatus	string
		Description	string	A string describing the status if Status is 'Other'.	None	TRANSLATABLE= true
		ModelCorrespondence	string	CIM_StorageNameBinding.Status	None	None
Status	uint32
		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.	None	TRANSLATABLE= true
		MappingStrings	string	FC API.INCITS-T11\|HBA_FCPBINDING2\|Status	None	None
		ModelCorrespondence	string	CIM_StorageNameBinding.OtherStatus	None	None
		ValueMap	string	0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10	None	None
		Values	string	Unknown, Other, OK, BadOSBus, BadOSTarget, BadOSLun, BadFcId, BadWWNN, BadWWPN, BadTargetLU, BadLUID	None	TRANSLATABLE= true
TargetName	string
		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.	None	TRANSLATABLE= true
		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_LUID	None	None