Win32_ScheduledJob, ROOT\CIMV2

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

Description

The Win32_ScheduledJob class represents a job scheduled using the network management schedule service functions (also known as "Job" and "AT command" functions). Note that this is different from the tasks scheduled using the Windows 2000 Task Scheduler. This class is only instrumented on Windows NT 4.0 and later. Each job scheduled against the schedule service is stored persistently (the scheduler will know to start the job even after a reboot) and is executed at the specified time and day of the week and/or month. If the computer is not active or if the scheduled service is not running at the specified job time the schedule service will run the specified job on the next day at the specified time. Scheduled jobs are scheduled with respect to Universal Coordinated Time (UTC), i.e. with bias offset from GMT. This means that a job can be specified using any time zone specification. The Win32_ScheduledJob class will return the local time with UTC offset when enumerating an object and convert to local time when creating new jobs. For example a job specified to run on a computer in Boston at 10:30 pm Monday PST time will be scheduled to run locally at 1:30am Tuesday EST. It should be noted that a client must take into account whether daylight savings time is in operation on the local computer and if so subtract a bias of 60 minutes from the UTC offset.

Win32_ScheduledJob methods

Win32_ScheduledJob has 2 methods (2 Local)

NameOriginReturn
CreateWin32_ScheduledJobuint32 {'out':True}
DeleteWin32_ScheduledJobuint32 {'out':True}

Win32_ScheduledJob properties

Win32_ScheduledJob has 19 properties (6 Local, 13 Derived)

NameOriginCIMType
CaptionCIM_ManagedSystemElement8 [string]
CommandWin32_ScheduledJob8 [string]
DaysOfMonthWin32_ScheduledJob19 [uint32]
DaysOfWeekWin32_ScheduledJob19 [uint32]
DescriptionCIM_ManagedSystemElement8 [string]
ElapsedTimeCIM_Job101 [datetime]
InstallDateCIM_ManagedSystemElement101 [datetime]
InteractWithDesktopWin32_ScheduledJob11 [boolean]
key
JobId
Win32_ScheduledJob19 [uint32]
JobStatusCIM_Job8 [string]
NameCIM_ManagedSystemElement8 [string]
NotifyCIM_Job8 [string]
OwnerCIM_Job8 [string]
PriorityCIM_Job19 [uint32]
RunRepeatedlyWin32_ScheduledJob11 [boolean]
StartTimeCIM_Job101 [datetime]
StatusCIM_ManagedSystemElement8 [string]
TimeSubmittedCIM_Job101 [datetime]
UntilTimeCIM_Job101 [datetime]

Detailed description of Win32_ScheduledJob methods

Local methods (2) of Win32_ScheduledJob class

Create method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Commandstring0-{'Description':'The Command parameter contains the name of the command, batch program, or binary file (along with command line parameters) that the schedule service will use to invoke the job.Example: defrag /q /f','In':True,'MappingStrings':['Win32API|Network Management Structures|AT_INFO|Command']}
StartTimedatetime1-{'Description':'The StartTime parameter represents the UTC time to run the job. This is of the form YYYYMMDDHHMMSS.MMMMMM(+-)OOO, where YYYYMMDD must be replaced by ********.Example: ********123000.000000-420 which implies 12:30 pm PST with daylight savings time in effect.','In':True,'MappingStrings':['Win32API|Network Management Structures|AT_ENUM|JobTime']}
RunRepeatedlyboolean2-{'Description':'The RunRepeatedly parameter indicates whether the scheduled job should run repeatedly on the days that the job is scheduled.Values: TRUE or FALSE. If TRUE, then the job is run repeatedly according to the DaysOfWeek and DaysOfMonth parameter. If no value is supplied the parameter defaults to FALSE.','In':True,'MappingStrings':['Win32API|Network Management Structures|AT_INFO|Flags|JOB_RUN_PERIODICALLY'],'Optional':True}
DaysOfWeekuint323-{'BitValues':['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'],'Description':'The DaysOfWeek parameter indicates the days of the week when the job is scheduled to run, and is used only when the RunRepeatedly parameter is TRUE.','In':True,'MappingStrings':['Win32API|Network Management Structures|AT_INFO|DaysOfWeek'],'Optional':True}
DaysOfMonthuint324-{'BitValues':['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31'],'Description':'The DaysOfMonth parameter indicates the days of the month when the job is scheduled to run, and is used only when the RunRepeatedly parameter is TRUE.','In':True,'MappingStrings':['Win32API|Network Management Structures|AT_INFO|DaysOfMonth'],'Optional':True}
InteractWithDesktopboolean5-{'Description':'The InteractWithDesktop parameter indicates whether the specified job should be interactive (meaning a user can give input to the scheduled job while it is executing).Values TRUE or FALSE. If TRUE, then the job will be interactive. The default value of this parameter is FALSE.','In':True,'MappingStrings':['Win32API|Network Management Structures|AT_INFO|Flags|JOB_NONINTERACTIVE'],'Optional':True}
JobIduint326-{'Description':'The JobId parameter indicates the identifier number of the job. This parameter is a handle to the job being scheduled on this computer.','MappingStrings':['Win32API|Network Management Structures|AT_ENUM|JobId'],'Out':True}
ConstructorTrue
Description'The Create function submits a job to the operating system for execution at a specified future time and date. This function requires that the schedule service be started at the computer towhich the job is submitted. The method returns an integer value which can be interpretted as follows:
0 - Successful completion
1 - Not supported
2 - Access denied
8 - Unknown failure
9 - Path not found
21 - Invalid parameter
22 - Service not started
Other - For integer values other than those listed above, refer to Win32 error code documentation.'
ImplementedTrue
MappingStrings['Win32API|Network Management Functions|NetScheduleJobAdd']
StaticTrue
ValueMap['0', '1', '2', '8', '9', '21', '22', '..']
Values['Successful completion', 'Not supported', 'Access denied', 'Unknown failure', 'Path not found', 'Invalid parameter', 'Service not started', 'Other']
Create method is in 11 classes of ROOT\cimv2 and in 14 namespaces
Delete method
Returnuint32 {'out':True}
Description'The Delete method deletes a scheduled job. The method returns an integer value which can be interpretted as follows:
0 - Successful completion
1 - Not supported
2 - Access denied
8 - Unknown failure
9 - Path not found
21 - Invalid parameter
22 - Service not started
Other - For integer values other than those listed above, refer to Win32 error code documentation.'
DestructorTrue
ImplementedTrue
MappingStrings['Win32API|Network Management Functions|NetScheduleJobDel']
ValueMap['0', '1', '2', '8', '9', '21', '22', '..']
Values['Successful completion', 'Not supported', 'Access denied', 'Unknown failure', 'Path not found', 'Invalid parameter', 'Service not started', 'Other']
Delete method is in 16 classes of ROOT\cimv2 and in 11 namespaces

Detailed description of Win32_ScheduledJob properties

Local properties (6) of Win32_ScheduledJob class

Command property
CIMTYPE'string'
Description'The Command property contains the name of the command, batch program, or binary file (along with command line arguments) that the schedule service will use to invoke the job.
Example: defrag /q /f'
MappingStrings['Win32API|Network Management Structures|AT_INFO|Command']
readTrue
Command property is in 3 classes of ROOT\cimv2 and in 13 namespaces
DaysOfMonth property
BitValues['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31']
CIMTYPE'uint32'
Description'The DaysOfMonth property indicates the days of the month when the job is scheduled to run.'
MappingStrings['Win32API|Network Management Structures|AT_INFO|DaysOfMonth']
readTrue
DaysOfMonth property is in 1 class (Win32_ScheduledJob) of ROOT\cimv2 and in 3 namespaces
DaysOfWeek property
BitValues['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
CIMTYPE'uint32'
Description'The DaysOfWeek property indicates the days of the week when the job is scheduled to run.'
MappingStrings['Win32API|Network Management Structures|AT_INFO|DaysOfWeek']
readTrue
DaysOfWeek property is in 1 class (Win32_ScheduledJob) of ROOT\cimv2 and in 3 namespaces
InteractWithDesktop property
CIMTYPE'boolean'
Description'The InteractWithDesktop property allows the specified job to be interactive (meaning a user can give input to a scheduled job while it is executing).
Values TRUE or FALSE. If TRUE, then the job will be interactive. If FALSE, then the job will not be interactive.'
MappingStrings['Win32API|Network Management Structures|AT_INFO|Flags|JOB_NONINTERACTIVE']
readTrue
InteractWithDesktop property is in 1 class (Win32_ScheduledJob) of ROOT\cimv2 and in 2 namespaces
JobId property
CIMTYPE'uint32'
Description'The JobId property indicates the identifier number of the job. It is used by methods as a handle to a single job being scheduled on this computer.'
keyTrue
MappingStrings['Win32API|Network Management Structures|AT_ENUM|JobId']
readTrue
JobId property is in 2 classes of ROOT\cimv2 and in 2 namespaces
RunRepeatedly property
CIMTYPE'boolean'
Description'The RunRepeatedly property indicates whether the scheduled job should run repeatedly on the days that the job is scheduled.
Values: TRUE or FALSE. If TRUE, then the job is run repeatedly. If FALSE, then the job is run once.'
MappingStrings['Win32API|Network Management Structures|AT_INFO|Flags|JOB_RUN_PERIODICALLY']
readTrue
RunRepeatedly property is in 1 class (Win32_ScheduledJob) of ROOT\cimv2 and in 2 namespaces

Derived properties (13) of Win32_ScheduledJob class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one-line string) of the object.'
MaxLen64
readTrue
Caption property is in 1050 classes of ROOT\cimv2 and in 37 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object. '
readTrue
Description property is in 1061 classes of ROOT\cimv2 and in 142 namespaces
ElapsedTime property
CIMTYPE'datetime'
Description'Length of time that the job has been executing.'
readTrue
ElapsedTime property is in 10 classes of ROOT\cimv2 and in 17 namespaces
InstallDate property
CIMTYPE'datetime'
Description'The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
MappingStrings['MIF.DMTF|ComponentID|001.5']
readTrue
InstallDate property is in 227 classes of ROOT\cimv2 and in 23 namespaces
JobStatus property
CIMTYPE'string'
Description'The JobStatus property indicates whether a scheduled service executed successfully the last time this job was supposed to run.'
MappingStrings['Win32API|Network Management Structures|AT_ENUM|Flags|JOB_EXEC_ERROR']
Override'JobStatus'
readTrue
Values['Success', 'Failure']
JobStatus property is in 3 classes of ROOT\cimv2 and in 15 namespaces
Name property
CIMTYPE'string'
Description'The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.'
readTrue
Name property is in 1046 classes of ROOT\cimv2 and in 142 namespaces
Notify property
CIMTYPE'string'
Description'User to be notified upon job completion or failure.'
readTrue
Notify property is in 3 classes of ROOT\cimv2 and in 13 namespaces
Owner property
CIMTYPE'string'
Description'User that submitted the job.'
readTrue
Owner property is in 7 classes of ROOT\cimv2 and in 142 namespaces
Priority property
CIMTYPE'uint32'
Description'Priority indicates the urgency or importance of execution of a job.'
readTrue
Priority property is in 9 classes of ROOT\cimv2 and in 31 namespaces
StartTime property
CIMTYPE'datetime'
Description'The StartTime property represents the UTC time to run the job, in the form of YYYYMMDDHHMMSS.MMMMMM(+-)OOO, where YYYYMMDD must be replaced by ********. The replacement is necessary because the scheduling service only allows jobs to be configured on a day of the month, day of the week, or run once. A job cannot be run on a specific date.
Example: ********123000.000000-420 which implies 12:30 pm PST with daylight savings time in effect.'
MappingStrings['Win32API|Network Management Structures|AT_ENUM|JobTime']
Override'StartTime'
readTrue
StartTime property is in 6 classes of ROOT\cimv2 and in 24 namespaces
Status property
CIMTYPE'string'
Description'The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are "OK", "Degraded" and "Pred Fail". "Pred Fail" indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "Starting", "Stopping" and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.'
MaxLen10
readTrue
ValueMap['OK', 'Error', 'Degraded', 'Unknown', 'Pred Fail', 'Starting', 'Stopping', 'Service', 'Stressed', 'NonRecover', 'No Contact', 'Lost Comm']
Values['OK', 'Error', 'Degraded', 'Unknown', 'Pred Fail', 'Starting', 'Stopping', 'Service', 'Stressed', 'NonRecover', 'No Contact', 'Lost Comm']
Status property is in 230 classes of ROOT\cimv2 and in 42 namespaces
TimeSubmitted property
CIMTYPE'datetime'
Description'Time that the job was submitted.'
readTrue
TimeSubmitted property is in 3 classes of ROOT\cimv2 and in 15 namespaces
UntilTime property
CIMTYPE'datetime'
Description'Time after which the job is invalid or should be stopped.'
readTrue
UntilTime property is in 4 classes of ROOT\cimv2 and in 10 namespaces

Win32_ScheduledJob Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
CreateBy'Create'
DeleteBy'Delete'
Description'The Win32_ScheduledJob class represents a job scheduled using the network management schedule service functions (also known as "Job" and "AT command" functions). Note that this is different from the tasks scheduled using the Windows 2000 Task Scheduler. This class is only instrumented on Windows NT 4.0 and later. Each job scheduled against the schedule service is stored persistently (the scheduler will know to start the job even after a reboot) and is executed at the specified time and day of the week and/or month. If the computer is not active or if the scheduled service is not running at the specified job time the schedule service will run the specified job on the next day at the specified time. Scheduled jobs are scheduled with respect to Universal Coordinated Time (UTC), i.e. with bias offset from GMT. This means that a job can be specified using any time zone specification. The Win32_ScheduledJob class will return the local time with UTC offset when enumerating an object and convert to local time when creating new jobs. For example a job specified to run on a computer in Boston at 10:30 pm Monday PST time will be scheduled to run locally at 1:30am Tuesday EST. It should be noted that a client must take into account whether daylight savings time is in operation on the local computer and if so subtract a bias of 60 minutes from the UTC offset.'
dynamicTrue
Locale1033
provider'CIMWin32'
SupportsCreateTrue
SupportsDeleteTrue
UUID'{8502C4E0-5FBB-11D2-AAC1-006008C78BC7}'

Win32_ScheduledJob System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\cimv2:Win32_ScheduledJob'___SYSTEM8
__NAMESPACE'ROOT\cimv2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_Job', 'CIM_LogicalElement', 'CIM_ManagedSystemElement']___SYSTEM8
__PROPERTY_COUNT19___SYSTEM3
__RELPATH'Win32_ScheduledJob'___SYSTEM8
__DYNASTY'CIM_ManagedSystemElement'___SYSTEM8
__SUPERCLASS'CIM_Job'___SYSTEM8
__CLASS'Win32_ScheduledJob'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to Win32_ScheduledJob

Number of classes:24
comments powered by Disqus
WUtils.com