Class CIM_TapeCopyService
extends CIM_Service

Provides functions needed for the following type of copies: snapshot and selective copy.

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_TapeCopyService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringProvides functions needed for the following type of copies: snapshot and selective copy.
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

AcquireTape (uint16)

Method Qualifiers (AcquireTape)

NameData TypeValue
DescriptionstringAcquireTape initializes a transaction for a given tape and informs the provider that a sequence of actions will be performed on that tape. A transaction is defined as a sequence of actions on a tape, starting with AcquireTape and ending with ReleaseTape. A call to AcquireTape is required before any sequence of actions can be performed, actions that will result in an error if the tape activity is not 'Acquired'. These actions are: PositionTape, WriteMetaData, ReadMetaData, TapeSnapshot, SelectiveTapeCopy. GetTapeServicesActivity is the only call pertaining to a tape that doesn't require that tape to be 'Acquired'.For any given tape, additional calls to AcquireTape shall return an error unless ReleaseTape was called or if the AcquireTape timeout has expired.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Already Acquired, DMTF Reserved, Vendor Specific

Method Parameters (AcquireTape)

NameTypeQualifiers
NameData TypeValue
timeoutdatetime
DescriptionstringThe time after which an inactive transaction will automatically end (equivalent to an implicit call to RealeaseTape. A value of 0 indicates that the default timeout specified in TapeCopyServiceCapabilities will be used.
INbooleantrue
job REF CIM_ConcreteJob
Descriptionstringreturned reference to a job control object if AcquireTape is implemented asynchronously.
INbooleanfalse
OUTbooleantrue
targetTape REF CIM_PhysicalTape
DescriptionstringA reference to the tape that needs to be acquired
INbooleantrue

ReleaseTape (uint16)

Method Qualifiers (ReleaseTape)

NameData TypeValue
DescriptionstringReleaseTape marks the end of a transaction. At this point, the tape becomes available for use by other clients or for a new transaction. ReleaseTape shall fail if called on a tape whose activity is not 'Acquired'.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Operation in Progress, Tape Not Acquired, DMTF Reserved, Vendor Specific

Method Parameters (ReleaseTape)

NameTypeQualifiers
NameData TypeValue
job REF CIM_ConcreteJob
Descriptionstringreturned reference to a job control object if ReleaseTape is implemented asynchronously.
INbooleanfalse
OUTbooleantrue
targetTape REF CIM_PhysicalTape
DescriptionstringThe tape to be released.
INbooleantrue

PositionTape (uint16)

Method Qualifiers (PositionTape)

NameData TypeValue
DescriptionstringPositionTape positions a tape before data gets read or written by one of the following calls: ReadTapeMetaData, WriteTapeMetaData, TapeSnapshot, SelectiveTapeCopy. PositionTape uses relative positioning and can also be used to rewind the tape by passing 0 as a start position. PositionTape shall fail if called on a tape whose activity is not 'Acquired'.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Tape Not Acquired, DMTF Reserved, Vendor Specific

Method Parameters (PositionTape)

NameTypeQualifiers
NameData TypeValue
startsint64
DescriptionstringA number of elements of type start type. Relative positioning implie that negative values are acceptable. A zero value has a special meaning and will result in a full rewind of the tape.
INbooleantrue
startTypeuint16
DescriptionstringType of positioning: filemark or block
INbooleantrue
ValueMapstring1, 2, 3..65535
Valuesstringfilemark, block, Vendor Specific
job REF CIM_ConcreteJob
Descriptionstringreturned reference to a job control object if PositionTape is implemented asynchronously.
INbooleanfalse
OUTbooleantrue
targetTape REF CIM_PhysicalTape
DescriptionstringThe tape to be positioned
INbooleantrue

WriteTapeMetaData (uint16)

Method Qualifiers (WriteTapeMetaData)

NameData TypeValue
DescriptionstringWriteTapeMetaData writes meta data to tape at a the current tape position (specified by PositionTape). The size of the tape meta data size is limited to 1MB beyond which an error will be returned. WriteTapeMetaData shall fail if called on a tape whose activity is not 'Acquired'.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Tape Not Acquired, DMTF Reserved, Vendor Specific

Method Parameters (WriteTapeMetaData)

NameTypeQualifiers
NameData TypeValue
metaDatastring
DescriptionstringThe meta data to be written to tape, passed as an embedded instance. See CIM_TapeMetaData.mof for details
EmbeddedInstancestringCIM_TapeMetaData
INbooleantrue
job REF CIM_ConcreteJob
Descriptionstringreturned reference to a job control object if WriteTapeMetaData is implemented asynchronously.
INbooleanfalse
OUTbooleantrue
targetTape REF CIM_PhysicalTape
DescriptionstringThe tape to write meta data to
INbooleantrue

ReadTapeMetaData (uint16)

Method Qualifiers (ReadTapeMetaData)

NameData TypeValue
DescriptionstringReadTapeMetaData reads meta data from tape. The tape meta data size is limited to 1MB beyond which an error will be returned.The metaData parameter is a reference, which means that clients will have to retrieve the actual data from the provider through CIM access methods (i.e. GetInstance). The lifecycle of tape meta data on the provider is defined as follows: - A list of TapeMetaData instances will be maintained for every acquired tape. - The provider will delete a given TapeMetaData instance upon receiving a GetInstance call. - Upon receiving a ReleaseTape call, the provider will clear its list of TapeMetaData instances, thus ensuring proper memory management
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (ReadTapeMetaData)

NameTypeQualifiers
NameData TypeValue
sizeuint32
DescriptionstringNumber of elements of type 'sizeType' to be read
INbooleantrue
sizeTypeuint16
DescriptionstringType of elements to read: filemark or block
INbooleantrue
ValueMapstring1, 2, 3..65535
Valuesstringfilemark, block, Vendor Specific
job REF CIM_ConcreteJob
Descriptionstringreturned reference to a job control object if ReadTapeMetaData is implemented asynchronously.
INbooleanfalse
OUTbooleantrue
metaData REF CIM_TapeMetaData
DescriptionstringA reference to the TapeMetaData object resulting from the read
INbooleanfalse
OUTbooleantrue
targetTape REF CIM_PhysicalTape
DescriptionstringThe tape to read meta data from
INbooleantrue

TapeSnapshot (uint16)

Method Qualifiers (TapeSnapshot)

NameData TypeValue
DescriptionstringTapeSnapshot triggers a snapshot copy. TapeSnapshot shall fail if called on a tape whose activity is not 'Acquired'
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Source Tape Not Acquired, Target Tape Not Acquired, DMTF Reserved, Vendor Specific

Method Parameters (TapeSnapshot)

NameTypeQualifiers
NameData TypeValue
copyTypeuint16
DescriptionstringType of copy: simple snapshot or selective copy
INbooleantrue
ValueMapstring1, 2, 3..65535
ValuesstringSimpleSnapshot, SelectiveTapeCopy, Vendor Specific
job REF CIM_ConcreteJob
Descriptionstringreturned reference to a job control object if TapeSnapshot is implemented asynchronously.
INbooleanfalse
OUTbooleantrue
sourceTape REF CIM_PhysicalTape
DescriptionstringSource tape.
INbooleantrue
targetTape REF CIM_PhysicalTape
DescriptionstringTarget tape.
INbooleantrue

SelectiveTapeCopy (uint16)

Method Qualifiers (SelectiveTapeCopy)

NameData TypeValue
DescriptionstringSelectiveTapeCopy partially copies data. It allows a host system to copy all or part of a tape to another tape. SelectiveTapeCopy is to be used in conjunction with WriteTapeMetaData to add meta data to tape. SelectiveTapeCopy shall fail if called on a tape whose activity is not 'Acquired'
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Source Tape Not Acquired, Target Tape Not Acquired, DMTF Reserved, Vendor Specific

Method Parameters (SelectiveTapeCopy)

NameTypeQualifiers
NameData TypeValue
copyTypeuint16
DescriptionstringType of copy: simple snapshot or selective copy
INbooleantrue
ValueMapstring1, 2, 3..65535
ValuesstringSimpleSnapshot, SelectiveTapeCopy, Vendor Specific
sizeuint32
DescriptionstringNumber of elements of type 'sizeType' to be copied
INbooleantrue
sizeTypeuint16
DescriptionstringType of elements to copy: filemark or block
INbooleantrue
ValueMapstring1, 2, 3..65535
Valuesstringfilemark, block, Vendor Specific
job REF CIM_ConcreteJob
Descriptionstringreturned reference to a job control object if SelectiveTapeCopy is implemented asynchronously.
INbooleanfalse
OUTbooleantrue
sourceTape REF CIM_PhysicalTape
DescriptionstringSource tape.
INbooleantrue
targetTape REF CIM_PhysicalTape
DescriptionstringTarget tape.
INbooleantrue

GetTapeServicesActivity (uint16)

Method Qualifiers (GetTapeServicesActivity)

NameData TypeValue
DescriptionstringGetTapeCopyServices indicates what copy-related actions is currently performed on a given tape. GetTapeCopyServices shall be implemented synchronously. Concurrent clients can use this call to check whether copy operations are in progress. tape activity is returned by way of an OUT parameter, defined as an enumeration of the following values: - Idle: the target is not currently acquired. - Acquired: the target tape is currently acquired and no operation is currently being performed. - Writing: the target tape is acquired and tape meta data is being written. - Reading: the target tape is acquired and tape meta data is being read. - Positioning: the target tape is acquired and being positioned. - SnapshotCopy: the target tape is acquired and is the source or target tape of a snapshot copy. - SelectiveCopy: the target tape is acquired and is the source or target tape of a selective copy.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (GetTapeServicesActivity)

NameTypeQualifiers
NameData TypeValue
activityuint16
DescriptionstringCurrent tape activity returned
INbooleanfalse
OUTbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..65535
ValuesstringIdle, Acquired, Writing, Reading, Positioning, SnapshotCopy, SelectiveCopy, DMTF Reserved
targetTape REF CIM_PhysicalTape
DescriptionstringTarget tape.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service