ISchedulerJob interface

Manages the tasks and resources that are associated with a job.

To create a job, call the IScheduler::CreateJob method. To clone a job, call the IScheduler::CloneJob method.

Members

The ISchedulerJob interface inherits from the IDispatch interface. ISchedulerJob also has these types of members:

• Methods
• Properties

Methods

The ISchedulerJob interface has these methods.

Method	Description
AddExcludedNodes	Adds the specified nodes to the list of nodes that should not be used for the job. This method is supported only for This method is supported only for Windows HPC Server 2008 R2.
AddTask	Adds a task to the job.
CancelTask	Cancels a task.
CancelTask_2	Cancels the specified task and provides the specified message to the user to explain why the task was canceled. This method is supported only for This method is supported only for Windows HPC Server 2008 R2.
CancelTask_3	Cancels the specified task with the option to specify that you want to cancel the task immediately without using the grace period for canceling a task, and provides the specified message to the user to explain why the task was canceled. This method is supported only for This method is supported only for Windows HPC Server 2008 R2.
ClearExcludedNodes	Removes all of the nodes in the list of nodes that should not be used for the job from that list. This method is supported only for This method is supported only for Windows HPC Server 2008 R2.
ClearHold	Removes the hold on the job by clearing the date and time that the HPC Job Scheduler Service should wait until before running the job.
Commit	Commits to the server any local changes to the job.
CreateTask	Creates a task.
Finish	Sets the job to the finished state and does not run any additional tasks except node release tasks. This method is supported only for This method is supported only for Windows HPC Server 2008 R2.
GetCounters	Retrieves the counter data for the job.
GetCustomProperties	Retrieves the application-defined properties that were added to the job using the ISchedulerJob::SetCustomProperty method.
GetTaskIdList	Retrieves a list of task identifiers based on the specified filters.
GetTaskList	Retrieves a list of task objects based on the specified filters.
OpenTask	Opens a task.
Refresh	Refreshes this copy of the job with the contents from the server.
RemoveExcludedNodes	Removes the specified nodes from the list of nodes that should not be used for the job. This method is supported only for This method is supported only for Windows HPC Server 2008 R2.
RequeueTask	Queues a task again.
RestoreFromXml	Overwrites the properties and tasks of the job using the XML at the specified URL.
SetCustomProperty	Sets an application-defined property on the job.
SetEnvironmentVariable	Sets the specified environment variable to the specified value in the context of the job. This method is supported only for This method is supported only for Windows HPC Server 2008 R2.
SetHoldUntil	Sets the earliest date and time until which the HPC Job Scheduler Service should wait until before starting the job.
SetJobTemplate	Sets the job template to use for the job.
SubmitTask	Submits a task to the job using the task object to identify the task.
SubmitTaskById	Submits a task to the job using the task identifier to identify the task.

 

Properties

The ISchedulerJob interface has these properties.

Property	Access type	Description
AllocatedNodes	Read-only	Retrieves the names of the nodes that have been allocated to run the tasks in the job or have run the tasks.
AutoCalculateMax	Read/write	Determines whether the server automatically calculates the maximum value.
AutoCalculateMin	Read/write	Determines if the server automatically calculates the minimum value.
CanGrow	Read-only	Determines whether the job resources can grow.
CanPreempt	Read/write	Determines whether another job can preempt this job.
CanShrink	Read-only	Determines whether the job resources can shrink.
ChangeTime	Read-only	Retrieves the last time that user or server changed a property of the job.
ClientSource	Read/write	Retrieves or sets the name of the process that created the job.
CreateTime	Read-only	Retrieves the date and time that the job was created.
EmailAddress	Read/write	Retrieves or sets the email address to which the HPC Job Scheduler Service should send notifications when the job starts or finishes.
EndpointAddresses	Read-only	Retrieves a collection of endpoint addresses that you can use to connect to a shared session.
EndTime	Read-only	Retrieves the date and time that job ended.
EnvironmentVariables	Read-only	Gets the environment variables that are set for the job and their values. This property is supported only for Windows HPC Server 2008 R2.
ErrorMessage	Read-only	Retrieves the error message.
EstimatedProcessMemory	Read/write	Retrieves or sets the estimate of the maximum amount of memory the job will consume.
ExpandedPriority	Read-only	Gets the list of nodes that should not be used for the job. This property is supported only for Windows HPC Server 2008 R2.
ExpandedPriority	Read/write	Gets or sets the priority of the job by using the expanded range of priority values in Windows HPC Server 2008 R2. This property is supported only for Windows HPC Server 2008 R2.
FailDependentTasks	Read/write	Retrieves or sets a value indicating whether child tasks should be marked as failed if the current task fails.
FailOnTaskFailure	Read/write	Determines whether the job fails when one of the tasks in the job fails.
HasRuntime	Read-only	Determines whether the Runtime job property is set.
HoldUntil	Read-only	Gets the date and time (in Coordinated Universal Time) until which the HPC Job Scheduler Service should wait before trying to start the job. This property is supported only for Windows HPC Server 2008 R2.
Id	Read-only	Retrieves the job identifier.
IsExclusive	Read/write	Determines whether nodes should be exclusively allocated to the job.
JobTemplate	Read/write	Retrieves the name of the job template used to initialize the properties of the job.
MaxCoresPerNode	Read/write	Retrieves or sets the maximum number of cores that a node can have for the job to run on it.
MaximumNumberOfCores	Read/write	Retrieves or sets the maximum number of cores that a node can have for the job to run on it.
MaximumNumberOfNodes	Read/write	Retrieves or sets the maximum number of nodes that a node can have for the job to run on it.
MaximumNumberOfSockets	Read/write	Retrieves or sets the maximum number of sockets that a node can have for the job to run on it.
MaxMemory	Read/write	Retrieves or sets the maximum amount of memory that a node can have for the job to run on it.
MinCoresPerNode	Read/write	Retrieves or sets the minimum number of cores that a node must have for the job to run on it.
MinimumNumberOfCores	Read/write	Retrieves or sets the minimum number of cores that a node must have for the job to run on it.
MinimumNumberOfNodes	Read/write	Retrieves or sets the minimum number of nodes that a node must have for the job to run on it.
MinimumNumberOfSockets	Read/write	Retrieves or sets the minimum number of sockets that a node must have for the job to run on it.
MinMemory	Read/write	Retrieves or sets the minimum amount of memory that a node must have for the job to run on it.
Name	Read/write	Retrieves or sets the display name of the job.
NodeGroupOp	Read/write	Retrieves or sets the operator for the node group.
NodeGroups	Read/write	Retrieves or sets the names of the node groups that define the nodes on which the job can run.
NotifyOnCompletion	Read/write	Gets or sets whether you want to receive an email notification when then job ends. This property is supported only for Windows HPC Server 2008 R2.
NotifyOnStart	Read/write	Gets or sets whether you want to receive an email notification when then job starts. This property is supported only for Windows HPC Server 2008 R2.
OrderBy	Read-only	Retrieves or sets the preference given to the order in which the job is scheduled on nodes.
Owner	Read-only	Retrieves the name of the user who created, submitted, or queued the job.
ParentJobIds	Read-only	Retrieves or sets the list of parent job IDs.
Pool	Read-only	Retrieves the name of the job’s pool.
PreviousState	Read-only	Retrieves the previous state of the job.
Priority	Read/write	Retrieves or sets the job priority.
Progress	Read/write	Gets or sets the percentage of the job that is complete. This property is supported only for This method is supported only for Windows HPC Server 2008 R2.
ProgressMessage	Read/write	Gets or sets a custom status message for the job. This property is supported only for This method is supported only for Windows HPC Server 2008 R2.
Project	Read/write	Retrieves or sets the project name that is associated with the job.
RequestedNodes	Read/write	Retrieves or sets the list of nodes that are requested for the job.
RequeueCount	Read-only	Retrieves the number of times that the job has been queued.
Runtime	Read/write	Retrieves or sets the run-time limit for the job.
RunUntilCanceled	Read/write	Determines whether the server reserves resources for the job until the job is canceled (even if the job has no active tasks).
ServiceName	Read/write	Gets or sets the name of the SOA service that the service tasks in the job use, if the job contains service tasks. . This property is supported only for This method is supported only for Windows HPC Server 2008 R2.
SingleNode	Read/write	Retrieves or sets a value that indicates whether all resources such as cores or sockets should be allocated on one node.
SoftwareLicense	Read/write	Retrieves or sets the software licensing requirements for the job.
StartTime	Read-only	Retrieves the date and time that the job started running.
State	Read-only	Retrieves the state of the job.
SubmitTime	Read-only	Retrieves the time that the job was submitted (added to the scheduling queue).
TargetResourceCount	Read/write	Gets or sets the maximum number of resources that a job can use dynamically, so that the HPC Job Scheduler Service does not allocate more resources than the job can use. This property is supported only for Windows HPC Server 2008 R2.
UnitType	Read/write	Determines whether cores, nodes, or sockets are used to allocate resources for the job.
UserName	Read/write	Retrieves or sets the RunAs user for the job.
ValidExitCodes	Read/write	Retrieves or sets the exit codes to be used for checking whether tasks in the job successfully exit.

 

Requirements

Product	HPC Pack 2008 R2 Client Utilities, HPC Pack 2008 Client Utilities
Type library	Microsoft.Hpc.Scheduler.tlb

See also

HPC Interfaces

IScheduler

ISchedulerJobCounters

ISchedulerNode

ISchedulerTask