Name | Data Type | Value |
Description | string | CreateOpaqueManagementData 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 |
Name | Type | Qualifiers |
Name | Data Type | Value |
OpaqueManagementDataTemplate | string |
Description | string | The embedded instance string OpaqueManagementData contains the initial property values for the new CIM_OpaqueManagementData instance |
EmbeddedInstance | string | CIM_OpaqueManagementData |
IN | boolean | true |
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. CreateOpaqueManagementData shall associate the new CIM_OpaqueManagementData instance with this CIM_Identity instance using a new instance of CIM_IdentityUsesOpaqueManagementData. |
IN | boolean | true |
Required | boolean | true |
Name | Type | Qualifiers |
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 LockOpaqueManagementData 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 |
Name | Data Type | Value |
Description | string | ExportOpaqueManagementDataToURI 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 |
Name | Type | Qualifiers |
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 LockOpaqueManagementData 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 |
Name | Data Type | Value |
Description | string | WriteOpaqueManagementData 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 |
Name | Type | Qualifiers |
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 |
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 LockOpaqueManagementData 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 |
Name | Data Type | Value |
Description | string | ImportOpaqueManagementDataFromURI 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 |
Name | Type | Qualifiers |
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 |
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 |
Name | Data Type | Value |
Description | string | LockOpaqueManagementData 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. |
ValueMap | string | 0, 1, 2, 3..32767, 32768..65535 |
Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified |