Class CIM_VirtualTapeLibraryConfigurationService
extends CIM_Service

CIM_VirtualTapeLibraryConfigurationService allows the active management of a Virtual Tape Library System for the creation, modification, and deletion of Virtual Tape Libraries.

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_VirtualTapeLibraryConfigurationService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringCIM_VirtualTapeLibraryConfigurationService allows the active management of a Virtual Tape Library System for the creation, modification, and deletion of Virtual Tape Libraries.
Experimentalbooleantrue
UMLPackagePathstringCIM::Device::Tap
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

CreateVTL (uint32)

Method Qualifiers (CreateVTL)

NameData TypeValue
DescriptionstringCreate a Virtual Tape Library. If the operation completes successfully, it will return 0. This method shall 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 TheVTL will contain a Reference to the VirtualTapeLibrary CIM_ComputerSystem if this operation completed successfully. The desired settings for the VTL are specified by the VTLSetting reference parameter.
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 (CreateVTL)

NameTypeQualifiers
NameData TypeValue
TheVTL REF CIM_ComputerSystem
DescriptionstringThe newly created VTL CIM_CompuyerSystem object.
INbooleanfalse
OUTbooleantrue
VTLSetting REF CIM_VirtualTapeLibrarySetting
DescriptionstringThe requirements for the VirtualTapeLibrary element to maintain. This is a reference to a CIM_VirtualTapeLibrarySetting or a derived class instance parameter; this allows the client to specify the properties desired for the virtual tape library. When the VTL is created successfully, this setting object is attached to the VTL CIM_ComputerSystem object.
INbooleantrue

ModifyVTL (uint32)

Method Qualifiers (ModifyVTL)

NameData TypeValue
DescriptionstringModify a previously created VTL. 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 (or other) parameter (either reference or embedded object) 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 VTLSetting specifies the setting to be modified. This element MUST be associated via ElementSettingData with a VTL CIM_ComputerSystem.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 4098..32767, 32768..65535
ValuesstringNo Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, VTL In Use, cannot Modify, Cannot satisfy new Goal., DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (ModifyVTL)

NameTypeQualifiers
NameData TypeValue
VTLSetting REF CIM_VirtualTapeLibrarySetting
DescriptionstringA reference to the VTL setting object that contains the Modify property parameter populated with a list of properties to be modified.
INbooleantrue

DeleteVTL (uint32)

Method Qualifiers (DeleteVTL)

NameData TypeValue
DescriptionstringDelete a VTL. If the method completed successfully it will return 0.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096..32767, 32768..
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Unspecified Reasons, Invalid Parameter, VTL in use, Failed, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (DeleteVTL)

NameTypeQualifiers
NameData TypeValue
SaveTapesboolean
DescriptionstringA Boolean to indicate if the virtual tapes in the library are to be deleted or not.
INbooleantrue
TheVTL REF CIM_ComputerSystem
DescriptionstringAn element or association that uniquely identifies the VTL to be deleted.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service