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

Direct Known Subclasses

Class Qualifiers

Name	Data Type	Value
Description	string	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.
UMLPackagePath	string	CIM::Core::OpaqueManagementData
Version	string	2.22.1

Class Properties

Local Class Properties

Name	Data Type	Default Value	Qualifiers
Name	Data Type	Default Value	Name	Data Type	Value
AvailableStorage	uint64
			Description	string	The 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.
			ModelCorrespondence	string	CIM_OpaqueManagementDataCapabilities.MaxAvailableStorage
			PUnit	string	byte
LockTimeout	datetime
LockTimeout	datetime		Description	string	The 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 Lock(). 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.
MaxCreateSize	uint64
			Description	string	MaxCreateSize shall contain the maximum value that the implementation will currently accept in the MaxSize property of the OpaqueManagementDataTemplate embedded instance parameter in a call to Create(). This value may change over time for any reason, including but not limited to fragmentation of the storage resources managed by the service.
			ModelCorrespondence	string	CIM_OpaqueManagementData.MaxSize
			PUnit	string	byte

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

AssignAccess (uint32)

Method Qualifiers (AssignAccess)

Name	Data Type	Value
Description	string	Grants or removes access to the referenced CIM_OpaqueManagementData instance by the referenced CIM_Identity instance.
ValueMap	string	0, 1, 2, 3..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified

Method Parameters (AssignAccess)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Activities	uint16[]
		Description	string	The subset of values from the value map that shall be contained in the resulting Activities property of the CIM_AssociatedPrivilege between the CIM_Identity instance referenced by the Identity parameter and the CIM_OpaqueManagementData instance referenced by the OpaqueManagementData parameter. If such an instance of CIM_AssociatedPrivilege does not exist before the method is invoked, the method shall create it.
		IN	boolean	true
		ModelCorrespondence	string	CIM_AssociatedPrivilege.Activities
		Required	boolean	true
		ValueMap	string	5, 6
		Values	string	Read, Write
Identity	REF CIM_Identity
		Description	string	Reference to the CIM_Identity instance that is the subject of the access rights modified by this method.
		IN	boolean	true
		Required	boolean	true
OpaqueManagementData	REF CIM_OpaqueManagementData
		Description	string	Reference to the CIM_OpaqueManagementData instance that is the target of the access rights modified by this method.
		IN	boolean	true
		Required	boolean	true

Create (uint32)

Method Qualifiers (Create)

Name	Data Type	Value
Description	string	Create() 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.
ValueMap	string	0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified

Method Parameters (Create)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	string
		Description	string	The value of the DataFormat property in the CIM_OpaqueManagementData instance created by this method.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementData.DataFormat
ElementName	string
		Description	string	The value of the ElementName property in the CIM_OpaqueManagementData instance created by this method.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementData.ElementName
MaxSize	uint64
		Description	string	The requested value of the MaxSize property in the CIM_OpaqueManagementData instance created by this method. The actual property value shall not be less than this value.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementData.MaxSize
		Required	boolean	true
BasedOnExtent	REF CIM_StorageExtent
		Description	string	Specifies 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.
		IN	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true
OpaqueManagementData	REF CIM_OpaqueManagementData
		Description	string	Reference to the instance of CIM_OpaqueManagementData created when the method returns a value of 0.
		IN	boolean	false
		OUT	boolean	true
Owner	REF CIM_Identity
		Description	string	Specifies the instance of CIM_Identity or its subclass that shall be the owner of the new CIM_OpaqueManagementData instance. Create() shall associate the new CIM_OpaqueManagementData instance with this CIM_Identity instance using a new instance of CIM_AssociatedPrivilege.
		IN	boolean	true
		Required	boolean	true

ExportToURI (uint32)

Method Qualifiers (ExportToURI)

Name	Data Type	Value
Description	string	ExportToURI() 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.
ValueMap	string	0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified

Method Parameters (ExportToURI)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
ExportURI	string
		Description	string	On 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.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementDataCapabilities.SupportedExportURISchemes
		Required	boolean	true
Length	uint64
		Description	string	On 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.
		IN	boolean	true
		OUT	boolean	true
		PUnit	string	byte
		Required	boolean	true
Offset	uint64
		Description	string	Offset specifies the byte offset at which to start reading.
		IN	boolean	true
		PUnit	string	byte
		Required	boolean	true
LockToken	uint8[]
		Description	string	A token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the Lock() method.
		IN	boolean	true
		OctetString	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true
OpaqueManagementData	REF CIM_OpaqueManagementData
		Description	string	The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
		IN	boolean	true
		Required	boolean	true

ImportFromURI (uint32)

Method Qualifiers (ImportFromURI)

Name	Data Type	Value
Description	string	ImportFromURI() 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.
ValueMap	string	0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified

Method Parameters (ImportFromURI)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
ImportURI	string
		Description	string	On 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.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementDataCapabilities.SupportedImportURISchemes
		Required	boolean	true
Length	uint64
		Description	string	On 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.
		IN	boolean	true
		OUT	boolean	true
		PUnit	string	byte
		Required	boolean	true
Offset	uint64
		Description	string	Offset specifies the byte offset at which to start writing.
		IN	boolean	true
		PUnit	string	byte
		Required	boolean	true
Truncate	boolean
		Description	string	If the value of the DataSize property of the instance referenced by the OpaqueManagementData parameter is greater than Offset + Length, then a value of TRUE shall indicate that the DataSize property value shall be reduced by this operation to Offset + Length, and a value of FALSE shall indicate that the DataSize property value shall remain unchanged by this operation. If the value of the DataSize property is not greater than Offset + Length, then this parameter shall be ignored.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementData.DataSize
LockToken	uint8[]
		Description	string	A token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the Lock() method.
		IN	boolean	true
		OctetString	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true
OpaqueManagementData	REF CIM_OpaqueManagementData
		Description	string	The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
		IN	boolean	true
		Required	boolean	true

Lock (uint32)

Method Qualifiers (Lock)

Name	Data Type	Value
Description	string	Lock() 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 Lock() with Lock set to true to lock the CIM_OpaqueManagementData instance. 2. Repeat Read() or Write() as many times as necessary to complete the transfer 3. Issue Lock() with Lock set to false to unlock the CIM_OpaqueManagementData instance If Lock() 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. Lock() 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.
ValueMap	string	0, 1, 2, 3..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified

Method Parameters (Lock)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Lock	boolean
		Description	string	If true, lock the data from access by another management client. If false, release the data.
		IN	boolean	true
		Required	boolean	true
LockToken	uint8[]
		Description	string	A 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.
		IN	boolean	true
		OctetString	boolean	true
		OUT	boolean	true
OpaqueManagementData	REF CIM_OpaqueManagementData
		Description	string	The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
		IN	boolean	true
		Required	boolean	true

Read (uint32)

Method Qualifiers (Read)

Name	Data Type	Value
Description	string	Read() returns all or some of the bytes of opaque management data in the extent represented by the referenced instance of CIM_OpaqueManagementData.
ValueMap	string	0, 1, 2, 3..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified

Method Parameters (Read)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Length	uint64
		Description	string	On 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.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementDataCapabilities.MaxReadLength
		OUT	boolean	true
		PUnit	string	byte
		Required	boolean	true
Offset	uint64
		Description	string	Offset specifies the byte offset at which to start reading.
		IN	boolean	true
		PUnit	string	byte
		Required	boolean	true
Data	uint8[]
		Description	string	On return, Data shall contain the bytes of opaque management data read from the extent represented by the OpaqueManagementData parameter.
		IN	boolean	false
		OctetString	boolean	true
		OUT	boolean	true
LockToken	uint8[]
		Description	string	A token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the Lock() method. Parameter shall be NULL if data is not locked.
		IN	boolean	true
		OctetString	boolean	true
OpaqueManagementData	REF CIM_OpaqueManagementData
		Description	string	The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
		IN	boolean	true
		Required	boolean	true

ReassignOwnership (uint32)

Method Qualifiers (ReassignOwnership)

Name	Data Type	Value
Description	string	Transfers ownership of a CIM_OpaqueManagementData instance to the CIM_Identity instance referenced by the Identity parameter.
ValueMap	string	0, 1, 2, 3..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified

Method Parameters (ReassignOwnership)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
NewOwner	REF CIM_Identity
		Description	string	Reference to the CIM_Identity instance that will become the new owner of the CIM_OpaqueManagementData instance referenced by the OpaqueManagementData parameter.
		IN	boolean	true
		Required	boolean	true
OpaqueManagementData	REF CIM_OpaqueManagementData
		Description	string	Reference to the CIM_OpaqueManagementData instance that is the target of ownership reassignment.
		IN	boolean	true
		Required	boolean	true

Write (uint32)

Method Qualifiers (Write)

Name	Data Type	Value
Description	string	Write() 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.
ValueMap	string	0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified

Method Parameters (Write)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Length	uint64
		Description	string	On 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.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementDataCapabilities.MaxWriteLength
		OUT	boolean	true
		PUnit	string	byte
		Required	boolean	true
Offset	uint64
		Description	string	Offset specifies the byte offset at which to start writing.
		IN	boolean	true
		PUnit	string	byte
		Required	boolean	true
Truncate	boolean
		Description	string	If the value of the DataSize property of the instance referenced by the OpaqueManagementData parameter is greater than Offset + Length, then a value of TRUE shall indicate that the DataSize property value shall be reduced by this operation to Offset + Length, and a value of FALSE shall indicate that the DataSize property value shall remain unchanged by this operation. If the value of the DataSize property is not greater than Offset + Length, then this parameter shall be ignored.
		IN	boolean	true
		ModelCorrespondence	string	CIM_OpaqueManagementData.DataSize
Data	uint8[]
		Description	string	On entry, Data contains the bytes of opaque management data to be written into the extent represented by the OpaqueManagementData parameter.
		IN	boolean	true
		OctetString	boolean	true
		Required	boolean	true
LockToken	uint8[]
		Description	string	A token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the Lock() method.
		IN	boolean	true
		OctetString	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true
OpaqueManagementData	REF CIM_OpaqueManagementData
		Description	string	The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation.
		IN	boolean	true
		Required	boolean	true

Inherited Class Methods

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

Class CIM_OpaqueManagementDataServiceextends CIM_Service

Table of Contents Hierarchy Direct Known Subclasses Class Qualifiers Class Properties Class Methods

Class Hierarchy

Direct Known Subclasses

Class Qualifiers

Class Properties

Local Class Properties

Inherited Properties

Class Methods

Local Class Methods

AssignAccess (uint32)

Method Qualifiers (AssignAccess)

Method Parameters (AssignAccess)

Create (uint32)

Method Qualifiers (Create)

Method Parameters (Create)

ExportToURI (uint32)

Method Qualifiers (ExportToURI)

Method Parameters (ExportToURI)

ImportFromURI (uint32)

Method Qualifiers (ImportFromURI)

Method Parameters (ImportFromURI)

Lock (uint32)

Method Qualifiers (Lock)

Method Parameters (Lock)

Read (uint32)

Method Qualifiers (Read)

Method Parameters (Read)

ReassignOwnership (uint32)

Method Qualifiers (ReassignOwnership)

Method Parameters (ReassignOwnership)

Write (uint32)

Method Qualifiers (Write)

Method Parameters (Write)

Inherited Class Methods

Class CIM_OpaqueManagementDataService
extends CIM_Service

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods