Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_JobSettingData --> CIM_SettingData --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_SettingData NAME CIM_JobSettingData
Class CIM_JobSettingData Qualifiers Name Type Value From Class Version string 2.9.1000 CIM_JobSettingData Description string JobSettingData represents job characteristics and scheduling information for a CIM_Job. The settings may be applied to a job handling Service, a JobQueue or other destination to which jobs are submitted, and/or to individual CIM_Jobs. The applicability of the settings are defined using the ElementSettingData relationship. Since the Settings may be defined in several contexts and applied to many types of elements, this class is defined as a subclass of SettingData, versus ScopedSettingData. CIM_JobSettingData Description string The SettingData class represents configuration-related and operational parameters for one or more ManagedElements. A ManagedElement can have multiple SettingData objects associated with it. The current operational values for the parameters of the element are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values that are present in the SettingData object. For example, a modem might have a SettingData baud rate of 56Kb/sec but be operating at 19.2Kb/sec. Note: The CIM_SettingData class is very similar to CIM_Setting, yet both classes are present in the model because many implementations have successfully used CIM_Setting. However, issues have arisen that could not be resolved without defining a new class. Therefore, until a new major release occurs, both classes will exist in the model. Refer to the Core White Paper for additional information. SettingData instances can be aggregated together into higher- level SettingData objects using ConcreteComponent associations. CIM_SettingData Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Property Qualifiers
Property JobRunTimes Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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. CIM_JobSettingData ModelCorrespondence string CIM_Job.JobRunTimes CIM_JobSettingData
Property RunMonth Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData Description string The month during which a Job should be processed. Specify 0 for January, 1 for February, and so on. CIM_JobSettingData ValueMap string [See below.] CIM_JobSettingData Values string January
February
March
April
May
June
July
August
September
October
November
DecemberCIM_JobSettingData ModelCorrespondence string CIM_Job.RunMonth
CIM_JobSettingData.RunDay
CIM_JobSettingData.RunDayOfWeek
CIM_JobSettingData.RunStartIntervalCIM_JobSettingData
Name Value 0 January 1 February 2 March 3 April 4 May 5 June 6 July 7 August 8 September 9 October 10 November 11 December
Property RunDay Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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. CIM_JobSettingData MinValue sint64 -31 CIM_JobSettingData MaxValue sint64 31 CIM_JobSettingData ModelCorrespondence string CIM_Job.RunDay
CIM_JobSettingData.RunMonth
CIM_JobSettingData.RunDayOfWeek
CIM_JobSettingData.RunStartIntervalCIM_JobSettingData
Property RunDayOfWeek Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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. CIM_JobSettingData ValueMap string [See below.] CIM_JobSettingData Values string -Saturday
-Friday
-Thursday
-Wednesday
-Tuesday
-Monday
-Sunday
ExactDayOfMonth
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
SaturdayCIM_JobSettingData ModelCorrespondence string CIM_Job.RunDayOfWeek
CIM_JobSettingData.RunMonth
CIM_JobSettingData.RunDay
CIM_JobSettingData.RunStartIntervalCIM_JobSettingData
Name Value -7 -Saturday -6 -Friday -5 -Thursday -4 -Wednesday -3 -Tuesday -2 -Monday -1 -Sunday 0 ExactDayOfMonth 1 Sunday 2 Monday 3 Tuesday 4 Wednesday 5 Thursday 6 Friday 7 Saturday
Property RunStartInterval Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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. CIM_JobSettingData ModelCorrespondence string CIM_Job.RunStartInterval
CIM_JobSettingData.RunMonth
CIM_JobSettingData.RunDay
CIM_JobSettingData.RunDayOfWeek
CIM_JobSettingData.LocalOrUtcTimeCIM_JobSettingData
Property LocalOrUtcTime Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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 " . CIM_JobSettingData ValueMap string [See below.] CIM_JobSettingData Values string Local Time
UTC TimeCIM_JobSettingData
Name Value 1 Local Time 2 UTC Time
Property UntilTime Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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. CIM_JobSettingData ModelCorrespondence string CIM_Job.UntilTime
CIM_JobSettingData.LocalOrUtcTimeCIM_JobSettingData
Property Notify Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData Description string The setting for a Job ’ s Notify property - the user/email to be notified upon a scheduled Job ’ s completion or failure. CIM_JobSettingData ModelCorrespondence string CIM_Job.Notify CIM_JobSettingData
Property Owner Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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. CIM_JobSettingData ModelCorrespondence string CIM_Job.Owner CIM_JobSettingData
Property Priority Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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. CIM_JobSettingData ModelCorrespondence string CIM_Job.Priority CIM_JobSettingData
Property DeleteOnCompletion Qualifiers Name Type Value From Class Write boolean true CIM_JobSettingData 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. CIM_JobSettingData ModelCorrespondence string CIM_Job.DeleteOnCompletion CIM_JobSettingData
Property RecoveryAction Qualifiers Name Type Value From Class 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. CIM_JobSettingData ValueMap string [See below.] CIM_JobSettingData Values string Unknown
Other
Do Not Continue
Continue With Next Job
Re-run Job
Run Recovery JobCIM_JobSettingData ModelCorrespondence string CIM_JobSettingData.OtherRecoveryAction
CIM_Job.RecoveryActionCIM_JobSettingData
Name Value 0 Unknown 1 Other 2 Do Not Continue 3 Continue With Next Job 4 Re-run Job 5 Run Recovery Job
Property OtherRecoveryAction Qualifiers Name Type Value From Class Description string A string describing the recovery action when the instance ’ s RecoveryAction property is 1 ( " Other " ). CIM_JobSettingData ModelCorrespondence string CIM_JobSettingData.RecoveryAction
CIM_Job.OtherRecoveryActionCIM_JobSettingData
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_SettingData 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. CIM_SettingData
Property ElementName Qualifiers Name Type Value From Class Required boolean true CIM_SettingData Override string ElementName CIM_SettingData 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.) CIM_SettingData
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. CIM_ManagedElement
Method Qualifiers
Parameters
Parameter Qualifiers