Class CIM_SCSIMultipathConfigurationCapabilities


  extends CIM_Capabilities
A class derived from CIM_Capabilities that models the capabilities of a multipath driver. Note that 'path' in this context refers to end-to-end device paths (for example, SCSI initiator/target) with no understanding of edge paths between interconnect elements such as switches. Load balancing only applies to symmetric multipath devices or to the ports in SCSITargetPortGroups in active access state. A driver may support different algorithms for load balancing. A few common algorithms are listed. Algorithms for specific device models and software vendor specific algorithms are also accommodated. An instance of this capabilities class MUST be instantiated whenever SCSIPathConfigurationService is instantiated and they MUST be assocaited one to one using ElementCapabilities. Multiple instances of the service/acapabilities pair MAY exist if multiple multipath drivers are installed. Each LogicalDevice subclass served by the underlying multipath driver is associated to the associated Service instance via ServiceAvailableToELement.
Details...
This class is not implemented.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringA class derived from CIM_Capabilities that models the capabilities of a multipath driver. Note that 'path' in this context refers to end-to-end device paths (for example, SCSI initiator/target) with no understanding of edge paths between interconnect elements such as switches. Load balancing only applies to symmetric multipath devices or to the ports in SCSITargetPortGroups in active access state. A driver may support different algorithms for load balancing. A few common algorithms are listed. Algorithms for specific device models and software vendor specific algorithms are also accommodated. An instance of this capabilities class MUST be instantiated whenever SCSIPathConfigurationService is instantiated and they MUST be assocaited one to one using ElementCapabilities. Multiple instances of the service/acapabilities pair MAY exist if multiple multipath drivers are installed. Each LogicalDevice subclass served by the underlying multipath driver is associated to the associated Service instance via ServiceAvailableToELement.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
UMLPackagePathstringCIM::Device::StorageDevicesNone None
Versionstring2.10.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
AutoFailbackEnabledboolean
DescriptionstringA Boolean indicating that autofailback is enabled to all logical units associated to the CIM_SCSIPathConfigurationService associated with this capabilities instance (unless overridden by CIM_SCSIMultipathSettings AutoFailbackEnabled.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|autoFailbackEnabledNone None
ModelCorrespondencestringCIM_SCSIMultipathConfigurationCapabilities.AutofailbackSupport, CIM_SCSIMultipathSettings.AutofailbackEnabledNone None
AutofailbackSupportuint16
DescriptionstringSpecifies whether the implementation supports auto-failback (to re-enable paths that revert to a good state) at the plugin level, the multipath logical unit level, both levels or whether auto-failback is unsupported.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|autofailbackSupportNone None
ModelCorrespondencestringCIM_SCSIMultipathConfigurationCapabilities.AutofailbackEnabled, CIM_SCSIMultipathSettings.AutofailbackEnabledNone None
ValueMapstring0, 2, 3, 4, 5None None
ValuesstringUnknown, No Autofailback support, Autofailback support service-wide, Autofailback support per logical unit, Autofailback support per service or logical unitNone TRANSLATABLE= true
CanOverridePathsboolean
DescriptionstringThe capability of the driver to support the SetOverridePath and CancelOverridePaths methods. True if the implementation supports path overrides.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|canOverridePathsNone None
ModelCorrespondencestringCIM_SCSIPathConfigurationService.SetOverridePathNone None
CanSetTPGAccessboolean
DescriptionstringThe capability of the driver to support the SetTPGAccess method. True if the implementation supports activating target port groups.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|canSetTPGAccessNone None
ModelCorrespondencestringCIM_SCSIPathConfigurationService.SetTPGAccessNone None
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
CurrentPollingRateuint32
DescriptionstringThe current rate in seconds. Only valid when pollingRateMax is greater than 0 and canAutoFailback are true.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|currentPollingRateNone None
WritebooleantrueNone None
DefaultLoadBalanceTypeuint16
DescriptionstringThe load balance types supported by the driver if not overridden by an administrative action.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|defaultLoadBalanceTypeNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6None None
ValuesstringUnknown, Other, No Load Balancing, Round Robin, Least Blocks, Least IO, Product SpecificNone TRANSLATABLE= true
WritebooleantrueNone None
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
DeviceNameFilespacestring
DescriptionstringA string representing the primary file names the driver uses for multipath logical units, if those filenames do not match the names in Logical Unit osDeviceName as documented in Appendix A of the SNIA MP API specification. The name is expressing in the following format: '*' represents one or more alphanumeric characters '#' represents a string of consecutive digits '%' represents a string of hexadecimal digits backslash is an escape character for literal presentation of *, #, or %. Any other character is interpreted literally. For example, '/dev/vx/dmp/*'. If the multipath driver creates multipath logical unit device file names in the same namespace as the OS then this property should be left null.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|deviceNameFilespaceNone None
MaxLenuint32256None None
ElementNamestring
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.)None TRANSLATABLE= true
OverridestringElementNameTOSUBCLASS= falseNone
RequiredbooleantrueNone OVERRIDABLE= false
ExposesPathDeviceFilesboolean
DescriptionstringFalse if the MP drivers assure only a single device file name (e.g. /dev/dsk/...) exists for each MP device. True if the implementation exposes (or leaves exposed) device files for the individual paths encapsulated by the multipath device file. This is typically true for MP drivers that sit near the top of the driver stack and false for transport drivers at the bottom of the stack.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|Plugin Properties|exposesPathDeviceFilesNone None
Generationuint64
DescriptionstringGeneration 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
ExperimentalbooleantrueTOSUBCLASS= falseNone
InstanceIDstring
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'.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
OverridestringInstanceIDTOSUBCLASS= falseNone
MaximumWeightuint32
DescriptionstringDescribes the range of administer settable path weights supported by the driver. A driver with no path preference capabilities should set this property to zero. A driver with the ability to enable/disable paths should set this property to 1. Drivers with more weight settings can set the property appropriately.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|maximumWeightNone None
OnlySupportsSpecifiedProductsboolean
DescriptionstringTrue if the only supported device types are those described in aggregated CIM_Product instances as described in the description of SupportedLoadBalanceTypes.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|deviceNameFilespaceNone None
ModelCorrespondencestringCIM_SCSIMultipathConfigurationCapabilities.SupportedLoadBalanceTypesNone None
OtherSupportedLoadBalanceAlgorithmNamesstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringWhen the corresponding array entry in SupportedLoadBalanceTypes[] is 'Other', this entry provides a string describing the load balancing algorithm. When the corresponding array entry in SupportedLoadBalanceTypes[] is 'Product Specific', this entry provides a string specifying the SCSI vendor/product/revision and must be formatted as exactly 28 ASCII characters - 8 for vendor, 16 for product, and 4 for revision (see SCSI SPC Inquiry response)None TRANSLATABLE= true
MappingStringsstringSPC.INCITS-T10 |Standard Inquiry Response, MP_API.SNIA|MP_LOAD_BALANCE_TYPE, MP_API.SNIA|MP_DEVICE_PRODUCT_PROPERTIESNone None
ModelCorrespondencestringCIM_SCSIMultipathConfigurationCapabilities.SupportedLoadBalanceTypes, CIM_SCSIMultipathConfigurationCapabilities.OtherSupportedLoadBalanceVendorNamesNone None
OtherSupportedLoadBalanceVendorNamesstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringWhen the corresponding array entry in SupportedLoadBalanceTypes[] is 'Other', this entry provides a string describing the vendor associated with the load balancing algorithm.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_LOAD_BALANCE_TYPENone None
ModelCorrespondencestringCIM_SCSIMultipathConfigurationCapabilities.SupportedLoadBalanceTypes, CIM_SCSIMultipathConfigurationCapabilities.OtherSupportedLoadBalanceAlgorithmNamesNone None
PollingRateMaxuint32
DescriptionstringThe maximum polling rate (in seconds) supported by the driver. A value of zero indicates the driver/plugin does not support polling. This maximum applies to both BadPathPollingRate and InactivePathPollingRate.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_PLUGIN_PROPERTIES|pollingRateMaxNone None
SupportedLoadBalanceTypesuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringThe load balance types supported by the driver for all logical units on a target device. If 'Product Specified' is included, one or more instances of CIM_Product must be aggregated to the capabilities instance via ConcreteComponent. Each Product instance provides the SCSI Vendor, Product, and Revision ID of a supported product.None TRANSLATABLE= true
MappingStringsstringMP_API.SNIA|MP_LOAD_BALANCE_TYPENone None
ModelCorrespondencestringCIM_SCSIMultipathConfigurationCapabilities.OtherSupportedLoadBalanceAlgorithmNames, CIM_SCSIMultipathConfigurationCapabilities.OtherSupportedLoadBalanceVendorNamesNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7None None
ValuesstringUnknown, Other, No Load Balancing, Round Robin, Least Blocks, Least IO, LBA Region, Product SpecificNone TRANSLATABLE= true

Copyright © 2008-2010 VMware, Inc. All rights reserved.