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_System
   |
   +--CIM_StorageLibrary

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DeprecatedstringCIM_ComputerSystem, CIM_StorageLibraryCapabilities
DescriptionstringA 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.
UMLPackagePathstringCIM::Device::StorageLib
Versionstring2.9.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AuditInProgressboolean
DeprecatedstringCIM_ComputerSystem.OperationalStatus
DescriptionstringThis 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.
AuditNeededboolean
DeprecatedstringCIM_ComputerSystem.OperationalStatus
DescriptionstringThis 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.
Automatedboolean
DeprecatedstringNo value
DescriptionstringThis 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.
MaxAuditTimeuint64
DeprecatedstringCIM_StorageLibraryCapabilities.MaxAuditTime
DescriptionstringMaximum 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.
PUnitstringsecond
UnitsstringSeconds
Overfilledboolean
DeprecatedstringCIM_ComputerSystem.OperationalStatus
DescriptionstringThis 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.
RoboticsEnabledboolean
DeprecatedstringCIM_ComputerSystem.OperationalStatus
DescriptionstringThis 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.
Capabilitiesuint16[]
DeprecatedstringCIM_StorageLibraryCapabilities.Capabilities
DescriptionstringCapabilities 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).
ValueMapstring0, 2, 3, 4
ValuesstringUnknown, Automatic Cleaning, Manual Operation, Front Panel Lockable

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_System
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_System
NameFormatstringCIM_System
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_System
PrimaryOwnerNamestringCIM_System
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_System
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_System
Rolesstring[]CIM_System
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

EnableRobotics (uint32)

Method Qualifiers (EnableRobotics)

NameData TypeValue
DeprecatedstringCIM_ComputerSystem.RequestStateChange
DescriptionstringRequests 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)

NameTypeQualifiers
NameData TypeValue
Enableboolean
DescriptionstringSet TRUE to enable.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement