SPACES_StorageJob, ROOT\Microsoft\Windows\Storage\providers_v2

Class | Methods (2) | Properties (26) | Qualifiers (3) | Instances | Namespaces (1)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Storage jobs represent long running operations on a storage subsystem. These operations can either be user-initiated through the various management interfaces defined by this MOF, or automatically by intelligent storage subsystems.

SPACES_StorageJob methods

SPACES_StorageJob has 2 methods (2 Derived)

NameOriginReturn
GetExtendedStatusMSFT_StorageJobuint32 {'out':True}
RequestStateChangeMSFT_StorageJobuint32 {'out':True}

SPACES_StorageJob properties

SPACES_StorageJob has 26 properties (1 Local, 25 Derived)

NameOriginCIMType
AffectedObjectIdSPACES_StorageJob8 [string]
DeleteOnCompletionMSFT_StorageJob11 [boolean]
DescriptionMSFT_StorageJob8 [string]
ElapsedTimeMSFT_StorageJob101 [datetime]
ErrorCodeMSFT_StorageJob18 [uint16]
ErrorDescriptionMSFT_StorageJob8 [string]
IsBackgroundTaskMSFT_StorageJob11 [boolean]
JobStateMSFT_StorageJob18 [uint16]
JobStatusMSFT_StorageJob8 [string]
LocalOrUtcTimeMSFT_StorageJob18 [uint16]
NameMSFT_StorageJob8 [string]
key
ObjectId
MSFT_StorageObject8 [string]
OperationalStatusMSFT_StorageJob18 [uint16]
OtherRecoveryActionMSFT_StorageJob8 [string]
PassThroughClassMSFT_StorageObject8 [string]
PassThroughIdsMSFT_StorageObject8 [string]
PassThroughNamespaceMSFT_StorageObject8 [string]
PassThroughServerMSFT_StorageObject8 [string]
PercentCompleteMSFT_StorageJob18 [uint16]
RecoveryActionMSFT_StorageJob18 [uint16]
StartTimeMSFT_StorageJob101 [datetime]
StatusDescriptionsMSFT_StorageJob8 [string]
TimeBeforeRemovalMSFT_StorageJob101 [datetime]
TimeOfLastStateChangeMSFT_StorageJob101 [datetime]
TimeSubmittedMSFT_StorageJob101 [datetime]
UniqueIdMSFT_StorageObject8 [string]

Detailed description of SPACES_StorageJob methods

Derived methods (2) of SPACES_StorageJob class

GetExtendedStatus method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ExtendedStatusobject:MSFT_StorageExtendedStatus0-{'EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method retrieves the extended status information for an unsuccessful job.'
GetExtendedStatus method is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 3 namespaces
RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'RequestStateChange changes the state of a job. The possible values are as follows: 2 - 'Start' changes the state to 'Running'. 3 - 'Suspend' stops the job temporarily. The intention is to subsequently restart the job with a second call to RequestStateChange requesting 1 - 'Start'. It might be possible to enter the 'Service' state while suspended. (This is job-specific.) 4 - 'Terminate' stops the job cleanly, saving data, preserving the state, and shutting down all underlying processes in an orderly manner. 5 - 'Kill' terminates the job immediately with no requirement to save data or preserve the state. 6 - 'Service' puts the job into a vendor-specific service state. It might be possible to restart the job.','In':True,'ValueMap':['2', '3', '4', '5', '6', '7..32767', '32768..65535'],'Values':['Start', 'Suspend', 'Terminate', 'Kill', 'Service', 'DMTF Reserved', 'Vendor Reserved']}
ExtendedStatusobject:MSFT_StorageExtendedStatus1-{'EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'Requests that the state of the job be changed to the value specified in the RequestedState parameter. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost.'
ValueMap['0', '1', '2', '3', '4', '5', '4096', '4097', '40001', '40002', '46000', '46001']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'State transition started', 'Invalid state transition', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.']
RequestStateChange method is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 15 namespaces

Detailed description of SPACES_StorageJob properties

Local properties (1) of SPACES_StorageJob class

AffectedObjectId property
CIMTYPE'string'
Description'ObjectId for internal use only.'
readTrue
AffectedObjectId property is in 1 class (SPACES_StorageJob) of ROOT\Microsoft\Windows\Storage\providers_v2 and in 1 namespace

Derived properties (25) of SPACES_StorageJob class

DeleteOnCompletion property
CIMTYPE'boolean'
Description'If TRUE, the storage job will be automatically deleted after a short time interval.'
readTrue
DeleteOnCompletion property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 11 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the storage job operation.'
readTrue
Description property is in 20 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 142 namespaces
ElapsedTime property
CIMTYPE'datetime'
Description'The time interval that the job has been executing or the total execution time if the storage job is complete.'
readTrue
ElapsedTime property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 17 namespaces
ErrorCode property
CIMTYPE'uint16'
Description'If the operation that this storage job was tracking has failed, the provider will set this with an error code defined by the method that invoked the operation. If this job tracked a background task, the error code can be set to any valid Storage Management error code as defined in the value map below. If there was no error, this property must be set to 0 - 'Success'. This property should be NULL until the operation has completed.'
readTrue
ErrorCode property is in 4 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 142 namespaces
ErrorDescription property
CIMTYPE'string'
Description'A free-form string that contains the vendor error description.'
readTrue
ErrorDescription property is in 4 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 142 namespaces
IsBackgroundTask property
CIMTYPE'boolean'
Description'If TRUE, this storage job represents an automated background task initiated by the storage subsystem. For all user / management initiated operations, this value should be set to FALSE.'
readTrue
RequiredTrue
IsBackgroundTask property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 3 namespaces
JobState property
CIMTYPE'uint16'
Description'The current execution state of the storage job.'
readTrue
RequiredTrue
ValueMap['2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13..32767', '32768..65535']
Values['New', 'Starting', 'Running', 'Suspended', 'Shutting Down', 'Completed', 'Terminated', 'Killed', 'Exception', 'Service', 'Query Pending', 'Microsoft Reserved', 'Vendor Reserved']
JobState property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 13 namespaces
JobStatus property
CIMTYPE'string'
Description'A free-form string that represents the status of the job. The primary status is reflected in the inherited OperationalStatus property. JobStatus provides additional, implementation-specific details.'
readTrue
JobStatus property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 15 namespaces
LocalOrUtcTime property
CIMTYPE'uint16'
Description'This property indicates whether the times represented in the StartTime, TimeOfLastStateChange, and TimeSubmitted properties represent local times or UTC times. Time values are synchronized worldwide by using the enumeration value 2 - 'UTC Time'.'
readTrue
ValueMap['1', '2']
Values['Local Time', 'UTC Time']
LocalOrUtcTime property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 13 namespaces
Name property
CIMTYPE'string'
Description'A system defined name for this storage job.'
readTrue
RequiredTrue
Name property is in 22 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 142 namespaces
ObjectId property
CIMTYPE'string'
Description'ObjectId is a mandatory property that is used to opaquely and uniquely identify an instance of a class. ObjectIds must be unique within the scope of the management server (which is hosting the provider). The ObjectId is created and maintained for use of the Storage Management Providers and their clients to track instances of objects. If an object is visible through two different paths (for example: there are two separate Storage Management Providers that point to the same storage subsystem) then the same object may appear with two different ObjectIds. For determining if two object instances are the same object, refer to the UniqueId property.'
keyTrue
readTrue
RequiredTrue
ObjectId property is in 28 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 6 namespaces
OperationalStatus property
CIMTYPE'uint16'
Description'Indicates the current statuses of the element.'
readTrue
RequiredTrue
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '..']
Values['Unknown', 'Other', 'OK', 'Degraded', 'Stressed', 'Predictive Failure', 'Error', 'Non-Recoverable Error', 'Starting', 'Stopping', 'Stopped', 'In Service', 'No Contact', 'Lost Communication', 'Aborted', 'Dormant', 'Supporting Entity in Error', 'Completed', 'Power Mode', 'Relocating', 'Microsoft Reserved']
OperationalStatus property is in 12 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 18 namespaces
OtherRecoveryAction property
CIMTYPE'string'
Description'Denotes a vendor-specific recovery action to be taken for an unsuccessfully run job. This value should only be set if RecoveryAction is set to 1 - 'Other'.'
readTrue
OtherRecoveryAction property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 11 namespaces
PassThroughClass property
CIMTYPE'string'
Description'PassThroughClass is the WBEM class name of the proprietary storage provider object.'
readTrue
PassThroughClass property is in 27 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 3 namespaces
PassThroughIds property
CIMTYPE'string'
Description'PassThroughIds is a comma-separated list of all implementation specific keys. It is used by storage management applications to access the vendor proprietary object model. This field should be in the form: key1='value1',key2='value2'.'
readTrue
PassThroughIds property is in 27 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 3 namespaces
PassThroughNamespace property
CIMTYPE'string'
Description'PassThroughNamespace is the WBEM namespace that contains the proprietary storage provider classes.'
readTrue
PassThroughNamespace property is in 27 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 3 namespaces
PassThroughServer property
CIMTYPE'string'
Description'PassThroughServer is the name or address of the computer system hosting the proprietary storage provider classes.'
readTrue
PassThroughServer property is in 27 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 3 namespaces
PercentComplete property
CIMTYPE'uint16'
Description'The percentage of the job that has completed at the time that this value is requested.'
MaxValue'100'
MinValue'0'
readTrue
RequiredTrue
Units'Percent'
PercentComplete property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 15 namespaces
RecoveryAction property
CIMTYPE'uint16'
Description'Describes the recovery action to be taken for an unsuccessfully run job. The possible values are:
0 - 'Unknown' meaning it is unknown as to what recovery action to take
1 - 'Other' indicating that the recovery action will be specified in the OtherRecoveryAction property
2 - 'Do Not Continue' meaning stop the execution of the job and appropriately update its status
3 - 'Continue With Next Job' meaning continue with the next job in the queue
4 - 'Re-run Job' indicating that the job should be re-run
'
readTrue
ValueMap['0', '1', '2', '3', '4']
Values['Unknown', 'Other', 'Do Not Continue', 'Continue With Next Job', 'Re-run Job']
RecoveryAction property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 11 namespaces
StartTime property
CIMTYPE'datetime'
Description'The time that the job was actually started.'
readTrue
StartTime property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 24 namespaces
StatusDescriptions property
CIMTYPE'string'
Description'Strings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.'
readTrue
StatusDescriptions property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 18 namespaces
TimeBeforeRemoval property
CIMTYPE'datetime'
Description'The amount of time that the Job is retained after it has finished executing, regardless of whether it failed during execution. The job must remain in existence for some period of time regardless of the value of the DeleteOnCompletion property.
'
readTrue
TimeBeforeRemoval property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 13 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
Description'The date or time when the state of the job last changed. If the state of the job has not changed and this property is populated, it must be set to a 0 interval value. If a state change was requested, but was rejected or not yet processed, the property must not be updated.'
readTrue
TimeOfLastStateChange property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 17 namespaces
TimeSubmitted property
CIMTYPE'datetime'
Description'The time that the job was submitted to execute. A value of all zeroes indicates that the owning element is not capable of reporting a date and time.'
readTrue
TimeSubmitted property is in 2 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 15 namespaces
UniqueId property
CIMTYPE'string'
Description'UniqueId is a mandatory property that is used to uniquely identify a logical instance of a storage subsystem's object. This value must be the same for an object viewed by two or more provider instances (even if they are running on seperate management servers). UniqueId can be any globally unique, opaque value unless otherwise specified by a derived class.'
readTrue
RequiredTrue
UniqueId property is in 27 classes of ROOT\Microsoft\Windows\Storage\providers_v2 and in 6 namespaces

SPACES_StorageJob Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'Storage jobs represent long running operations on a storage subsystem. These operations can either be user-initiated through the various management interfaces defined by this MOF, or automatically by intelligent storage subsystems.'
dynamicTrue
provider'mispace'

SPACES_StorageJob System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\Storage\providers_v2:SPACES_StorageJob'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\Windows\Storage\providers_v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['MSFT_StorageJob', 'MSFT_StorageObject']___SYSTEM8
__PROPERTY_COUNT26___SYSTEM3
__RELPATH'SPACES_StorageJob'___SYSTEM8
__DYNASTY'MSFT_StorageObject'___SYSTEM8
__SUPERCLASS'MSFT_StorageJob'___SYSTEM8
__CLASS'SPACES_StorageJob'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to SPACES_StorageJob

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_StorageJob1252---
MSFT_StorageJobToAffectedStorageObject120---
SPACES_StorageJobToAffectedStorageObject020----
WUtils.com
online utility - toplist