Class CIM_OpaqueManagementDataService
extends CIM_Service

A class derived from Service that contains global properties of the opaque management data functionality in the CIM server, and provides methods for using this functionality.

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_OpaqueManagementDataService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA class derived from Service that contains global properties of the opaque management data functionality in the CIM server, and provides methods for using this functionality.
Experimentalbooleantrue
UMLPackagePathstringCIM::Core::OpaqueManagementData
Versionstring2.18.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AvailableStorageuint64
DescriptionstringThe number of bytes of opaque management data storage available from the CIM_OpaqueManagementDataService. The value of AvailableStorage shall not exceed the value of MaxAvailableStorage in the associated CIM_OpaqueManagementDataCapabilities.
ModelCorrespondencestringCIM_OpaqueManagementDataCapabilities.MaxAvailableStorage
PUnitstringbyte
LockTimeoutdatetime
DescriptionstringThe amount of time a lock on a CIM_OpaqueManagementData instance shall remain in effect without execution of any CIM_OpaqueManagementDataService extrinsic methods on that CIM_OpaqueManagementData instance by the Identity that holds the lock. Locks on CIM_OpaqueManagementData are created by LockOpaqueManagementData(). The intent of the timeout is to ensure that a lock is released if the lock holder neglects to release it or is unable to release it. The value of LockTimeout shall be a duration.

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
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

CreateOpaqueManagementData (uint32)

Method Qualifiers (CreateOpaqueManagementData)

NameData TypeValue
DescriptionstringCreateOpaqueManagementData creates an instance of CIM_OpaqueManagementData using the property values in the OpaqueManagementData parameter, and allocates the number of bytes of storage specified in the MaxSize property of the OpaqueManagementData parameter. It also optionally allows the client to specify an existing CIM_StorageExtent instance as the basis (storage location) of the new CIM_OpaqueManagementData instance.
ValueMapstring0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified

Method Parameters (CreateOpaqueManagementData)

NameTypeQualifiers
NameData TypeValue
OpaqueManagementDataTemplatestring
DescriptionstringThe embedded instance string OpaqueManagementData contains the initial property values for the new CIM_OpaqueManagementData instance
EmbeddedInstancestringCIM_OpaqueManagementData
INbooleantrue
Requiredbooleantrue
BasedOnExtent REF CIM_StorageExtent
DescriptionstringSpecifies the instance of CIM_StorageExtent on which the new instance of CIM_OpaqueManagementData shall be based (i.e., in which it shall be stored). If this parameter is NULL, the choice of storage location shall be left to the implementation.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
OpaqueManagementData REF CIM_OpaqueManagementData
DescriptionstringReference to the instance of CIM_OpaqueManagementData created when the method returns a value of 0.
INbooleanfalse
OUTbooleantrue
Owner REF CIM_Identity
DescriptionstringSpecifies the instance of CIM_Identity or its subclass that shall be the owner of the new CIM_OpaqueManagementData instance. CreateOpaqueManagementData shall associate the new CIM_OpaqueManagementData instance with this CIM_Identity instance using a new instance of CIM_IdentityUsesOpaqueManagementData.
INbooleantrue
Requiredbooleantrue

ReadOpaqueManagementData (uint32)

Method Qualifiers (ReadOpaqueManagementData)

NameData TypeValue
DescriptionstringReadOpaqueManagementData returns all or some of the bytes of opaque management data in the extent represented by the referenced instance of CIM_OpaqueManagementData.
ValueMapstring0, 1, 2, 3..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified

Method Parameters (ReadOpaqueManagementData)

NameTypeQualifiers
NameData TypeValue
Lengthuint64
DescriptionstringOn entry, Length shall contain the number of bytes to be read, starting at the byte offset in the Offset property. On return, Length shall contain the number of bytes that were actually read.
INbooleantrue
ModelCorrespondencestringCIM_OpaqueManagementDataCapabilities.MaxReadLength
OUTbooleantrue
PUnitstringbyte
Requiredbooleantrue
Offsetuint64
DescriptionstringOffset specifies the byte offset at which to start reading.
INbooleantrue
PUnitstringbyte
Requiredbooleantrue
Datauint8[]
DescriptionstringOn return, Data shall contain the bytes of opaque management data read from the extent represented by the OpaqueManagementData parameter.
INbooleanfalse
OctetStringbooleantrue
OUTbooleantrue
LockTokenuint8[]
DescriptionstringA token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the LockOpaqueManagementData method. Parameter shall be NULL if data is not locked.
INbooleantrue
OctetStringbooleantrue
OpaqueManagementData REF CIM_OpaqueManagementData
DescriptionstringThe CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
INbooleantrue
Requiredbooleantrue

ExportOpaqueManagementDataToURI (uint32)

Method Qualifiers (ExportOpaqueManagementDataToURI)

NameData TypeValue
DescriptionstringExportOpaqueManagementDataToURI copies all or some of the bytes of opaque management data in the extent represented by the referenced instance of CIM_OpaqueManagementData to the Uniform Resource Identifier (URI) specified in the ExportURI parameter. The URI scheme implies the protocol that shall be used. Typically, the URI will be a Uniform Resource Locator (URL), but a Uniform Resource Name (URN) is not prohibited. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob shall be started to to perform the operation. The Job's reference shall be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified

Method Parameters (ExportOpaqueManagementDataToURI)

NameTypeQualifiers
NameData TypeValue
ExportURIstring
DescriptionstringOn entry, ExportURI contains a URI based on RFC 3986 that indicates the location to which the service shall copy the specified bytes of opaque management data and from which the client subsequently retrieves them.
INbooleantrue
ModelCorrespondencestringCIM_OpaqueManagementDataCapabilities.SupportedExportURISchemes
Requiredbooleantrue
Lengthuint64
DescriptionstringOn entry, Length contains the number of bytes to be read, starting at the byte offset in the Offset property. On return, Length contains the number of bytes that were actually read.
INbooleantrue
OUTbooleantrue
PUnitstringbyte
Requiredbooleantrue
Offsetuint64
DescriptionstringOffset specifies the byte offset at which to start reading.
INbooleantrue
PUnitstringbyte
Requiredbooleantrue
LockTokenuint8[]
DescriptionstringA token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the LockOpaqueManagementData method.
INbooleantrue
OctetStringbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
OpaqueManagementData REF CIM_OpaqueManagementData
DescriptionstringThe CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
INbooleantrue
Requiredbooleantrue

WriteOpaqueManagementData (uint32)

Method Qualifiers (WriteOpaqueManagementData)

NameData TypeValue
DescriptionstringWriteOpaqueManagementData modifies all or some of the bytes in the extent represented by the referenced instance of CIM_OpaqueManagementData. Any data already present in the extent outside the range specified by Offset and Length shall remain unchanged by this operation.
ValueMapstring0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified

Method Parameters (WriteOpaqueManagementData)

NameTypeQualifiers
NameData TypeValue
Lengthuint64
DescriptionstringOn entry, Length contains the number of bytes to be written, starting at the byte offset in the Offset. property. On return, Length contains the number of bytes that were actually written.
INbooleantrue
ModelCorrespondencestringCIM_OpaqueManagementDataCapabilities.MaxWriteLength
OUTbooleantrue
PUnitstringbyte
Requiredbooleantrue
Offsetuint64
DescriptionstringOffset specifies the byte offset at which to start writing.
INbooleantrue
PUnitstringbyte
Requiredbooleantrue
Datauint8[]
DescriptionstringOn entry, Data contains the bytes of opaque management data to be written into the extent represented by the OpaqueManagementData parameter.
INbooleantrue
OctetStringbooleantrue
Requiredbooleantrue
LockTokenuint8[]
DescriptionstringA token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the LockOpaqueManagementData method.
INbooleantrue
OctetStringbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
OpaqueManagementData REF CIM_OpaqueManagementData
DescriptionstringThe CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
INbooleantrue
Requiredbooleantrue

ImportOpaqueManagementDataFromURI (uint32)

Method Qualifiers (ImportOpaqueManagementDataFromURI)

NameData TypeValue
DescriptionstringImportOpaqueManagementDataFromURI modifies all or some of the bytes in the referenced instance of CIM_OpaqueManagementData. The imported data for the operation is copied from the URI specified in the ImportURI parameter. The URI scheme implies the protocol that shall be used. Typically, the URI will be a Uniform Resource Locator (URL), but a Uniform Resource Name (URN) is not prohibited. Any data already present in the instance outside the range specified by Offset and Length is unchanged. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob shall be started to perform the operation. The Job's reference shall be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified

Method Parameters (ImportOpaqueManagementDataFromURI)

NameTypeQualifiers
NameData TypeValue
ImportURIstring
DescriptionstringOn entry, ImportURI contains a URI based on RFC 3986 that shall be used by the service to retrieve the bytes of opaque management data to be written into the extent represented by the OpaqueManagementData parameter.
INbooleantrue
ModelCorrespondencestringCIM_OpaqueManagementDataCapabilities.SupportedImportURISchemes
Requiredbooleantrue
Lengthuint64
DescriptionstringOn entry, Length contains the number of bytes to be written, starting at the byte offset in the Offset. property. On return, Length contains the number of bytes that were actually written.
INbooleantrue
OUTbooleantrue
PUnitstringbyte
Requiredbooleantrue
Offsetuint64
DescriptionstringOffset specifies the byte offset at which to start writing.
INbooleantrue
PUnitstringbyte
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
OpaqueManagementData REF CIM_OpaqueManagementData
DescriptionstringThe CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
INbooleantrue
Requiredbooleantrue

LockOpaqueManagementData (uint32)

Method Qualifiers (LockOpaqueManagementData)

NameData TypeValue
DescriptionstringLockOpaqueManagementData allows a management client to atomically read or write an opaque management data storage extent larger than MaxReadLength or MaxWriteLength, respectively. A server that supports this method shall support the following pattern: 1. Issue LockOpaqueManagementData with Lock set to true to lock the CIM_OpaqueManagementData instance. 2. Repeat ReadOpaqueManagementData or WriteOpaqueManagementData as many times as necessary to complete the transfer 3. Issue LockOpaqueManagementData with Lock set to false to unlock the CIM_OpaqueManagementData instance If LockOpaqueManagementData with Lock set to true completes successfully, the server shall return a LockToken to the client. Until the lock is removed or expires, the server shall deny OpaqueManagementDataService method requests on the same CIM_OpaqueManagementData instance that do not contain the same LockToken value. LockOpaqueManagementData shall not lock the properties of the OpaqueManagementData instance. The method shall return 0 if successful, 1 if not supported, and any other value if an error occurred.
ValueMapstring0, 1, 2, 3..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified

Method Parameters (LockOpaqueManagementData)

NameTypeQualifiers
NameData TypeValue
Lockboolean
DescriptionstringIf true, lock the data from access by another management client. If false, release the data.
INbooleantrue
Requiredbooleantrue
LockTokenuint8[]
DescriptionstringA token that shall be returned to the client as output if Lock is True, and supplied by the client as input if Lock is False. In this way, only the client that set the Lock may remove it or delegate such responsibility to another client.
INbooleantrue
OctetStringbooleantrue
OUTbooleantrue
OpaqueManagementData REF CIM_OpaqueManagementData
DescriptionstringThe CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
INbooleantrue
Requiredbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service