Class CIM_VirtualTapeLibrarySystemService
extends CIM_Service

This service allows the active management of a Virtual Tape Library System for the configuration of external Arrays, Physical Tape Libraries, Storage Volumes and Ports.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_VirtualTapeLibrarySystemService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis service allows the active management of a Virtual Tape Library System for the configuration of external Arrays, Physical Tape Libraries, Storage Volumes and Ports.
Experimentalbooleantrue
UMLPackagePathstringCIM::Device::Tape
Versionstring2.42.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

SetPortUse (uint32)

Method Qualifiers (SetPortUse)

NameData TypeValue
DescriptionstringConfigure the ports for usage as initiator or target ports.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (SetPortUse)

NameTypeQualifiers
NameData TypeValue

ListPLibrary (uint32)

Method Qualifiers (ListPLibrary)

NameData TypeValue
DescriptionstringList Physical Tape Libraries.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (ListPLibrary)

NameTypeQualifiers
NameData TypeValue
LibraryListCIM_ComputerSystem[]
DescriptionstringReferences to the Physical Tape Library CIM_ComputerSystem are returned in this arrary.
INbooleanfalse
OUTbooleantrue

AttachPLibrary (uint32)

Method Qualifiers (AttachPLibrary)

NameData TypeValue
DescriptionstringAttach to a Physical Tape Libraries. These methods are supported only if the ExternalPhysicalLibrary Boolean is set to TRUE indicating that the physical library or a partition is modeled using the cascading profile.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (AttachPLibrary)

NameTypeQualifiers
NameData TypeValue
PLibrary REF CIM_ComputerSystem
DescriptionstringReferences to the Physical Tape Library CIM_ComputerSystem.
INbooleantrue

DetachPLibrary (uint32)

Method Qualifiers (DetachPLibrary)

NameData TypeValue
DescriptionstringDetach and remove access from a Physical Tape Libraries. These methods are supported only if the ExternalPhysicalLibrary Boolean is set to TRUE indicating that the physical library or a partition is modeled using the cascading profile.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (DetachPLibrary)

NameTypeQualifiers
NameData TypeValue
PLibrary REF CIM_ComputerSystem
DescriptionstringReferences to the Physical Tape Library CIM_ComputerSystem.
INbooleantrue

ListArray (uint32)

Method Qualifiers (ListArray)

NameData TypeValue
DescriptionstringList external storage arrays.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (ListArray)

NameTypeQualifiers
NameData TypeValue
ArrayListCIM_ComputerSystem[]
DescriptionstringReferences to the external storage array CIM_ComputerSystem are returned in this arrary.
INbooleanfalse
OUTbooleantrue

AttachArray (uint32)

Method Qualifiers (AttachArray)

NameData TypeValue
DescriptionstringAttach to an external storage array. These methods are supported only if the ExternalArray Boolean is set to TRUE indicating that the storage iarray is modelled using the cascading profile.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (AttachArray)

NameTypeQualifiers
NameData TypeValue
Array REF CIM_ComputerSystem
DescriptionstringReferences to the external array CIM_ComputerSystem.
INbooleantrue

DetachArray (uint32)

Method Qualifiers (DetachArray)

NameData TypeValue
DescriptionstringDetach and remove access to a storage array. These methods are supported only if the ExternalArray Boolean is set to TRUE indicating that the physical storage array is modelled using the cascading profile.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (DetachArray)

NameTypeQualifiers
NameData TypeValue
Array REF CIM_ComputerSystem
DescriptionstringReferences to the external array CIM_ComputerSystem.
INbooleantrue

ListStorageVolumes (uint32)

Method Qualifiers (ListStorageVolumes)

NameData TypeValue
DescriptionstringList storage volumes of an external storage array that may be used by this Virtual Tape LIbrary System.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (ListStorageVolumes)

NameTypeQualifiers
NameData TypeValue
StorageVolumesstring[]
DescriptionstringA list of correlatable IDs of the StorageVolumes is returned in this string arrary.
INbooleanfalse
OUTbooleantrue
Array REF CIM_ComputerSystem
DescriptionstringReference to the external storage array CIM_ComputerSystem to get the StorageVolumes from.
INbooleantrue

AttachStorageVolume (uint32)

Method Qualifiers (AttachStorageVolume)

NameData TypeValue
DescriptionstringAttach to the StorageVolume as specified by the StorageVolumeID.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (AttachStorageVolume)

NameTypeQualifiers
NameData TypeValue
StorageVolumeIDstring
DescriptionstringThe ID of the StorageVolume to attach to.
INbooleantrue

DetachStorageVolume (uint32)

Method Qualifiers (DetachStorageVolume)

NameData TypeValue
DescriptionstringDetach and remove access to StorageVolume.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (DetachStorageVolume)

NameTypeQualifiers
NameData TypeValue
StorageVolumeIDstring
DescriptionstringThe ID of the StorageVolume to detach from.
INbooleantrue

RescanPhysicalHardware (uint32)

Method Qualifiers (RescanPhysicalHardware)

NameData TypeValue
DescriptionstringScan for external arrays and physical tape libraries.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (RescanPhysicalHardware)

NameTypeQualifiers
NameData TypeValue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service