CIM_ProtocolControllerForUnit class

This association is used to define a relationship between a ProtocolController and an exposed Logical Unit (for example a Storage Volume or a MediaAccessDevice such as a tape drive). An example of the use of this association is SCSI, where it link the target controller and Logical Units. This subclass is provided so that an enumeration of related controllers and units can be performed without retrieving any connected ports or other controllers.

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

Syntax

[Association, Abstract, Version("2.8.0"), UMLPackagePath("CIM::Device::ProtocolController")]
class CIM_ProtocolControllerForUnit : CIM_ProtocolControllerForDevice
{
  string                     DeviceNumber;
  uint16                     AccessPriority;
  uint16                     AccessState;
  CIM_ProtocolController REF Antecedent;
  CIM_LogicalDevice      REF Dependent;
  uint16                     DeviceAccess;
};

Members

The CIM_ProtocolControllerForUnit class has these types of members:

Properties

The CIM_ProtocolControllerForUnit class has these properties.

AccessPriority

Data type: uint16

Access type: Read-only

This property describes the priority given to accesses of the device through this Controller. The highest priority path will have the lowest value for this parameter.

This property is inherited from CIM_ProtocolControllerForDevice.

AccessState

Data type: uint16

Access type: Read-only

The AccessState property describes the accessibility of the LogicalDevice through the ProtocolController.

Unknown (0) indicates the instrumentation does not know whether access is or is not functioning.

Active (2) indicates normal access.

Inactive (3) indicates the instrumentation knows this path is not active, and one of the other values (below) does not apply.

Replication in Progress (4) indicates that the path is temporarily inactive due to a replication activity.

Mapping Inconsistency (5) indicates the instrumentation has detected that this path is inactive due to an inconsistency in the DeviceNumber/DeviceAccess configuration.

This property is inherited from CIM_ProtocolControllerForDevice.

Unknown (0)

Active (2)

Inactive (3)

Replication In Progress (4)

Mapping Inconsistency (5)

Antecedent

Data type: CIM_ProtocolController

Access type: Read-only

Qualifiers: Override ("Antecedent")

The ProtocolController.

Dependent

Data type: CIM_LogicalDevice

Access type: Read-only

Qualifiers: Override ("Dependent")

The logical unit (eg StorageVolume) 'behind' the ProtocolController.

DeviceAccess

Data type: uint16

Access type: Read-only

The access rights granted to the referenced logical unit as exposed through referenced ProtocolController. The 'No Access' value is used in implementations where the DeviceNumber is reserved, but no access is granted.

If the instrumentation exposes PrivilegeManagementService, this property MUST be synchronized with the Activities property of any Privilege instances associated with StorageHardwareIDs associated to the referenced ProtocolController and the referenced LogicalDevice. In particular, when this property is 'Read Write', Privilege.Activities MUST include entries for 'Read' and 'Write'. When this property is 'Read-Only', Privilege.Activities MUST include an entry for 'Read'. The corresponding entries for Privilege.ActivityQualifiers MUST be 'CDB=*' and the corresponding entries for Privilege.QualifierFormat MUST be 'SCSI Command'.

Unknown (0)

Read Write (2)

Read-Only (3)

No Access (4)

DMTF Reserved

5 15999

Vendor Reserved

16000 65535

DeviceNumber

Data type: string

Access type: Read-only

Address of the associated Device in the context of the Antecedent Controller.

This property is inherited from CIM_ProtocolControllerForDevice.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012 R2
Namespace
Root\CIMv2\Storage\iScsiTarget
MOF
SmIscsiTarget.mof
DLL
SMiSCSITargetProv.dll

See also

CIM_ProtocolControllerForDevice