CIM211 Class Declaration
CIM_ProtocolControllerMaskingCapabilities

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_ProtocolControllerMaskingCapabilities --> CIM_Capabilities --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_Capabilities
NAMECIM_ProtocolControllerMaskingCapabilities

Class Qualifiers

Class CIM_ProtocolControllerMaskingCapabilities Qualifiers
NameTypeValueFrom Class
Versionstring2.10.0 CIM_ProtocolControllerMaskingCapabilities
DescriptionstringA subclass of Capabilities that defines the Masking-related capabilities of a ProtocolController. CIM_ProtocolControllerMaskingCapabilities
DescriptionstringCapabilities is an abstract class whose subclasses describe abilities and/or potential for use. For example, one may describe the maximum number of VLANs that can be supported on a system using a subclass of Capabilities. Capabilities are tied to the elements which they describe using the ElementCapabilities association. Note that the cardinality of the ManagedElement reference is Min(1), Max(1). This cardinality mandates the instantiation of the ElementCapabilities association for the referenced instance of Capabilities. ElementCapabilities describes the existence requirements and context for the referenced instance of ManagedElement. Specifically, the ManagedElement MUST exist and provides the context for the Capabilities. Note that Capabilities do not indicate what IS configured or operational, but what CAN or CANNOT exist, be defined or be used. Note that it is possible to describe both supported and excluded abilities and functions (both capabilities and limitations) using this class. CIM_Capabilities
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
ValidHardwareIdTypesuint16[] Description
ValueMap
Values
ArrayType
CIM_ProtocolControllerMaskingCapabilities
OtherValidHardwareIDTypesstring[] Description
ArrayType
CIM_ProtocolControllerMaskingCapabilities
PortsPerViewuint162 Description
ValueMap
Values
CIM_ProtocolControllerMaskingCapabilities
ClientSelectableDeviceNumbersbooleantrue Description CIM_ProtocolControllerMaskingCapabilities
AttachDeviceSupportedboolean Description CIM_ProtocolControllerMaskingCapabilities
OneHardwareIDPerViewbooleanfalse Description CIM_ProtocolControllerMaskingCapabilities
UniqueUnitNumbersPerPortbooleanfalse Description CIM_ProtocolControllerMaskingCapabilities
PrivilegeDeniedSupportedbooleanfalse Description CIM_ProtocolControllerMaskingCapabilities
ProtocolControllerRequiresAuthorizedIdentitybooleanfalse Description CIM_ProtocolControllerMaskingCapabilities
ProtocolControllerSupportsCollectionsbooleanfalse Description CIM_ProtocolControllerMaskingCapabilities
ExposePathsSupportedboolean Experimental
Description
CIM_ProtocolControllerMaskingCapabilities
CreateProtocolControllerSupportedboolean Experimental
Description
CIM_ProtocolControllerMaskingCapabilities
MaximumMapCountuint160 Experimental
Description
CIM_ProtocolControllerMaskingCapabilities
SPCAllowsNoLUsbooleanfalse Experimental
Description
CIM_ProtocolControllerMaskingCapabilities
SPCAllowsNoTargetsbooleanfalse Experimental
Description
CIM_ProtocolControllerMaskingCapabilities
SPCAllowsNoInitiatorsbooleanfalse Experimental
Description
CIM_ProtocolControllerMaskingCapabilities
SPCSupportsDefaultViewsbooleantrue Experimental
Description
ModelCorrespondence
CIM_ProtocolControllerMaskingCapabilities
InstanceIDstring Key
Description
CIM_Capabilities
ElementNamestring Required
Override
Description
CIM_Capabilities
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property ValidHardwareIdTypes Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_ProtocolControllerMaskingCapabilities
ValueMapstring
[See below.]
CIM_ProtocolControllerMaskingCapabilities
ValuesstringOther
Port WWN
Node WWN
Host Name
iSCSI Name
CIM_ProtocolControllerMaskingCapabilities
ArrayTypestringIndexed CIM_ProtocolControllerMaskingCapabilities

NameValue
1Other
2Port WWN
3Node WWN
4Host Name
5iSCSI Name
Property OtherValidHardwareIDTypes Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of strings describing types for valid StorageHardwareID.IDType. Used when the ValidHardwareIdTypes includes 1 ( " Other " ). CIM_ProtocolControllerMaskingCapabilities
ArrayTypestringIndexed CIM_ProtocolControllerMaskingCapabilities

Property PortsPerView Qualifiers
NameTypeValueFrom Class
DescriptionstringAn integer enumeration indicating the way that ports per view (ProtocolController) are handled by the underlying storage system. CIM_ProtocolControllerMaskingCapabilities
ValueMapstring
[See below.]
CIM_ProtocolControllerMaskingCapabilities
ValuesstringOne Port per View
Multiple Ports per View
All Ports share the same View
CIM_ProtocolControllerMaskingCapabilities

NameValue
2One Port per View
3Multiple Ports per View
4All Ports share the same View
Property ClientSelectableDeviceNumbers Qualifiers
NameTypeValueFrom Class
DescriptionstringSet 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. CIM_ProtocolControllerMaskingCapabilities

Property AttachDeviceSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringSet to true if this storage system supports the AttachDevice method. CIM_ProtocolControllerMaskingCapabilities

Property OneHardwareIDPerView Qualifiers
NameTypeValueFrom Class
DescriptionstringSet 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. CIM_ProtocolControllerMaskingCapabilities

Property UniqueUnitNumbersPerPort Qualifiers
NameTypeValueFrom Class
DescriptionstringWhen 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. CIM_ProtocolControllerMaskingCapabilities

Property PrivilegeDeniedSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringSet to true if this storage system allows a client to create a Privilege instance with PrivilegeGranted set to FALSE. CIM_ProtocolControllerMaskingCapabilities

Property ProtocolControllerRequiresAuthorizedIdentity Qualifiers
NameTypeValueFrom Class
DescriptionstringIf 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. CIM_ProtocolControllerMaskingCapabilities

Property ProtocolControllerSupportsCollections Qualifiers
NameTypeValueFrom Class
DescriptionstringIf 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. CIM_ProtocolControllerMaskingCapabilities

Property ExposePathsSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringSet to true if this storage system supports the ExposePaths and HidePaths methods. CIM_ProtocolControllerMaskingCapabilities

Property CreateProtocolControllerSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringSet to true if this storage system supports the CreateProtocolControllerWithPorts method. CIM_ProtocolControllerMaskingCapabilities

Property MaximumMapCount Qualifiers
NameTypeValueFrom Class
DescriptionstringThe maximum number of ProtocolCOntrollerForUnit associations that can be associated with a single LogicalDevice (for example, StorageVolume). Zero indicates there is no limit. CIM_ProtocolControllerMaskingCapabilities

Property SPCAllowsNoLUs Qualifiers
NameTypeValueFrom Class
DescriptionstringSet to true if the instumentation allows a client to create a configuration where an SPC has no LogicalDevices associated via CIM_ProtocolControllerForUnit associations. CIM_ProtocolControllerMaskingCapabilities

Property SPCAllowsNoTargets Qualifiers
NameTypeValueFrom Class
DescriptionstringSet to true if the instumentation allows a client to create a configuration where an SPC has no target SCSIProtocolEndpoints associated via CIM_SAPAvailableForELement associations. CIM_ProtocolControllerMaskingCapabilities

Property SPCAllowsNoInitiators Qualifiers
NameTypeValueFrom Class
DescriptionstringSet 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. CIM_ProtocolControllerMaskingCapabilities

Property SPCSupportsDefaultViews Qualifiers
NameTypeValueFrom Class
DescriptionstringSet 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. CIM_ProtocolControllerMaskingCapabilities
ModelCorrespondencestringCIM_ProtocolControllerMaskingCapabilities.PortsPerView CIM_ProtocolControllerMaskingCapabilities

Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Capabilities
DescriptionstringWithin 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 ’ . CIM_Capabilities

Property ElementName Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_Capabilities
OverridestringElementName CIM_Capabilities
DescriptionstringThe 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.) CIM_Capabilities

Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
CreateGoalSettingsuint16 Experimental
Description
ValueMap
Values
TemplateGoalSettings
SupportedGoalSettings
CIM_Capabilities

Method Qualifiers

Method CreateGoalSettings Qualifiers
NameTypeValueFrom Class
DescriptionstringMethod 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. CIM_Capabilities
ValueMapstring
[See below.]
CIM_Capabilities
ValuesstringSuccess
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
Alternative Proposed
DMTF Reserved
Vendor Specific
CIM_Capabilities

Parameters

Method CreateGoalSettings Parameters
NameTypeQualifiers
TemplateGoalSettingsstringIN
Description
EmbeddedInstance
SupportedGoalSettingsstringIN
OUT
Description
EmbeddedInstance

Parameter Qualifiers

Parameter TemplateGoalSettings Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Capabilities
DescriptionstringIf 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. CIM_Capabilities
EmbeddedInstancestringCIM_SettingData CIM_Capabilities

Parameter SupportedGoalSettings Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Capabilities
OUTbooleantrue CIM_Capabilities
DescriptionstringSupportedGoalSettings 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. CIM_Capabilities
EmbeddedInstancestringCIM_SettingData CIM_Capabilities

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_DefaultElementCapabilitiesCIM_CapabilitiesCapabilities
CIM_SettingAssociatedToCapabilitiesCIM_CapabilitiesAntecedent
CIM_ElementCapabilitiesCIM_CapabilitiesCapabilities
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement