1 marek 1.1 // Copyright (c) 2005 DMTF.  All rights reserved.
  2              [Association, Version ( "2.10.0" ), 
  3               UMLPackagePath ( "CIM::Device::StorageDevices" ), 
  4               Description ( 
  5                  "An association that models a host driver path to a SCSI "
  6                  "logical unit. Each permutation of initiator and target "
  7                  "ProtocolEndpoints and logical units is considered a separate "
  8                  "path. This class describes end-to-end path behavior such as "
  9                  "properties and operations commonly used in multipath "
 10                  "management." )]
 11           class CIM_SCSIInitiatorTargetLogicalUnitPath {
 12           
 13                 [Key, Description ( "An initiator endpoint." )]
 14              CIM_SCSIProtocolEndpoint REF Initiator;
 15           
 16                 [Key, Description ( "A target endpoint." )]
 17              CIM_SCSIProtocolEndpoint REF Target;
 18           
 19                 [Key, Description ( 
 20                     "A subclass of LogicalDevice representing a SCSI Logical "
 21                     "Unit (such as StorageVolume or TapeDrive)." )]
 22 marek 1.1    CIM_LogicalDevice REF LogicalUnit;
 23           
 24                 [Description ( 
 25                     "The OS Device Name for this path. Only applicable if the "
 26                     "ExposedPathDeviceFiles property is true in the instance "
 27                     "of SCSIMultipathConfigurationCapabilities associated "
 28                     "with the LogicalDevice/RedundancySet this instance is a "
 29                     "member of." ), 
 30                  MappingStrings { 
 31                     "MP_API.SNIA|MP_PATH_LOGICAL_UNIT_PROPERTIES|deviceFileName" }]
 32              string OSDeviceName;
 33           
 34                 [Write, Description ( 
 35                     "A value assigned by an administrator specifying a "
 36                     "preference to assign to a path. The drivers will "
 37                     "actively use all available paths with the highest "
 38                     "weight. This allows an administrator to assign a subset "
 39                     "of available paths for load balanced access and reserve "
 40                     "the others as backup paths. For symmetric access "
 41                     "devices, all paths are considered \'available\'. For "
 42                     "asymmetric access devices, all paths in active target "
 43 marek 1.1           "port groups are considered available." ), 
 44                  MappingStrings { 
 45                     "MP_API.SNIA|MP_PATH_LOGICAL_UNIT_PROPERTIES|weight" }]
 46              uint32 AdministrativeWeight;
 47           
 48                 [Write, Description ( 
 49                     "The state of this path. Values are defined as follows: \n"
 50                     "Unknown - the path is unavailable,but the cause is not "
 51                     "known. \n"
 52                     "Active - The path is okay and active. \n"
 53                     "Passive - The path is okay, but is associated with a "
 54                     "target port of target port group in standby access "
 55                     "state. Only applies to devices with asymmetric access. \n"
 56                     "Disabled - The path is disabled by administrative "
 57                     "request (DisablePathLU). \n"
 58                     "Path Error - The path is unusable due to an error on "
 59                     "this path and no SCSI status was received. \n"
 60                     "Logical Unit Error - A SCSI status was received for an "
 61                     "I/O through this path indicating a logical unit error. \n"
 62                     "Reserved - The path is unavailable due to a SCSI "
 63                     "reservation. \n"
 64 marek 1.1           "Removed - The path is unavailable because the OS or "
 65                     "drivers marked the pathunusable. \n"
 66                     "Transitioning - the path is transitioning between two "
 67                     "valid states. \n"
 68                     "The only valid values a client can specify are Disabled "
 69                     "and Active. All other states are determined by the "
 70                     "underlying implementation; attempts to set them should "
 71                     "be given an error response." ), 
 72                  ValueMap { "0", "2", "3", "4", "5", "6", "7", "8", "9" }, 
 73                  Values { "Unknown", "Active", "Passive", "Disabled", 
 74                     "Path Error", "Logical Unit Error", "Reserved", "Removed", 
 75                     "Transitioning" }, 
 76                  MappingStrings { 
 77                     "MP_API.SNIA|MP_PATH_LOGICAL_UNIT_PROPERTIES|pathState" }]
 78              uint32 State;
 79           
 80                 [Description ( 
 81                     "AdministrativeOverride allows an administrator to select "
 82                     "a single path, force all I/O to this path, and disables "
 83                     "load balancing. The steady-state value is \'No override "
 84                     "in effect\'. When an administrator sets an override for "
 85 marek 1.1           "a particular path, that path\'s AdministrativeOverride "
 86                     "is set to \'Overridding\' and all other paths to same "
 87                     "logical unit are assigned a value of \'Overridden\'. "
 88                     "This property is changed using the OverridePath method "
 89                     "in SCSIPathConfigurationService." ), 
 90                  ValueMap { "2", "3", "4" }, 
 91                  Values { "Overriding", "Overridden", "No override in effect" }, 
 92                  MappingStrings { 
 93                     "MP_API.SNIA|MP_MULTIPATH_LOGICAL_UNIT_PROPERTIES|overridePath" }, 
 94                  ModelCorrespondence { 
 95                     "CIM_SCSIPathConfigurationService.SetOverridePath" }]
 96              uint16 AdministrativeOverride;
 97           
 98                 [Description ( 
 99                     "The SCSI Logical Unit Number. This is the unit number "
100                     "with values below 16,384 used in management "
101                     "applications. It is not the full SCSI SAM 8-byte logical "
102                     "unit number structure. Using the terminology from the "
103                     "T10 SCSI specifications, this is the LU number with a "
104                     "value between 0 and 255 using the Peripheral device "
105                     "addressing method with Bus Identifier zero or a LU "
106 marek 1.1           "number between 0 and 16,383 using the Flat space (AKA "
107                     "volume set) addressing method." ), 
108                  MaxValue ( 16383 ), 
109                  MappingStrings { 
110                     "MP_API.SNIA|MP_MULTIPATH_LOGICAL_UNIT_PROPERTIES|overridePathMP_API.SNIA|MP_CancelOverridePath", 
111                     "MP_API.SNIA|MP_SetOverridePath" }]
112              uint16 LogicalUnitNumber;
113           
114           
115           };