CIM_ProtocolControllerMaskingCapabilities class

Article
05/31/2018

A subclass of Capabilities that defines the Masking-related capabilities of a ProtocolController.

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

Syntax

[Abstract, Version("2.10.0"), UMLPackagePath("CIM::Device::ProtocolController")]
class CIM_ProtocolControllerMaskingCapabilities : CIM_Capabilities
{
  string  Caption;
  string  Description;
  string  InstanceID;
  string  ElementName;
  uint16  ValidHardwareIdTypes[];
  string  OtherValidHardwareIDTypes[];
  uint16  PortsPerView = 2;
  boolean ClientSelectableDeviceNumbers = TRUE;
  boolean AttachDeviceSupported;
  boolean OneHardwareIDPerView = FALSE;
  boolean UniqueUnitNumbersPerPort = FALSE;
  boolean PrivilegeDeniedSupported = FALSE;
  boolean ProtocolControllerRequiresAuthorizedIdentity = FALSE;
  boolean ProtocolControllerSupportsCollections = FALSE;
  boolean ExposePathsSupported;
  boolean CreateProtocolControllerSupported;
  uint16  MaximumMapCount = 0;
  boolean SPCAllowsNoLUs = FALSE;
  boolean SPCAllowsNoTargets = FALSE;
  boolean SPCAllowsNoInitiators = FALSE;
  boolean SPCSupportsDefaultViews = TRUE;
};

Members

The CIM_ProtocolControllerMaskingCapabilities class has these types of members:

Properties

Properties

The CIM_ProtocolControllerMaskingCapabilities class has these properties.

AttachDeviceSupported

Data type: boolean
Access type: Read-only

Set to true if this storage system supports the AttachDevice method.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

ClientSelectableDeviceNumbers

Data type: boolean
Access type: Read-only

Set to true if this storage system allows the client to specify the DeviceNumber parameter when calling ControllerConfigurationService.AttachDevice() or specify the DeviceNumbers parameter when calling ControllerConfigurationService.ExposePaths(). Set to false if the implementation does not allow unit numbers to vary for a ProtocolController. However, if set to false and a Device is not the Dependent of a ProtocolControllerForUnit association, the client MUST provide a DeviceNumber parameter in ControllerConfigurationService.AttachDevice or ControllerConfigurationService.ExposePaths. If set to false and the Device is already the Dependent of a ProtocolControllerForUnit association, then the client can omit the DeviceNumber parameter (or supply the same value) in subsequent ControllerConfigurationService.AttachDevice calls.

CreateProtocolControllerSupported

Data type: boolean
Access type: Read-only

Set to true if this storage system supports the CreateProtocolControllerWithPorts method.

Description

Data type: string
Access type: Read-only

Contains a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string
Access type: Read-only
Qualifiers: Required

The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.)

This property is inherited from CIM_Capabilities.

ExposePathsSupported

Data type: boolean
Access type: Read-only

Set to true if this storage system supports the ExposePaths and HidePaths methods.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order 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 creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This 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 re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace. For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.

This property is inherited from CIM_Capabilities.

MaximumMapCount

Data type: uint16
Access type: Read-only

The maximum number of ProtocolCOntrollerForUnit associations that can be associated with a single LogicalDevice (for example, StorageVolume). Zero indicates there is no limit.

OneHardwareIDPerView

Data type: boolean
Access type: Read-only

Set to true if this storage system limits configurations to a single subject hardware ID per view. Otherwise, multiple hardware ID types can be used. The default is FALSE, that multiple ID types MAY be used in a single view.

OtherValidHardwareIDTypes

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

An array of strings describing types for valid StorageHardwareID.IDType. Used when the ValidHardwareIdTypes includes 1 ("Other").

PortsPerView

Data type: uint16
Access type: Read-only

An integer enumeration indicating the way that ports per view (ProtocolController) are handled by the underlying storage system.

One Port per View (2)

Multiple Ports per View (3)

All Ports share the same View (4)

PrivilegeDeniedSupported

Data type: boolean
Access type: Read-only

Set to true if this storage system allows a client to create a Privilege instance with PrivilegeGranted set to FALSE.

ProtocolControllerRequiresAuthorizedIdentity

Data type: boolean
Access type: Read-only

If true, this property indicates that a Privilege/Identity pair MUST be specified when CreateProtocolControllerWithPorts() is called. If false, then the Privilege/Identity pair in CreateProtocolControllerWithPorts() MUST NOT be set.

ProtocolControllerSupportsCollections

Data type: boolean
Access type: Read-only

If true, this property indicates that the Identity parameter of CreateProtocolConntrollerWithPorts() MUST contain a reference to a CIM_Collection (or subclass) or to a CIM_Identity (or subclass). If ExposePathsSupported is true, this property indicates the storage system supports SystemSpecificCollections of StorageHardwareIDs.

SPCAllowsNoInitiators

Data type: boolean
Access type: Read-only

Set to true if the instumentation allows a client to create a configuration where an SPC has no StorageHardwareIDs associated via CIM_AuthorizedTarget/CIM_AuthorizedPrivilege/CIM_AuthorizedSubject.

SPCAllowsNoLUs

Data type: boolean
Access type: Read-only

Set to true if the instumentation allows a client to create a configuration where an SPC has no LogicalDevices associated via CIM_ProtocolControllerForUnit associations.

SPCAllowsNoTargets

Data type: boolean
Access type: Read-only

Set to true if the instumentation allows a client to create a configuration where an SPC has no target SCSIProtocolEndpoints associated via CIM_SAPAvailableForELement associations.

SPCSupportsDefaultViews

Data type: boolean
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ProtocolControllerMaskingCapabilities.PortsPerView")

Set to true if it the instrumentation supports 'default view' SPCs that exposes logical units to all initiators (so called 'promiscuous LUNs'. Default view SPCs MUST have be associated to a CIM_StorageHardwareID instance with Name set to the null string. A target port MUST NOT be associated with more a single default view SPC. If PortsPerView is 'All Ports share the same View', then at most one default view SPC MAY be associated with the target system. If SPCAllowsNoLUs is true, the instrumentation MAY instantiate a static default view instance or let the client create one as needed using ExposePaths. For other values of PortsPerView, all default view SPC MUST share the same null-Name CIM_StorageHardwareID instance.

UniqueUnitNumbersPerPort

Data type: boolean
Access type: Read-only

When set to false, different ProtocolContollers attached to a LogicalPort can expose the same unit numbers. If true, then this storage system requires unique unit numbers across all the ProtocolControllers connected to a LogicalPort.

ValidHardwareIdTypes

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

A list of the valid values for StrorageHardwareID.IDType. iSCSI IDs MAY use one of three iSCSI formats - iqn, eui, or naa. This three letter format is the name prefix; so a single iSCSI type is provided here, the prefix can be used to further refine the format.

Other (1)

Port WWN (2)

Node WWN (3)

Host Name (4)

iSCSI Name (5)

Requirements


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

CIM_ProtocolControllerMaskingCapabilities class

Syntax

Members

Properties

Requirements

See also

Additional resources