| Name | Data Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| Caption | string |
| Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 64 | None | None |
| Override | string | Caption | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| CommunicationStatus | uint16 |
| Description | string | CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact.
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"Communication OK " indicates communication is established with the element, but does not convey any quality of service.
"No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
"Lost Communication" indicates that the Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ValueMap | string | 0, 1, 2, 3, 4, .., 0x8000.. | None | None |
| Values | string | Unknown, Not Available, Communication OK, Lost Communication, No Contact, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| DeleteOnCompletion | boolean |
| Description | string | Indicates whether the Job instance will be automatically deleted by the system. For our implementation, this property will have a value of "true". A client can use the following formula to calculate when a Job instance will be deleted:
"StartTime" + "ElapsedTime" + "TimeBeforeRemoval". | None | TRANSLATABLE= true |
| Override | string | DeleteOnCompletion | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| Write | boolean | true | None | None |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
| Override | string | Description | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| DetailedStatus | uint16 |
| Description | string | DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element.
A Null return indicates the implementation (provider) does not implement this property.
"Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK".
"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.
"Predictive Failure" indicates that an element is functioning normally but a failure is predicted in the near future.
"Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention.
"Supporting Entity in Error" indicates that this element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.PrimaryStatus, CIM_ManagedSystemElement.HealthState | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, .., 0x8000.. | None | None |
| Values | string | Not Available, No Additional Information, Stressed, Predictive Failure, Non-Recoverable Error, Supporting Entity in Error, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| ElapsedTime | datetime |
| Description | string | The time interval indicating how long an operation has been running or how long it ran before completion. | None | TRANSLATABLE= true |
| Override | string | ElapsedTime | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| ElementName | string |
| Description | string | A human-readable name that briefly describes the Job. This property will have the same value as the "Name" property. | None | TRANSLATABLE= true |
| Override | string | ElementName | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| ErrorCode | uint16 |
| Description | string | Contains a VMware-specific error code if the JobState property has the value "Exception". | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.ErrorDescription | None | None |
| Override | string | ErrorCode | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| ErrorDescription | string |
| Description | string | Contains a human-readable error description if the JobState property has the value "Exception". | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.ErrorCode | None | None |
| Override | string | ErrorDescription | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| Generation | uint64 |
| Description | string | Generation is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class.
If Generation is supported by the implementation, its value shall not be null.
Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation.
After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification.
Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update.
Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance.
Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated.
Subclasses may define additional requirements for updates on some or all of related instances.
For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years.
This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail.
The usage of this property is intended to be further specified by applicable management profiles.
Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation.
For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| HealthState | uint16 |
| Description | string | The current health of this Job. This will always have the value "OK". | None | TRANSLATABLE= true |
| Override | string | HealthState | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| ValueMap | string | 5 | None | None |
| Values | string | OK | None | TRANSLATABLE= true |
| InstallDate | datetime |
| Description | string | A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. | None | TRANSLATABLE= true |
| MappingStrings | string | MIF.DMTF|ComponentID|001.5 | None | None |
| InstanceID | string |
| Description | string | The "key" property for this instance. It is an opaque, unique identifier for instances of this class. Since this is a transient class, the ID will be generated and stored by the provider for the lifetime of the Job. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| Override | string | InstanceID | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| JobRunTimes | uint32 |
| Description | string | The number of times that the Job should be run. A value of 1 indicates that the Job is not recurring, while any non-zero value indicates a limit to the number of times that the Job will recur. Zero indicates that there is no limit to the number of times that the Job can be processed, but that it is terminated either after the UntilTime or by manual intervention. By default, a Job is processed once. | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| JobState | uint16 |
| Description | string | The current state of the job. There are only three possible values: "Running", "Completed", "Exception". | None | TRANSLATABLE= true |
| Override | string | JobState | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| ValueMap | string | 4, 7, 10 | None | None |
| Values | string | Running, Completed, Exception | None | TRANSLATABLE= true |
| JobStatus | string |
| Description | string | A string that contains a description of the job's current status. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ManagedSystemElement.OperationalStatus | None | None |
| Override | string | JobStatus | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| LocalOrUtcTime | uint16 |
| Description | string | This property indicates whether the times represented in the RunStartInterval and UntilTime properties represent local times or UTC times. Time values are synchronized worldwide by using the enumeration value 2, "UTC Time". | None | TRANSLATABLE= true |
| ValueMap | string | 1, 2 | None | None |
| Values | string | Local Time, UTC Time | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| Name | string |
| Description | string | A human-readable name that briefly describes the Job. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 1024 | None | None |
| Override | string | Name | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Notify | string |
| Description | string | The User who is to be notified upon the Job completion or failure. | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| OperatingStatus | uint16 |
| Description | string | OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.
OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"Servicing" describes an element being configured, maintained, cleaned, or otherwise administered.
"Starting" describes an element being initialized.
"Stopping" describes an element being brought to an orderly stop.
"Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated.
"Dormant" indicates that the element is inactive or quiesced.
"Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
"Migrating" element is being moved between host elements.
"Immigrating" element is being moved to new host element.
"Emigrating" element is being moved away from host element.
"Shutting Down" describes an element being brought to an abrupt stop.
"In Test" element is performing test functions.
"Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.
"In Service" describes an element that is in service and operational. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, .., 0x8000.. | None | None |
| Values | string | Unknown, Not Available, Servicing, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emigrating, Immigrating, Snapshotting, Shutting Down, In Test, Transitioning, In Service, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| OperationalStatus | uint16 |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Description | string | An array describing job status for a job instance. The array always contains either "OK" or "Error", and may also contain the value "Completed". | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ManagedSystemElement.StatusDescriptions | None | None |
| Override | string | OperationalStatus | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| ValueMap | string | 2, 6, 17 | None | None |
| Values | string | OK, Error, Completed | None | TRANSLATABLE= true |
| OtherRecoveryAction | string |
| Description | string | A string describing the recovery action when the RecoveryAction property of the instance is 1 ("Other"). | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.RecoveryAction | None | None |
| Owner | string |
| Description | string | The User that submitted the Job, or the Service or method name that caused the job to be created. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_OwningJobElement | None | None |
| PercentComplete | uint16 |
| Description | string | A value indicating the progress of the job. This property will always have a value of "100" when the operation has completed and a value less than "100" when the operation is running. Clients should not rely on the accuracy of values between 0 and 100. | None | TRANSLATABLE= true |
| MaxValue | sint64 | 101 | None | None |
| MinValue | sint64 | 0 | None | None |
| Override | string | PercentComplete | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| PUnit | string | percent | None | None |
| Units | string | Percent | None | TRANSLATABLE= true |
| PrimaryStatus | uint16 |
| Description | string | PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents.
PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"OK" indicates the ManagedElement is functioning normally.
"Degraded" indicates the ManagedElement is functioning below normal.
"Error" indicates the ManagedElement is in an Error condition. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_ManagedSystemElement.DetailedStatus, CIM_ManagedSystemElement.HealthState | None | None |
| ValueMap | string | 0, 1, 2, 3, .., 0x8000.. | None | None |
| Values | string | Unknown, OK, Degraded, Error, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| Priority | uint32 |
| Description | string | Indicates the urgency or importance of execution of the Job. The lower the number, the higher the priority. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the setting information that would influence the results of a job. | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| RecoveryAction | uint16 |
| Description | string | 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
5 = "Run Recovery Job", meaning run the Job associated using the RecoveryJob relationship. Note that the recovery Job must already be in the queue from which it will run. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.OtherRecoveryAction | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5 | None | None |
| Values | string | Unknown, Other, Do Not Continue, Continue With Next Job, Re-run Job, Run Recovery Job | None | TRANSLATABLE= true |
| RunDay | sint8 |
| Description | string | The day in the month on which the Job should be processed. There are two different interpretations for this property, depending on the value of DayOfWeek. In one case, RunDay defines the day-in-month on which the Job is processed. This interpretation is used when the DayOfWeek is 0. A positive or negative integer indicates whether the RunDay should be calculated from the beginning or end of the month. For example, 5 indicates the fifth day in the RunMonth and -1 indicates the last day in the RunMonth.
When RunDayOfWeek is not 0, RunDay is the day-in-month on which the Job is processed, defined in conjunction with RunDayOfWeek. For example, if RunDay is 15 and RunDayOfWeek is Saturday, then the Job is processed on the first Saturday on or after the 15th day in the RunMonth (for example, the third Saturday in the month). If RunDay is 20 and RunDayOfWeek is -Saturday, then this indicates the first Saturday on or before the 20th day in the RunMonth. If RunDay is -1 and RunDayOfWeek is -Sunday, then this indicates the last Sunday in the RunMonth. | None | TRANSLATABLE= true |
| MaxValue | sint64 | 31 | None | None |
| MinValue | sint64 | -31 | None | None |
| ModelCorrespondence | string | CIM_Job.RunMonth, CIM_Job.RunDayOfWeek, CIM_Job.RunStartInterval | None | None |
| Write | boolean | true | None | None |
| RunDayOfWeek | sint8 |
| Description | string | A positive or negative integer used in conjunction with RunDay to indicate the day of the week on which the Job is processed. RunDayOfWeek is set to 0 to indicate an exact day of the month, such as March 1. A positive integer (representing Sunday, Monday, ..., Saturday) means that the day of week is found on or after the specified RunDay. A negative integer (representing -Sunday, -Monday, ..., -Saturday) means that the day of week is found on or BEFORE the RunDay. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.RunMonth, CIM_Job.RunDay, CIM_Job.RunStartInterval | None | None |
| ValueMap | string | -7, -6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7 | None | None |
| Values | string | -Saturday, -Friday, -Thursday, -Wednesday, -Tuesday, -Monday, -Sunday, ExactDayOfMonth, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| RunMonth | uint8 |
| Description | string | The month during which the Job should be processed. Specify 0 for January, 1 for February, and so on. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.RunDay, CIM_Job.RunDayOfWeek, CIM_Job.RunStartInterval | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 | None | None |
| Values | string | January, February, March, April, May, June, July, August, September, October, November, December | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| RunStartInterval | datetime |
| Description | string | The time interval after midnight when the Job should be processed. For example,
00000000020000.000000:000
indicates that the Job should be run on or after two o'clock, local time or UTC time (distinguished using the LocalOrUtcTime property. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.RunMonth, CIM_Job.RunDay, CIM_Job.RunDayOfWeek, CIM_Job.RunStartInterval | None | None |
| Write | boolean | true | None | None |
| ScheduledStartTime | datetime |
| Deprecated | string | CIM_Job.RunMonth, CIM_Job.RunDay, CIM_Job.RunDayOfWeek, CIM_Job.RunStartInterval | TOSUBCLASS= false | None |
| Description | string | The time that the current Job is scheduled to start. This time can be represented by the actual date and time, or an interval relative to the time that this property is requested. A value of all zeroes indicates that the Job is already executing. The property is deprecated in lieu of the more expressive scheduling properties, RunMonth, RunDay, RunDayOfWeek, and RunStartInterval. | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| StartTime | datetime |
| Description | string | The time at which the relevant operation was started. | None | TRANSLATABLE= true |
| Override | string | StartTime | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| Status | string |
| Deprecated | string | CIM_ManagedSystemElement.OperationalStatus | TOSUBCLASS= false | None |
| Description | string | A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons:
1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.
2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 10 | None | None |
| ValueMap | string | OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped | None | None |
| StatusDescriptions | string |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Description | string | Strings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then 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. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ManagedSystemElement.OperationalStatus | None | None |
| TimeBeforeRemoval | datetime |
| Description | string | The duration that the provider will wait after a job has completed (either successfully or due to error) before deleting the job instance. It will always have a value of 5 minutes. | None | TRANSLATABLE= true |
| Override | string | TimeBeforeRemoval | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Write | boolean | true | None | None |
| TimeOfLastStateChange | datetime |
| Description | string | The last time the job was modified. | None | TRANSLATABLE= true |
| Override | string | TimeOfLastStateChange | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| TimeSubmitted | datetime |
| Description | string | The time at which the relevant operation was initiated. | None | TRANSLATABLE= true |
| Override | string | TimeSubmitted | TOSUBCLASS= false | None |
| ProviderImplemented | boolean | true | None | None |
| UntilTime | datetime |
| Description | string | The time after which the Job is invalid or should be stopped. This time can be represented by an actual date and time, or by an interval relative to the time that this property is requested. A value of all nines indicates that the Job can run indefinitely. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.LocalOrUtcTime | None | None |
| Write | boolean | true | None | None |
Copyright © 2008-2010 VMware, Inc. All rights reserved.