Class CIM_FCHBADiagnosticSettingData
extends CIM_DiagnosticSettingData

This class is being used in the FC HBA Diagnostics Profile to pass in optional parameters when running certain tests.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_SettingData
   |
   +--CIM_DiagnosticSettingData
   |
   +--CIM_FCHBADiagnosticSettingData

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis class is being used in the FC HBA Diagnostics Profile to pass in optional parameters when running certain tests.
Experimentalbooleantrue
UMLPackagePathstringCIM::System::Diagnostics
Versionstring2.31.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
EchoMechanismuint322
DescriptionstringThis property is used by a client for the Echo test to specify one of the following Echo test types. FC Echo can be used to implement the Echo test against many FC devices. CT Pass Through allows SCSI read/write buffer commands to be used to implement Echo against SCSI or SAS devices attached to the SAN. FC Trace Route requires support for HBA_SendCTPassThruV2 while FC Test requires support for SMHBA_SendTEST. Both require HBAAPI library and SM-HBA suppoort.
ModelCorrespondencestringCIM_FCHBADiagnosticSettingData.OtherEchoMechanism, CIM_FCHBADiagnosticSettingData.LUN
ValueMapstring0, 1, 2, 3, 4, 5
ValuesstringUnknown, Other, FC Echo, SCSI read/write buffer, FC Trace Route, FC Test
LUNuint640
DescriptionstringThis property is mandatory when the EchoMechanism property has the value of 3 (SCSI read/write buffer). This property is used by the client to specify which LUN they are targeting.
ModelCorrespondencestringCIM_FCHBADiagnosticSettingData.EchoMechanism
OtherEchoMechanismstring
DescriptionstringIf EchoMechanism has a value of 1 (Other), this property is Mandatory.
ModelCorrespondencestringCIM_FCHBADiagnosticSettingData.EchoMechanism
OtherPingMechanismstring
DescriptionstringIf PingMechanism has a value of 1 (Other), this property is Mandatory.
ModelCorrespondencestringCIM_FCHBADiagnosticSettingData.PingMechanism
OtherTargetDeviceFormatstring
DescriptionstringIf TargetDeviceFormat has a value of 1 (Other), this property is Mandatory.
ModelCorrespondencestringCIM_FCHBADiagnosticSettingData.TargetDeviceFormat, CIM_FCHBADiagnosticSettingData.TargetDevice
PingMechanismuint162
DescriptionstringThis property is used by a client for the Ping test. The mechanism used depends upon the capabilities of the device being tested. Clients may not know which mechanism is appropriate for a particular device. Therefore, providers shall have a mode where every mechanism is tried in succession until one is successful or all have been tried.
ModelCorrespondencestringCIM_FCHBADiagnosticSettingData.OtherPingMechanism
ValueMapstring0, 1, 2, 3, 4
ValuesstringUnknown, Other, Use All, FC Echo, SCSI Inquiry
TargetDevicestring
DescriptionstringThis is the target device Address. The format of this property is based on the value of the TargetDeviceFormat property. The string is formatted as ASCII characters representing hexadecimal digits. The only characters to be used shall be 0 - 9 and A - F. Leading zeros are permitted. WWPNs shall contain 16 characters. FC port addresses shall contain 6 characters
ModelCorrespondencestringCIM_FCHBADiagnosticSettingData.TargetDeviceFormat, CIM_FCHBADiagnosticSettingData.OtherTargetDeviceFormat
TargetDeviceFormatstring
DescriptionstringThis property specifies the format of the TargetDevice value which is a string formatted as ASCII characters representing hexadecimal digits. The only characters to be used shall be 0 - 9 and A - F. Leading zeros are permitted. WWPNs shall contain 16 characters. FC port addresses shall contain 6 characters.
ModelCorrespondencestringCIM_FCHBADiagnosticSettingData.TargetDevice, CIM_FCHBADiagnosticSettingData.OtherTargetDeviceFormat
ValueMapstring0, 1, 2, 3
ValuesstringUnknown, Other, WWPN, FC Port
BufferPatternuint8[]
DescriptionstringThis octet array property is used by a client for several FC HBA tests to specify the data pattern to be used by the test. If the buffer pattern is smaller than BufferSize, then the pattern will be repeated as necessary to fill the buffer. If the buffer pattern is larger than BufferSize, then the pattern will be truncated. The vendor-defined default value is advertised using the default instance of CIM_FCHBADiagnosticSettingData. If no value is specified by the client, then the vendor-defined default pattern will be used.
ModelCorrespondencestringCIM_FCHBADiagnosticServiceCapabilities.MaxPatternSizeSupported
BufferSizesuint32[]
DescriptionstringThis array property is used by a client for some FC HBA tests to specify the data buffer sizes to be used during the test. The vendor-defined default value is advertised using the default instance of CIM_FCHBADiagnosticSettingData. If no value is specified by the client, then the vendor-defined default value will be used.
ModelCorrespondencestringCIM_FCHBADiagnosticServiceCapabilities.BufferSizesSupported

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
ChangeableTypeuint16CIM_SettingData
ConfigurationNamestringCIM_SettingData
DescriptionstringCIM_ManagedElement
ElementNamestringCIM_SettingData
Generationuint64CIM_ManagedElement
HaltOnErrorbooleanCIM_DiagnosticSettingData
InstanceIDstringCIM_SettingData
NonDestructivebooleanCIM_DiagnosticSettingData
PercentOfTestCoverageuint8CIM_DiagnosticSettingData
QueryTimeoutuint32CIM_DiagnosticSettingData
QuickModebooleanCIM_DiagnosticSettingData
ResultPersistenceuint32CIM_DiagnosticSettingData
LogOptionsuint16[]CIM_DiagnosticSettingData
LogStorageuint16[]CIM_DiagnosticSettingData
LoopControluint16[]CIM_DiagnosticSettingData
LoopControlParameterstring[]CIM_DiagnosticSettingData
OtherLogOptionsDescriptionsstring[]CIM_DiagnosticSettingData
OtherLogStorageDescriptionsstring[]CIM_DiagnosticSettingData
OtherLoopControlDescriptionsstring[]CIM_DiagnosticSettingData
VerbosityLeveluint16[]CIM_DiagnosticSettingData

Class Methods