# 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

Name | Data Type | Value
--- | --- | ---
Description | string | 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.
Experimental | boolean | true
UMLPackagePath | string | CIM::Device::Tape
Version | string | 2.42.0

## Class Properties

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
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
LoSID | string | CIM_Service
LoSOrgID | string | CIM_Service
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### SetPortUse (uint32)

#### Method Qualifiers (SetPortUse)

Name | Data Type | Value
--- | --- | ---
Description | string | Configure the ports for usage as initiator or target ports.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (SetPortUse)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value

#### ListPLibrary (uint32)

#### Method Qualifiers (ListPLibrary)

Name | Data Type | Value
--- | --- | ---
Description | string | List Physical Tape Libraries.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (ListPLibrary)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
LibraryList | CIM_ComputerSystem[]
Description | string | References to the Physical Tape Library CIM_ComputerSystem are returned in this arrary.
IN | boolean | false
OUT | boolean | true

#### AttachPLibrary (uint32)

#### Method Qualifiers (AttachPLibrary)

Name | Data Type | Value
--- | --- | ---
Description | string | Attach 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (AttachPLibrary)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
PLibrary | REF CIM_ComputerSystem
Description | string | References to the Physical Tape Library CIM_ComputerSystem.
IN | boolean | true

#### DetachPLibrary (uint32)

#### Method Qualifiers (DetachPLibrary)

Name | Data Type | Value
--- | --- | ---
Description | string | Detach 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (DetachPLibrary)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
PLibrary | REF CIM_ComputerSystem
Description | string | References to the Physical Tape Library CIM_ComputerSystem.
IN | boolean | true

#### ListArray (uint32)

#### Method Qualifiers (ListArray)

Name | Data Type | Value
--- | --- | ---
Description | string | List external storage arrays.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (ListArray)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ArrayList | CIM_ComputerSystem[]
Description | string | References to the external storage array CIM_ComputerSystem are returned in this arrary.
IN | boolean | false
OUT | boolean | true

#### AttachArray (uint32)

#### Method Qualifiers (AttachArray)

Name | Data Type | Value
--- | --- | ---
Description | string | Attach 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (AttachArray)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Array | REF CIM_ComputerSystem
Description | string | References to the external array CIM_ComputerSystem.
IN | boolean | true

#### DetachArray (uint32)

#### Method Qualifiers (DetachArray)

Name | Data Type | Value
--- | --- | ---
Description | string | Detach 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (DetachArray)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Array | REF CIM_ComputerSystem
Description | string | References to the external array CIM_ComputerSystem.
IN | boolean | true

#### ListStorageVolumes (uint32)

#### Method Qualifiers (ListStorageVolumes)

Name | Data Type | Value
--- | --- | ---
Description | string | List storage volumes of an external storage array that may be used by this Virtual Tape LIbrary System.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (ListStorageVolumes)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
StorageVolumes | string[]
Description | string | A list of correlatable IDs of the StorageVolumes is returned in this string arrary.
IN | boolean | false
OUT | boolean | true
Array | REF CIM_ComputerSystem
Description | string | Reference to the external storage array CIM_ComputerSystem to get the StorageVolumes from.
IN | boolean | true

#### AttachStorageVolume (uint32)

#### Method Qualifiers (AttachStorageVolume)

Name | Data Type | Value
--- | --- | ---
Description | string | Attach to the StorageVolume as specified by the StorageVolumeID.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (AttachStorageVolume)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
StorageVolumeID | string
Description | string | The ID of the StorageVolume to attach to.
IN | boolean | true

#### DetachStorageVolume (uint32)

#### Method Qualifiers (DetachStorageVolume)

Name | Data Type | Value
--- | --- | ---
Description | string | Detach and remove access to StorageVolume.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (DetachStorageVolume)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
StorageVolumeID | string
Description | string | The ID of the StorageVolume to detach from.
IN | boolean | true

#### RescanPhysicalHardware (uint32)

#### Method Qualifiers (RescanPhysicalHardware)

Name | Data Type | Value
--- | --- | ---
Description | string | Scan for external arrays and physical tape libraries.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, .., 4098..32767, 32768..65535
Values | string | No Error, Not Supported, Unknown, Timeout, Failed, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (RescanPhysicalHardware)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
ChangeAffectedElementsAssignedSequence | uint32 | CIM_Service
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service