CIM211 Class Declaration
CIM_JobSettingData

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_JobSettingData --> CIM_SettingData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SettingData
NAMECIM_JobSettingData

Class Qualifiers

Class CIM_JobSettingData Qualifiers
NameTypeValueFrom Class
Versionstring2.9.1000 CIM_JobSettingData
DescriptionstringJobSettingData 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
DescriptionstringThe 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
DescriptionstringManagedElement 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

Properties

Properties
NameTypeValueQualifiersClassOrigin
JobRunTimesuint321 Experimental
Write
Description
ModelCorrespondence
CIM_JobSettingData
RunMonthuint8 Experimental
Write
Description
ValueMap
Values
ModelCorrespondence
CIM_JobSettingData
RunDaysint8 Experimental
Write
Description
MinValue
MaxValue
ModelCorrespondence
CIM_JobSettingData
RunDayOfWeeksint8 Experimental
Write
Description
ValueMap
Values
ModelCorrespondence
CIM_JobSettingData
RunStartIntervaldatetime Experimental
Write
Description
ModelCorrespondence
CIM_JobSettingData
LocalOrUtcTimeuint16 Experimental
Write
Description
ValueMap
Values
CIM_JobSettingData
UntilTimedatetime Experimental
Write
Description
ModelCorrespondence
CIM_JobSettingData
Notifystring Experimental
Write
Description
ModelCorrespondence
CIM_JobSettingData
Ownerstring Experimental
Write
Description
ModelCorrespondence
CIM_JobSettingData
Priorityuint32 Experimental
Write
Description
ModelCorrespondence
CIM_JobSettingData
DeleteOnCompletionboolean Write
Description
ModelCorrespondence
CIM_JobSettingData
RecoveryActionuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_JobSettingData
OtherRecoveryActionstring Description
ModelCorrespondence
CIM_JobSettingData
InstanceIDstring Key
Description
CIM_SettingData
ElementNamestring Required
Override
Description
CIM_SettingData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property JobRunTimes Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringNumber 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
ModelCorrespondencestringCIM_Job.JobRunTimes CIM_JobSettingData

Property RunMonth Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringThe month during which a Job should be processed. Specify 0 for January, 1 for February, and so on. CIM_JobSettingData
ValueMapstring
[See below.]
CIM_JobSettingData
ValuesstringJanuary
February
March
April
May
June
July
August
September
October
November
December
CIM_JobSettingData
ModelCorrespondencestringCIM_Job.RunMonth
CIM_JobSettingData.RunDay
CIM_JobSettingData.RunDayOfWeek
CIM_JobSettingData.RunStartInterval
CIM_JobSettingData

NameValue
0January
1February
2March
3April
4May
5June
6July
7August
8September
9October
10November
11December
Property RunDay Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringThe 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
MinValuesint64-31 CIM_JobSettingData
MaxValuesint6431 CIM_JobSettingData
ModelCorrespondencestringCIM_Job.RunDay
CIM_JobSettingData.RunMonth
CIM_JobSettingData.RunDayOfWeek
CIM_JobSettingData.RunStartInterval
CIM_JobSettingData

Property RunDayOfWeek Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringPositive 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
ValueMapstring
[See below.]
CIM_JobSettingData
Valuesstring-Saturday
-Friday
-Thursday
-Wednesday
-Tuesday
-Monday
-Sunday
ExactDayOfMonth
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
CIM_JobSettingData
ModelCorrespondencestringCIM_Job.RunDayOfWeek
CIM_JobSettingData.RunMonth
CIM_JobSettingData.RunDay
CIM_JobSettingData.RunStartInterval
CIM_JobSettingData

NameValue
-7-Saturday
-6-Friday
-5-Thursday
-4-Wednesday
-3-Tuesday
-2-Monday
-1-Sunday
0ExactDayOfMonth
1Sunday
2Monday
3Tuesday
4Wednesday
5Thursday
6Friday
7Saturday
Property RunStartInterval Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringThe 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
ModelCorrespondencestringCIM_Job.RunStartInterval
CIM_JobSettingData.RunMonth
CIM_JobSettingData.RunDay
CIM_JobSettingData.RunDayOfWeek
CIM_JobSettingData.LocalOrUtcTime
CIM_JobSettingData

Property LocalOrUtcTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringThis 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
ValueMapstring
[See below.]
CIM_JobSettingData
ValuesstringLocal Time
UTC Time
CIM_JobSettingData

NameValue
1Local Time
2UTC Time
Property UntilTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringThe 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
ModelCorrespondencestringCIM_Job.UntilTime
CIM_JobSettingData.LocalOrUtcTime
CIM_JobSettingData

Property Notify Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringThe setting for a Job ’ s Notify property - the user/email to be notified upon a scheduled Job ’ s completion or failure. CIM_JobSettingData
ModelCorrespondencestringCIM_Job.Notify CIM_JobSettingData

Property Owner Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringThe 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
ModelCorrespondencestringCIM_Job.Owner CIM_JobSettingData

Property Priority Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringIndicates 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
ModelCorrespondencestringCIM_Job.Priority CIM_JobSettingData

Property DeleteOnCompletion Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_JobSettingData
DescriptionstringIndicates 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
ModelCorrespondencestringCIM_Job.DeleteOnCompletion CIM_JobSettingData

Property RecoveryAction Qualifiers
NameTypeValueFrom Class
DescriptionstringDescribes 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
ValueMapstring
[See below.]
CIM_JobSettingData
ValuesstringUnknown
Other
Do Not Continue
Continue With Next Job
Re-run Job
Run Recovery Job
CIM_JobSettingData
ModelCorrespondencestringCIM_JobSettingData.OtherRecoveryAction
CIM_Job.RecoveryAction
CIM_JobSettingData

NameValue
0Unknown
1Other
2Do Not Continue
3Continue With Next Job
4Re-run Job
5Run Recovery Job
Property OtherRecoveryAction Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the recovery action when the instance ’ s RecoveryAction property is 1 ( " Other " ). CIM_JobSettingData
ModelCorrespondencestringCIM_JobSettingData.RecoveryAction
CIM_Job.OtherRecoveryAction
CIM_JobSettingData

Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_SettingData
DescriptionstringWithin 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
NameTypeValueFrom Class
Requiredbooleantrue CIM_SettingData
OverridestringElementName CIM_SettingData
DescriptionstringThe 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
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_SettingAssociatedToCapabilitiesCIM_SettingDataDependent
CIM_ElementSettingDataCIM_SettingDataSettingData
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement