Class CIM_VirtualTapeService
extends CIM_Service

This service allows the active management of a Virtual Tape Library System for the creation, modification, and deletion of Virtual Tapes.

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_VirtualTapeService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis service allows the active management of a Virtual Tape Library System for the creation, modification, and deletion of Virtual Tapes.
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

CreateTapeFromPool (uint32)

Method Qualifiers (CreateTapeFromPool)

NameData TypeValue
DescriptionstringCreate one or more Virtual Tapes. If the operation completes successfully, it will return 0. This method MUST return a CIM_Error representing that a single named property of a setting reference parameter has an invalid value or that an invalid combination of named properties of a setting (or other) parameter (either reference or embedded object) has been requested. The parameter TheTape will contain a Reference to the virtual PhysicalTape if this operation completed successfully. The desired settings for the Tape are specified by the TapeSetting reference parameter.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, .., 4098..32767, 32768..65535
ValuesstringNo Error, No Space, No Library, No Slots, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (CreateTapeFromPool)

NameTypeQualifiers
NameData TypeValue
Countuint32
DescriptionstringNumber of virtual tapes to create.
StartingSlotuint32
DescriptionstringThe new tapes will be placed in empty slots that are equal to or higher than this given slot number. This number can be zero indicating that the new tapes can be placed in any emptry slots.
NewTapeCIM_PhysicalTape[]
DescriptionstringAn array of newly created virtual PhysicalTape objects.
INbooleanfalse
OUTbooleantrue
Pool REF CIM_StoragePool
DescriptionstringStorage pool form which space for the Tape media is to be allocated from.
TapeSetting REF CIM_VirtualTapeSettingData
DescriptionstringThe requirements for the VirtualTape element to maintain. This is a reference to a CIM_VirtualTapeSettingData or a derived class instance parameter; this allows the client to specify the properties desired for the virtual tape. When the Tape is created successfully, this setting object is attached to the PhysicalTape objects.
VirtualLibrary REF CIM_ComputerSystem
DescriptionstringThe owning Virtual TapeLibrary for the new virtual tapes.

DeleteTape (uint32)

Method Qualifiers (DeleteTape)

NameData TypeValue
DescriptionstringDelete a virtual PhysicalTape and return space to the source storage pool. If the method completed successfully it will return 0.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 4096..32767, 32768..
ValuesstringJob Completed with No Error, No Such Tape, Not Supported, Unknown, Timeout, Failed, Unspecified Reasons, Invalid Parameter, Tape in use, Failed, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (DeleteTape)

NameTypeQualifiers
NameData TypeValue
TheTape REF CIM_PhysicalTape
DescriptionstringA reference to the virtual PhysicalTape to be deleted.

MoveMedia (uint32)

Method Qualifiers (MoveMedia)

NameData TypeValue
DescriptionstringMove virtual PhysicalTape media from one slot to another. The destination can be a slot number of a vault where the tape is moved to a virtual vault with no access to a host. The destination can also be a Input/Output port of the virtual TapeLibrary in which case the virtual tape will be exported to a physical media.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 4096..32767, 32768..
ValuesstringJob Completed with No Error, No Such Tape, Not Supported, Unknown, Timeout, Failed, Unspecified Reasons, Invalid Parameter, Tape in use, Failed, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (MoveMedia)

NameTypeQualifiers
NameData TypeValue
Destination REF CIM_StorageMediaLocation
DescriptionstringA reference to the destination slot.
Source REF CIM_StorageMediaLocation
DescriptionstringA reference to the slot containing the media to be moved.

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service