ISchedulerTask interface

Defines a task.

To create a task, call the ISchedulerJob::CreateTask method.

Members

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

• Methods
• Properties

Methods

The ISchedulerTask interface has these methods.

Method	Description
Commit	Commits the local task changes to the server.
GetCounters	Retrieves the counter data for the task.
GetCustomProperties	Retrieves the application-defined properties that were added to the task.
Refresh	Refreshes this copy of the task with the contents from the server.
ServiceConclude	Directs the HPC Job Scheduler Service to stop starting subtasks for a service task. This method is supported only for Windows HPC Server 2008 R2.
SetCustomProperty	Sets an application-defined property on the task.
SetEnvironmentVariable	Sets a task-specific environment variable.

 

Properties

The ISchedulerTask interface has these properties.

Property	Access type	Description
AllocatedCoreIds	Read-only	Retrieves the identifiers of the processor cores that have been allocated to run the task or that have run the task. This property is supported only for Windows HPC Server 2008 R2.
AllocatedNodes	Read-only	Retrieves the names of the nodes that have been allocated to run the task or have run the task.
ChangeTime	Read-only	Retrieves the last time that the user or server changed a property of the task.
CommandLine	Read/write	Retrieves or sets the command line for the task.
CreateTime	Read-only	Retrieves the date and time when the task was created.
DependsOn	Read/write	Retrieves or sets the dependent tasks.
EndTime	Read-only	Retrieves the date and time that the task ended.
EndValue	Read/write	Retrieves or sets the ending value for a parametric task.
EnvironmentVariables	Read-only	Retrieves the environment variables that were set for the task.
ErrorMessage	Read-only	Retrieves the task error message.
ExitCode	Read-only	Retrieves the exit code for the task.
FailJobOnFailure	Read/write	Determines whether the task is critical for the job. If a task is critical for the job, the job and its tasks stop running and the job is immediately marked as failed if the task fails.
FailJobOnFailureCount	Read/write	Retrieves or sets the number of subtasks of a critical parametric sweep or service task that must fail before the job and its tasks and subtask should stop running and the task and job should be marked as failed.
HasRuntime	Read/write	Determines whether the Runtime task property is set.
IncrementValue	Read/write	Retrieves or sets the number by which to increment the instance value for a parametric task.
IsExclusive	Read/write	Determines whether other tasks from the job can run on the node at the same time as this task.
IsParametric	Read/write	Determines whether the task is a parametric task.
IsRerunnable	Read/write	Determines whether the task can rerun after a failure.
IsServiceConcluded	Read-only	Gets whether the HPC Job Scheduler Service has concluded starting subtasks for a service task. This property is supported only for Windows HPC Server 2008 R2.
MaximumNumberOfCores	Read/write	Retrieves or sets the maximum number of cores that the task requires to run.
MaximumNumberOfNodes	Read/write	Retrieves or sets the maximum number of nodes that the task requires to run.
MaximumNumberOfSockets	Read/write	Retrieves or sets the maximum number of sockets that the task requires to run.
MinimumNumberOfCores	Read/write	Retrieves or sets the minimum number of cores that the task requires to run.
MinimumNumberOfNodes	Read/write	Retrieves or sets the minimum number of nodes that the task requires to run.
MinimumNumberOfSockets	Read/write	Retrieves or sets the minimum number of sockets that the task requires to run.
Name	Read/write	Retrieves or sets the display name of the task.
Output	Read-only	Retrieves the output from the command.
ParentJobId	Read-only	Retrieves the identifier of the parent job.
PreviousState	Read-only	Retrieves the previous state of the task.
RequeueCount	Read-only	Retrieves the number of times that the task has been queued.
RequiredNodes	Read/write	Retrieves or sets the list of required nodes for the task.
Runtime	Read/write	Retrieves or sets the run-time limit for the task.
StartTime	Read-only	Retrieves the date and time that the job started running.
StartValue	Read/write	Retrieves or sets the starting instance value for a parametric task.
State	Read-only	Retrieves the state of the task.
StdErrFilePath	Read/write	Retrieves or sets the path to which the server redirects standard error.
StdInFilePath	Read/write	Retrieves or sets the path from which the server redirects standard input.
StdOutFilePath	Read/write	Retrieves or sets the path to which the server redirects standard output.
SubmitTime	Read-only	Retrieves the time that the task was submitted.
TaskId	Read-only	Retrieves the identifiers that uniquely identify the task.
Type	Read/write	Gets or sets a task type that defines how to run the command for the task. This property is supported only for Windows HPC Server 2008 R2.
UserBlob	Read/write	Retrieves or sets the user data associated with the task.
ValidExitCodes	Read/write	Retrieves or sets the exit codes to be used for checking whether tasks in the job successfully exit.
WorkDirectory	Read/write	Retrieves or sets the startup directory for the task.

 

Requirements

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

See also

HPC Interfaces

IScheduler

ISchedulerJob

ISchedulerNode

ISchedulerTaskCounters