<head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="mof.css" xmlns:lxslt="http://xml.apache.org/xslt"> <title>DMTF Schema Documentation Schema Documentation</title> </head><html> <body bgcolor="White"> <hr> </hr> <a name="CIM_SCSIMultipathConfigurationCapabilities"></a> <H1>Class CIM_SCSIMultipathConfigurationCapabilities<BR>extends <a href="CIM_Capabilities.html">CIM_Capabilities</a> </H1>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.<h3> Table of Contents<br> <a href="#c_hierarchy">Hierarchy</a> <br> <a href="#c_subclasses">Direct Known Subclasses</a> <br> <a href="#c_qualifiers">Class Qualifiers</a> <br> <a href="#c_properties">Class Properties</a> <br> <a href="#c_methods">Class Methods</a> <br> </h3> <hr> </hr> <H2> <a name="c_hierarchy">Class Hierarchy</a> </H2> <a href="CIM_ManagedElement.html">CIM_ManagedElement</a> <br data="@NAME"> |<br> +--<a href="CIM_Capabilities.html">CIM_Capabilities</a> <br data="@NAME"> |<br> +--<b>CIM_SCSIMultipathConfigurationCapabilities</b> <br data="CIM_SCSIMultipathConfigurationCapabilities -- CIM_Capabilities"> <H2> <a name="c_subclasses">Direct Known Subclasses</a> </H2> <H2> <a name="c_qualifiers">Class Qualifiers</a> </H2> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">Experimental</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::Device::StorageDevices</TD> </TR> <TR> <TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.10.0</TD> </TR> </TABLE> <H2> <a name="c_properties">Class Properties</a> </H2> <H3>Local Class Properties</H3> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Data Type</B></TH><TH ROWSPAN="2"><B>Default Value</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">AutoFailbackEnabled</TH><TD ROWSPAN="4" VALIGN="TOP">boolean</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A 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.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|autoFailbackEnabled</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SCSIMultipathConfigurationCapabilities.AutofailbackSupport, CIM_SCSIMultipathSettings.AutofailbackEnabled</TD> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">AutofailbackSupport</TH><TD ROWSPAN="6" VALIGN="TOP">uint16</TD><TD ROWSPAN="6" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Specifies 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.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|autofailbackSupport</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SCSIMultipathConfigurationCapabilities.AutofailbackEnabled, CIM_SCSIMultipathSettings.AutofailbackEnabled</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 2, 3, 4, 5</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unknown, No Autofailback support, Autofailback support service-wide, Autofailback support per logical unit, Autofailback support per service or logical unit</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">CanOverridePaths</TH><TD ROWSPAN="4" VALIGN="TOP">boolean</TD><TD ROWSPAN="4" VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The capability of the driver to support the SetOverridePath and CancelOverridePaths methods. True if the implementation supports path overrides.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|canOverridePaths</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SCSIPathConfigurationService.SetOverridePath</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">CanSetTPGAccess</TH><TD ROWSPAN="4" VALIGN="TOP">boolean</TD><TD ROWSPAN="4" VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The capability of the driver to support the SetTPGAccess method. True if the implementation supports activating target port groups.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|canSetTPGAccess</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SCSIPathConfigurationService.SetTPGAccess</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">CurrentPollingRate</TH><TD ROWSPAN="4" VALIGN="TOP">uint32</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The current rate in seconds. Only valid when pollingRateMax is greater than 0 and canAutoFailback are true.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|currentPollingRate</TD> </TR> <TR> <TD VALIGN="TOP">Write</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">DefaultLoadBalanceType</TH><TD ROWSPAN="6" VALIGN="TOP">uint16</TD><TD ROWSPAN="6" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The load balance types supported by the driver if not overridden by an administrative action.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|defaultLoadBalanceType</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5, 6</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unknown, Other, No Load Balancing, Round Robin, Least Blocks, Least IO, Product Specific</TD> </TR> <TR> <TD VALIGN="TOP">Write</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">DeviceNameFilespace</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A 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.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|deviceNameFilespace</TD> </TR> <TR> <TD VALIGN="TOP">MaxLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">256</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">ExposesPathDeviceFiles</TH><TD ROWSPAN="3" VALIGN="TOP">boolean</TD><TD ROWSPAN="3" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">False 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.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|Plugin Properties|exposesPathDeviceFiles</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">MaximumWeight</TH><TD ROWSPAN="3" VALIGN="TOP">uint32</TD><TD ROWSPAN="3" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Describes 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.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|maximumWeight</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">OnlySupportsSpecifiedProducts</TH><TD ROWSPAN="4" VALIGN="TOP">boolean</TD><TD ROWSPAN="4" VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">True if the only supported device types are those described in aggregated CIM_Product instances as described in the description of SupportedLoadBalanceTypes.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|deviceNameFilespace</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SCSIMultipathConfigurationCapabilities.SupportedLoadBalanceTypes</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">PollingRateMax</TH><TD ROWSPAN="3" VALIGN="TOP">uint32</TD><TD ROWSPAN="3" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The 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.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_PLUGIN_PROPERTIES|pollingRateMax</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">OtherSupportedLoadBalanceAlgorithmNames</TH><TD ROWSPAN="5" VALIGN="TOP">string[]</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">When 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)</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">SPC.INCITS-T10 |Standard Inquiry Response, MP_API.SNIA|MP_LOAD_BALANCE_TYPE, MP_API.SNIA|MP_DEVICE_PRODUCT_PROPERTIES</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SCSIMultipathConfigurationCapabilities.SupportedLoadBalanceTypes, CIM_SCSIMultipathConfigurationCapabilities.OtherSupportedLoadBalanceVendorNames</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">OtherSupportedLoadBalanceVendorNames</TH><TD ROWSPAN="5" VALIGN="TOP">string[]</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">When the corresponding array entry in SupportedLoadBalanceTypes[] is 'Other', this entry provides a string describing the vendor associated with the load balancing algorithm.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_LOAD_BALANCE_TYPE</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SCSIMultipathConfigurationCapabilities.SupportedLoadBalanceTypes, CIM_SCSIMultipathConfigurationCapabilities.OtherSupportedLoadBalanceAlgorithmNames</TD> </TR> <TR> <TH ROWSPAN="7" VALIGN="TOP">SupportedLoadBalanceTypes</TH><TD ROWSPAN="7" VALIGN="TOP">uint16[]</TD><TD ROWSPAN="7" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The 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.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MP_API.SNIA|MP_LOAD_BALANCE_TYPE</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_SCSIMultipathConfigurationCapabilities.OtherSupportedLoadBalanceAlgorithmNames, CIM_SCSIMultipathConfigurationCapabilities.OtherSupportedLoadBalanceVendorNames</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5, 6, 7</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unknown, Other, No Load Balancing, Round Robin, Least Blocks, Least IO, LBA Region, Product Specific</TD> </TR> </TABLE> <H3>Inherited Properties</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">Caption</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Description</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">ElementName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Capabilities.html">CIM_Capabilities</a></TD> </TR> <TR> <TH VALIGN="TOP">Generation</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Capabilities.html">CIM_Capabilities</a></TD> </TR> </TABLE> <h2> <a name="c_methods">Class Methods</a> </h2> <H3>Inherited Class Methods</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Return Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">CreateGoalSettings</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_Capabilities.html">CIM_Capabilities</a></TD> </TR> </TABLE> </body> </html>
