# Class CIM_StorageLibrary
extends CIM_System

A StorageLibrary is a collection of ManagedSystemElements that operate together to provide cartridge library capabilities. This object serves as an aggregation point to group the following elements: MediaTransferDevices, a Label Reader, a library Door, MediaAccessDevices, and other Library components. The use of this class is deprecated in favor of CIM_ComputerSystem. Originally it was felt that a media library could be purely mechanical and thus not a ComputerSystem. However all manageable libraries are ComputerSystems. This change simplifies the use of the model by client software.

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

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_AllocatedLogicalElement
|
+--CIM_System
|
+--CIM_StorageLibrary

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Deprecated | string | CIM_ComputerSystem, CIM_StorageLibraryCapabilities
Description | string | A StorageLibrary is a collection of ManagedSystemElements that operate together to provide cartridge library capabilities. This object serves as an aggregation point to group the following elements: MediaTransferDevices, a Label Reader, a library Door, MediaAccessDevices, and other Library components. The use of this class is deprecated in favor of CIM_ComputerSystem. Originally it was felt that a media library could be purely mechanical and thus not a ComputerSystem. However all manageable libraries are ComputerSystems. This change simplifies the use of the model by client software.
UMLPackagePath | string | CIM::Device::StorageLib
Version | string | 2.9.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
AuditInProgress | boolean |
Deprecated | string | CIM_ComputerSystem.OperationalStatus
Description | string | This property is deprecated in favour of an OperationalStatus value of 11 ('In Service'). Boolean set to TRUE if an audit of the location of some or all of the Library's PhysicalMedia is currently being performed. That an individual Changer is currently doing an audit is indicated by a similar AuditInProgress boolean property on the Changer object.
AuditNeeded | boolean |
Deprecated | string | CIM_ComputerSystem.OperationalStatus
Description | string | This property is deprecated in favour of an OperationalStatus value of 0 ('Unknown'). Boolean set to TRUE if the Library can not currently report the correct state of each PhysicalMedia within its proper StorageMediaLocation.
Automated | boolean |
Deprecated | string | No value
Description | string | This property is deprecated since all managed libraries willbe automated. Boolean set to TRUE if the Library includes a robotics mechanism that can be controlled by a ComputerSystem, to automatically load and unload PhysicalMedia to/from MediaAccessDevices and StorageMediaLocations. The property is set to FALSE if the Library represents a repository of Media that are inaccessible to a MediaAccess Device without human intervention. An example of a non- automated Library is a 'shelf' or 'vault' where Physical Media are kept for extended periods of time.
MaxAuditTime | uint64 |
Description | string | Maximum time in seconds that it takes for the Storage Library to perform a complete audit of each StorageMedia Location, to determine the absence or presence of a Physical Media. If automated support is not provided, then this property's value is undefined.
PUnit | string | second
Units | string | Seconds
Overfilled | boolean |
Deprecated | string | CIM_ComputerSystem.OperationalStatus
Description | string | This property is deprecated in favour of an OperationalStatus value of 4 ('stressed'). Boolean set to TRUE if there are more PhysicalMedia in a Library than there are StorageMediaLocations to contain them. For instance, if all MediaAccessDevices have a Media loaded in them, and all StorageMediaLocations are loaded by an operator, then an Overfilled condition exists.
RoboticsEnabled | boolean |
Deprecated | string | CIM_ComputerSystem.OperationalStatus
Description | string | This property is deprecated in favour of an OperationalStatus value of 10 ('Stopped'). Boolean indicating whether the Library's robotics are currently active/enabled. If TRUE, then the Library may not be safe for a human to enter.
Capabilities | uint16[] |
Description | string | Capabilities of the StorageLibrary. For example, it can be indicated that the Library can perform automatic cleaning of the MediaAccessDevices contained in it (value=1) or that the Library provides physical door access for an operator (value=2).
ValueMap | string | 0, 2, 3, 4
Values | string | Unknown, Automatic Cleaning, Manual Operation, Front Panel Lockable

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
AllocationState | string | CIM_AllocatedLogicalElement
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_System
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_System
NameFormat | string | CIM_System
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_System
PrimaryOwnerName | string | CIM_System
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
IdentifyingDescriptions | string[] | CIM_System
OperationalStatus | uint16[] | CIM_ManagedSystemElement
OtherIdentifyingInfo | string[] | CIM_System
Roles | string[] | CIM_System
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### EnableRobotics (uint32)

#### Method Qualifiers (EnableRobotics)

Name | Data Type | Value
--- | --- | ---
Deprecated | string | CIM_ComputerSystem.RequestStateChange
Description | string | Requests that the Library robotics be enabled for automated operation (input parameter, Enabled, set to TRUE), or disabled for manual operation (input parameter set to FALSE). The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.

#### Method Parameters (EnableRobotics)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Enable | boolean
Description | string | Set TRUE to enable.
IN | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement