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 |
---|---|---|
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. |
|
Read-only |
Retrieves the names of the nodes that have been allocated to run the task or have run the task. |
|
Read-only |
Retrieves the last time that the user or server changed a property of the task. |
|
Read/write |
Retrieves or sets the command line for the task. |
|
Read-only |
Retrieves the date and time when the task was created. |
|
Read/write |
Retrieves or sets the dependent tasks. |
|
Read-only |
Retrieves the date and time that the task ended. |
|
Read/write |
Retrieves or sets the ending value for a parametric task. |
|
Read-only |
Retrieves the environment variables that were set for the task. |
|
Read-only |
Retrieves the task error message. |
|
Read-only |
Retrieves the exit code for the task. |
|
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. |
|
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. |
|
Read/write |
Determines whether the Runtime task property is set. |
|
Read/write |
Retrieves or sets the number by which to increment the instance value for a parametric task. |
|
Read/write |
Determines whether other tasks from the job can run on the node at the same time as this task. |
|
Read/write |
Determines whether the task is a parametric task. |
|
Read/write |
Determines whether the task can rerun after a failure. |
|
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. |
|
Read/write |
Retrieves or sets the maximum number of cores that the task requires to run. |
|
Read/write |
Retrieves or sets the maximum number of nodes that the task requires to run. |
|
Read/write |
Retrieves or sets the maximum number of sockets that the task requires to run. |
|
Read/write |
Retrieves or sets the minimum number of cores that the task requires to run. |
|
Read/write |
Retrieves or sets the minimum number of nodes that the task requires to run. |
|
Read/write |
Retrieves or sets the minimum number of sockets that the task requires to run. |
|
Read/write |
Retrieves or sets the display name of the task. |
|
Read-only |
Retrieves the output from the command. |
|
Read-only |
Retrieves the identifier of the parent job. |
|
Read-only |
Retrieves the previous state of the task. |
|
Read-only |
Retrieves the number of times that the task has been queued. |
|
Read/write |
Retrieves or sets the list of required nodes for the task. |
|
Read/write |
Retrieves or sets the run-time limit for the task. |
|
Read-only |
Retrieves the date and time that the job started running. |
|
Read/write |
Retrieves or sets the starting instance value for a parametric task. |
|
Read-only |
Retrieves the state of the task. |
|
Read/write |
Retrieves or sets the path to which the server redirects standard error. |
|
Read/write |
Retrieves or sets the path from which the server redirects standard input. |
|
Read/write |
Retrieves or sets the path to which the server redirects standard output. |
|
Read-only |
Retrieves the time that the task was submitted. |
|
Read-only |
Retrieves the identifiers that uniquely identify the task. |
|
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. |
|
Read/write |
Retrieves or sets the user data associated with the task. |
|
Read/write |
Retrieves or sets the exit codes to be used for checking whether tasks in the job successfully exit. |
|
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 |