1 marek 1.1 // Copyright (c) 2005 DMTF.  All rights reserved.
  2           // <change cr="SysDevCR00678" type = "deprecate"> (CIM V2.9.1 Final) Deprecate CIM_StorageMediaLibrary in Device model </change>
  3           // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
  4           // qualifier values to CIM Schema.</change>
  5           // <change cr="ArchCR00089.003" type="add">Add PUnit qualifier values
  6           // to Units qualifier values.</change>
  7           // ===================================================================
  8           // StorageLibrary
  9           // ===================================================================
 10              [Deprecated { "CIM_ComputerSystem", "CIM_StorageLibraryCapabilities" }, 
 11               Version ( "2.9.0" ), 
 12               UMLPackagePath ( "CIM::Device::StorageLib" ), 
 13               Description ( 
 14                  "A StorageLibrary is a collection of ManagedSystemElements that "
 15                  "operate together to provide cartridge library capabilities. "
 16                  "This object serves as an aggregation point to group the "
 17                  "following elements: MediaTransferDevices, a Label Reader, a "
 18                  "library Door, MediaAccessDevices, and other Library "
 19                  "components. \n"
 20                  "The use of this class is deprecated in favor of "
 21                  "CIM_ComputerSystem. Originally it was felt that a media "
 22 marek 1.1        "library could be purely mechanical and thus not a "
 23                  "ComputerSystem. However all manageable libraries are "
 24                  "ComputerSystems. This change simplifies the use of the model "
 25                  "by client software." )]
 26           class CIM_StorageLibrary : CIM_System {
 27           
 28                 [Deprecated { "CIM_StorageLibraryCapabilities.Capabilities" }, 
 29                  Description ( 
 30                     "Capabilities of the StorageLibrary. For example, it can "
 31                     "be indicated that the Library can perform automatic "
 32                     "cleaning of the MediaAccessDevices contained in it "
 33                     "(value=1) or that the Library provides physical door "
 34                     "access for an operator (value=2)." ), 
 35                  ValueMap { "0", "2", "3", "4" }, 
 36                  Values { "Unknown", "Automatic Cleaning", "Manual Operation", 
 37                     "Front Panel Lockable" }]
 38              uint16 Capabilities[];
 39           
 40                 [Deprecated { "CIM_ComputerSystem.OperationalStatus" }, 
 41                  Description ( 
 42                     "This property is deprecated in favour of an "
 43 marek 1.1           "OperationalStatus value of 4 (\'stressed\').\n"
 44                     "Boolean set to TRUE if there are more PhysicalMedia in a "
 45                     "Library than there are StorageMediaLocations to contain "
 46                     "them. For instance, if all MediaAccessDevices have a "
 47                     "Media loaded in them, and all StorageMediaLocations are "
 48                     "loaded by an operator, then an Overfilled condition "
 49                     "exists." )]
 50              boolean Overfilled;
 51           
 52                 [Deprecated { "CIM_ComputerSystem.OperationalStatus" }, 
 53                  Description ( 
 54                     "This property is deprecated in favour of an "
 55                     "OperationalStatus value of 0 (\'Unknown\').\n"
 56                     "Boolean set to TRUE if the Library can not currently "
 57                     "report the correct state of each PhysicalMedia within "
 58                     "its proper StorageMediaLocation." )]
 59              boolean AuditNeeded;
 60           
 61                 [Deprecated { "CIM_ComputerSystem.OperationalStatus" }, 
 62                  Description ( 
 63                     "This property is deprecated in favour of an "
 64 marek 1.1           "OperationalStatus value of 11 (\'In Service\').\n"
 65                     "Boolean set to TRUE if an audit of the location of some "
 66                     "or all of the Library\'s PhysicalMedia is currently "
 67                     "being performed. That an individual Changer is currently "
 68                     "doing an audit is indicated by a similar AuditInProgress "
 69                     "boolean property on the Changer object." )]
 70              boolean AuditInProgress;
 71           
 72                 [Deprecated { "CIM_StorageLibraryCapabilities.MaxAuditTime" }, 
 73                  Description ( 
 74                     "Maximum time in seconds that it takes for the Storage "
 75                     "Library to perform a complete audit of each StorageMedia "
 76                     "Location, to determine the absence or presence of a "
 77                     "Physical Media. If automated support is not provided, "
 78                     "then this property\'s value is undefined." ), 
 79                  Units ( "Seconds" ), 
 80                  PUnit ( "second" )]
 81              uint64 MaxAuditTime;
 82           
 83                 [Deprecated { "No value" }, 
 84                  Description ( 
 85 marek 1.1           "This property is deprecated since all managed libraries "
 86                     "willbe automated.\n"
 87                     "Boolean set to TRUE if the Library includes a robotics "
 88                     "mechanism that can be controlled by a ComputerSystem, to "
 89                     "automatically load and unload PhysicalMedia to/from "
 90                     "MediaAccessDevices and StorageMediaLocations. The "
 91                     "property is set to FALSE if the Library represents a "
 92                     "repository of Media that are inaccessible to a "
 93                     "MediaAccess Device without human intervention. An "
 94                     "example of a non- automated Library is a \'shelf\' or "
 95                     "\'vault\' where Physical Media are kept for extended "
 96                     "periods of time." )]
 97              boolean Automated;
 98           
 99                 [Deprecated { "CIM_ComputerSystem.OperationalStatus" }, 
100                  Description ( 
101                     "This property is deprecated in favour of an "
102                     "OperationalStatus value of 10 (\'Stopped\').\n"
103                     "Boolean indicating whether the Library\'s robotics are "
104                     "currently active/enabled. If TRUE, then the Library may "
105                     "not be safe for a human to enter." )]
106 marek 1.1    boolean RoboticsEnabled;
107           
108           
109                 [Deprecated { "CIM_ComputerSystem.RequestStateChange" }, 
110                  Description ( 
111                     "Requests that the Library robotics be enabled for "
112                     "automated operation (input parameter, Enabled, set to "
113                     "TRUE), or disabled for manual operation (input parameter "
114                     "set to FALSE). The return value should be 0 if the "
115                     "request was successfully executed, 1 if the request is "
116                     "not supported and some other value if an error occurred. "
117                     "In a subclass, the set of possible return codes could be "
118                     "specified, using a ValueMap qualifier on the method. The "
119                     "strings to which the ValueMap contents are \'translated\' "
120                     "may also be specified in the subclass as a Values array "
121                     "qualifier." )]
122              uint32 EnableRobotics(
123                    [IN, Description ( "Set TRUE to enable." )]
124                 boolean Enable);
125           
126           };