Device\CIM_ProtocolControllerMaskingCapabilities.mof.mof (HTML version)

Return to index
CIM_ProtocolControllerMaskingCapabilities Superclass: CIM_Capabilities
A subclass of Capabilities that defines the Masking-related capabilities of a ProtocolController.
Qualifiers:Version ( "2.10.0" )
Parameters (local in grey)
Experimental
uint16 MaximumMapCount = 0 ;
The maximum number of ProtocolCOntrollerForUnit associations that can be associated with a single LogicalDevice (for example, StorageVolume). Zero indicates there is no limit.
Experimental
boolean SPCAllowsNoLUs = FALSE ;
Set to true if the instumentation allows a client to create a configuration where an SPC has no LogicalDevices associated via CIM_ProtocolControllerForUnit associations.
Experimental
boolean CreateProtocolControllerSupported ;
Set to true if this storage system supports the CreateProtocolControllerWithPorts method.
boolean OneHardwareIDPerView = FALSE ;
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.
Values { "One Port per View" , "Multiple Ports per View" , "All Ports share the same View" }
ValueMap { "2" , "3" , "4" }
uint16 PortsPerView = 2 ;
An integer enumeration indicating the way that ports per view (ProtocolController) are handled by the underlying storage system.
Experimental
ModelCorrespondence { "CIM_ProtocolControllerMaskingCapabilities.PortsPerView" }
boolean SPCSupportsDefaultViews = TRUE ;
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.
boolean AttachDeviceSupported ;
Set to true if this storage system supports the AttachDevice method.
Experimental
boolean SPCAllowsNoInitiators = FALSE ;
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.
boolean ProtocolControllerRequiresAuthorizedIdentity = FALSE ;
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.
boolean ClientSelectableDeviceNumbers = TRUE ;
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.
Experimental
boolean SPCAllowsNoTargets = FALSE ;
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.
boolean ProtocolControllerSupportsCollections = FALSE ;
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.
Values { "Other" , "Port WWN" , "Node WWN" , "Host Name" , "iSCSI Name" }
ValueMap { "1" , "2" , "3" , "4" , "5" }
ArrayType ( "Indexed" )
uint16 ValidHardwareIdTypes [ ] ;
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.
boolean UniqueUnitNumbersPerPort = FALSE ;
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.
Experimental
boolean ExposePathsSupported ;
Set to true if this storage system supports the ExposePaths and HidePaths methods.
boolean PrivilegeDeniedSupported = FALSE ;
Set to true if this storage system allows a client to create a Privilege instance with PrivilegeGranted set to FALSE.
ArrayType ( "Indexed" )
string OtherValidHardwareIDTypes [ ] ;
An array of strings describing types for valid StorageHardwareID.IDType. Used when the ValidHardwareIdTypes includes 1 ('Other').
Required
Override ( "ElementName" )
string ElementName ;
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.)
Experimental
Values { "Success" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "Alternative Proposed" , "DMTF Reserved" , "Vendor Specific" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "32768..65535" }
uint16CreateGoalSettings(
If provided, TemplateGoalSettings are elements of class CIM_SettingData, or a derived class, that is used as the template to be matched. .
At most, one instance of each SettingData subclass may be supplied.
All SettingData instances provided by this property are interpreted as a set, relative to this Capabilities instance.
SettingData instances that are not relevant to this instance are ignored.
If not provided, it shall be set to NULL. In that case, a SettingData instance representing the default settings of the associated ManagedElement is used.

Qualifiers:IN EmbeddedInstance ( "CIM_SettingData" )
string TemplateGoalSettings [ ]
SupportedGoalSettings are elements of class CIM_SettingData, or a derived class.
At most, one instance of each SettingData subclass may be supplied.
All SettingData instances provided by this property are interpreted as a set, relative to this Capabilities instance.

To enable a client to provide additional information towards achieving the TemplateGoalSettings, an input set of SettingData instances may be provided. If not provided, this property shall be set to NULL on input.. Note that when provided, what property values are changed, and how, is implementation dependent and may be the subject of other standards.
If provided, the input SettingData instances must be ones that the implementation is able to support relative to the ManagedElement associated via ElementCapabilities. Typically, the input SettingData instances are created by a previous instantiation of CreateGoalSettings.
If the input SupportedGoalSettings is not supported by the implementation, then an 'Invalid Parameter' (5) error is returned by this call. In this case, a corresponding CIM_ERROR should also be returned.
On output, this property is used to return the best supported match to the TemplateGoalSettings.
If the output SupportedGoalSettings matches the input SupportedGoalSettings, then the implementation is unable to improve further towards meeting the TemplateGoalSettings.

Qualifiers:OUT IN EmbeddedInstance ( "CIM_SettingData" )
string SupportedGoalSettings [ ]
)
Method to create a set of supported SettingData elements, from two sets of SettingData elements, provided by the caller.
CreateGoal should be used when the SettingData instances that represents the goal will not persist beyond the execution of the client and where those instances are not intended to be shared with other, non-cooperating clients.
Both TemplateGoalSettings and SupportedGoalSettings are represented as strings containing EmbeddedInstances of a CIM_SettingData subclass. These embedded instances do not exist in the infrastructure supporting this method but are maintained by the caller/client.
This method should return CIM_Error(s) representing that a single named property of a setting (or other) parameter (either reference or embedded object) has an invalid value or that an invalid combination of named properties of a setting (or other) parameter (either reference or embedded object) has been requested.
If the input TemplateGoalSettings is NULL or the empty string, this method returns a default SettingData element that is supported by this Capabilities element.
If the TemplateGoalSettings specifies values that cannot be supported, this method shall return an appropriate CIM_Error and should return a best match for a SupportedGoalSettings.
The client proposes a goal using the TemplateGoalSettings parameter and gets back Success if the TemplateGoalSettings is exactly supportable. It gets back 'Alternative Proposed' if the output SupportedGoalSettings represents a supported alternative. This alternative should be a best match, as defined by the implementation.
If the implementation is conformant to a RegisteredProfile, then that profile may specify the algorithms used to determine best match. A client may compare the returned value of each property against the requested value to determine if it is left unchanged, degraded or upgraded.

Otherwise, if the TemplateGoalSettings is not applicable an 'Invalid Parameter' error is returned.

When a mutually acceptable SupportedGoalSettings has been achieved, the client may use the contained SettingData instances as input to methods for creating a new object ormodifying an existing object. Also the embedded SettingData instances returned in the SupportedGoalSettings may be instantiated via CreateInstance, either by a client or as a side-effect of the execution of an extrinsic method for which the returned SupportedGoalSettings is passed as an embedded instance.
Key
string InstanceID ;
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'.
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.