| 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 |
| ChangeableType | uint16 |
| Description | string | Enumeration indicating the type of setting. 0 "Not Changeable - Persistent" indicates the instance of SettingData represents primordial settings and shall not be modifiable. 1 "Changeable - Transient" indicates the SettingData represents modifiable settings that are not persisted. Establishing persistent settings from transient settings may be supported. 2 "Changeable - Persistent" indicates the SettingData represents a persistent configuration that may be modified. 3 "Not Changeable - Transient" indicates the SettingData represents a snapshot of the settings of the associated ManagedElement and is not persistent. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ValueMap | string | 0, 1, 2, 3 | None | None |
| Values | string | Not Changeable - Persistent, Changeable - Transient, Changeable - Persistent, Not Changeable - Transient | None | TRANSLATABLE= true |
| ConfigurationName | string |
| Description | string | An instance of CIM_SettingData may correspond to a well-known configuration that exists for an associated CIM_ManagedElement. If the ConfigurationName property is non-NULL, the instance of CIM_SettingData shall correspond to a well-known configuration for a Managed Element, the value of the ConfigurationName property shall be the name of the configuration, and the ChangeableType property shall have the value 0 or 2. A value of NULL for the ConfigurationName property shall mean that the instance of CIM_SettingData does not correspond to a well-known configuration for a Managed Element or that this information is unknown. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| DeleteOnCompletion | boolean |
| Description | string | Indicates whether or not the Job should be automatically deleted upon completion. Note that the 'completion' of a recurring job is defined by its JobRunTimes or UntilTime properties, OR when the Job is terminated by manual intervention. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_Job.DeleteOnCompletion | None | None |
| Write | boolean | true | None | None |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
| ElementName | string |
| Description | string | The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.) | None | TRANSLATABLE= true |
| Override | string | ElementName | TOSUBCLASS= false | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| 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 |
| InstanceID | string |
| Description | string | Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| Override | string | InstanceID | TOSUBCLASS= false | None |
| JobRunTimes | uint32 |
| Description | string | Number of times that a 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_Job.JobRunTimes | None | None |
| Write | 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ValueMap | string | 1, 2 | None | None |
| Values | string | Local Time, UTC Time | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| Notify | string |
| Description | string | The setting for a Job's Notify property - the user/email to be notified upon a scheduled Job's completion or failure. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_Job.Notify | None | None |
| Write | boolean | true | None | None |
| OtherRecoveryAction | string |
| Description | string | A string describing the recovery action when the instance's RecoveryAction property is 1 ("Other"). | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_JobSettingData.RecoveryAction, CIM_Job.OtherRecoveryAction | None | None |
| Owner | string |
| Description | string | The setting for a Job's Owner property - the user, service method, etc. that defined this setting data and causes the Job to be created. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_Job.Owner | None | None |
| Write | boolean | true | None | None |
| Priority | uint32 |
| Description | string | Indicates the urgency or importance of execution of the Job, as specified by the user or defining entity. The actual Priority is found in the CIM_Job instance, associated via the ElementSettingData relationship. Unless otherwise specified, a lower number indicates a higher priority. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_Job.Priority | None | None |
| Write | boolean | true | None | None |
| RecoveryAction | uint16 |
| Description | string | Describes the recovery setting if the Job does not successfully complete. 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 property, OtherRecoveryAction
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 on the queue from which it will run. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_JobSettingData.OtherRecoveryAction, CIM_Job.RecoveryAction | 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 a Job should be processed. There are two different interpretations for this property, depending on the value of RunDayOfWeek. In one case, RunDay defines the day-in-month on which the Job is processed. This interpretation is used when the RunDayOfWeek is 0. A positive or negative integer indicates whether the RunDay should be calculated from the beginning or the end of the month. For example, 5 indicates the fifth day in 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 (e.g., 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| MaxValue | sint64 | 31 | None | None |
| MinValue | sint64 | -31 | None | None |
| ModelCorrespondence | string | CIM_Job.RunDay, CIM_JobSettingData.RunMonth, CIM_JobSettingData.RunDayOfWeek, CIM_JobSettingData.RunStartInterval | None | None |
| Write | boolean | true | None | None |
| RunDayOfWeek | sint8 |
| Description | string | Positive or negative integer used in conjunction with RunDay to indicate the day of the week on which a 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_Job.RunDayOfWeek, CIM_JobSettingData.RunMonth, CIM_JobSettingData.RunDay, CIM_JobSettingData.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 a Job should be processed. Specify 0 for January, 1 for February, and so on. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_Job.RunMonth, CIM_JobSettingData.RunDay, CIM_JobSettingData.RunDayOfWeek, CIM_JobSettingData.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 a 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_Job.RunStartInterval, CIM_JobSettingData.RunMonth, CIM_JobSettingData.RunDay, CIM_JobSettingData.RunDayOfWeek, CIM_JobSettingData.LocalOrUtcTime | None | None |
| Write | boolean | true | None | None |
| UntilTime | datetime |
| Description | string | The setting for a Job's UntilTime - the time after which an executing Job should be stopped or not be allowed to proceed. This may be represented by an actual date and time, or an interval relative to the ScheduledStartTime. A value of all nines indicates that the Job can run indefinitely. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_Job.UntilTime, CIM_JobSettingData.LocalOrUtcTime | None | None |
| Write | boolean | true | None | None |
Copyright © 2008-2010 VMware, Inc. All rights reserved.