Home Library Learn Samples Downloads Support Community Forums
This topic has not yet been rated - Rate this topic

ISchedulerJob Members

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

The following tables list the members exposed by the ISchedulerJob type.

  Name Description
public property AllocatedNodes Retrieves the names of the nodes that have been allocated to run the tasks in the job or have run the tasks.
public property AutoCalculateMax Determines whether the scheduler automatically calculates the maximum resource value.
public property AutoCalculateMin Determines whether the scheduler automatically calculates the minimum resource value.
public property CanGrow Determines whether the job resources can grow.
public property CanPreempt Determines whether another job can preempt this job.
public property CanShrink Determines whether the job resources can shrink.
public property ChangeTime Retrieves the last time that the user or server changed a property of the job.
public property ChildJobIds Gets or sets the list of child job IDs.
public property ClientSource Retrieves the name of the process that created the job.
public property CreateTime Retrieves the date and time that the job was created.
public property EmailAddress Gets or sets the email address to which the HPC Job Scheduler Service should send notifications when the job starts or finishes.
public property EndpointAddresses Retrieves the unique network addresses that a client uses to communicate with a service endpoint.
public property EndTime Retrieves the date and time that job ended.
public property EnvironmentVariables Gets the environment variables that are set for the job and their values.
public property ErrorMessage Retrieves the job-related error message or job cancellation message.
public property EstimatedProcessMemory Gets or sets the estimate of the maximum amount of memory the job will consume.
public property ExcludedNodes Gets the list of nodes that should not be used for the job.
public property ExpandedPriority Gets or sets the priority of the job, using the expanded range of priority values in Windows HPC Server 2008 R2.
public property FailDependentTasks Gets or sets a value indicating whether child tasks should be marked as failed if the current task fails.
public property FailOnTaskFailure Determines whether the job fails when one of the tasks in the job fails.
public property HasRuntime Determines whether the Runtime job property is set.
public property HoldUntil Gets the date and time in Coordinated Universal Time until which the HPC Job Scheduler Service should wait before trying to start the job.
public property Id Retrieves the job identifier.
public property IsExclusive Determines whether nodes are exclusively allocated to the job.
public property JobTemplate Retrieves the name of the job template used to initialize the properties of the job.
public property MaxCoresPerNode Retrieves or sets the maximum number of cores that a node can have for the job to run on it.
public property MaximumNumberOfCores Retrieves or sets the maximum number of cores that the scheduler may allocate for the job.
public property MaximumNumberOfNodes Retrieves or sets the maximum number of nodes that the scheduler may allocate for the job.
public property MaximumNumberOfSockets Retrieves or sets the maximum number of sockets that the scheduler may allocate for the job.
public property MaxMemory Retrieves or sets the maximum amount of memory that a node may have for the job to run on it.
public property MinCoresPerNode Retrieves or sets the minimum number of cores that a node must have for the job to run on it.
public property MinimumNumberOfCores Retrieves or sets the minimum number of cores that the job requires to run.
public property MinimumNumberOfNodes Retrieves or sets the minimum number of nodes that the job requires to run.
public property MinimumNumberOfSockets Retrieves or sets the minimum number of sockets that the job requires to run.
public property MinMemory Retrieves or sets the minimum amount of memory that a node must have for the job to run on it.
public property Name Retrieves or sets the display name of the job.
public property NodeGroupOp Gets or sets the operator for the node group.
public property NodeGroups Retrieves or sets the names of the node groups that specify the nodes on which the job can run.
public property NotifyOnCompletion Gets or sets whether or not you want to receive email notification when then job ends.
public property NotifyOnStart Gets or sets whether or not you want to receive email notification when then job starts.
public property OrderBy Retrieves or sets the preference given to the order in which the job is scheduled on nodes.
public property Owner Retrieves the name of the user who created, submitted, or queued the job.
public property ParentJobIds Gets or sets the list of parent job IDs.
public property Pool Returns the name of the job’s pool.
public property PreviousState Retrieves the previous state of the job.
public property Priority Retrieves or sets the job priority.
public property Progress Gets or sets the percentage of the job that is complete.
public property ProgressMessage Gets or sets a custom status message for the job.
public property Project Retrieves or sets the project name to associate with the job.
public property RequestedNodes Retrieves or sets the list of nodes that are requested for the job.
public property RequeueCount Retrieves the number of times that the job has been queued again.
public property Runtime Retrieves or sets the run-time limit for the job.
public property RunUntilCanceled Determines whether the server reserves resources for the job until the job is canceled (even if the job has no active tasks).
public property ServiceName Gets or sets the name of the SOA service that the service tasks in the job use, if the job contains service tasks.
public property SingleNode Gets or sets a value that indicates whether all resources such as cores or sockets should be allocated on one node.
public property SoftwareLicense Retrieves or sets the software licensing requirements for the job.
public property StartTime Retrieves the date and time that the job started running.
public property State Retrieves the state of the job.
public property SubmitTime Retrieves the time that the job was submitted.
public property TargetResourceCount 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.
public property UnitType Determines whether cores, nodes, or sockets are used to allocate resources for the job.
public property UserName Retrieves or sets the RunAs user for the job.
public property ValidExitCodes Gets or sets the exit codes to be used for checking whether tasks in the job successfully exit.
Top
  Name Description
public method AddExcludedNodes Adds the specified nodes to the list of nodes that should not be used for the job.
public method AddTask Adds the task to the job.
public method AddTasks Add the specified tasks to the job.
public method CancelTask Overloaded. Cancels the specified task.
public method ClearExcludedNodes Removes all of the nodes in the list of nodes that should not be used for the job from that list.
public method 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.
public method Commit Commits to the server any local changes to the job.
public method CreateTask Creates a task.
public method Finish Sets the job to the finished state and does not run any additional tasks except node release tasks.
public method GetCounters Retrieves the counter data for the job.
public method GetCustomProperties Retrieves the application-defined properties.
public method GetTaskIdList Retrieves a list of task identifiers based on the specified filters.
public method GetTaskList Retrieves a list of task objects based on the specified filters.
public method OpenJobAllocationHistoryEnumerator Retrieves an enumerator that contains the allocation history for the job.
public method OpenTask Opens the task using the specified task identifier.
public method OpenTaskAllocationHistoryEnumerator Retrieves an enumerator that contains the allocation history for all of the tasks in the job. For a task that includes subtasks, the enumerator contains allocation history entries for all of the subtasks in the task in the place of an entry for the task.
public method OpenTaskEnumerator Retrieves an enumerator that contains the tasks that match the filter criteria.
public method OpenTaskRowSet Retrieves a rowset that contains the jobs that match the filter criteria.
public method Refresh Refreshes this copy of the job with the contents from the server.
public method RemoveExcludedNodes Removes the specified nodes from the list of nodes that should not be used for the job.
public method RequeueTask Queues a task again.
public method RestoreFromXml Overloaded. The methods used to overwrite the properties and tasks of a job using an XML source.
public method SetCustomProperty Sets an application-defined property on the job.
public method SetEnvironmentVariable Sets the specified environment variable to the specified value in the context of the job.
public method SetHoldUntil Sets the earliest date and time until which the HPC Job Scheduler Service should wait until before starting the job.
public method SetJobTemplate Sets the job template to use for the job.
public method SubmitTask Submits a task to the job using the specified task.
public method SubmitTaskById Submits a task to the job using the task identifier to identify the task.
public method SubmitTasks Submits the specified tasks to the job.
Top
  Name Description
public event OnJobState An event that is raised when the state of the job changes.
public event OnTaskState An event that is raised when the state of one of the tasks in the job changes.
Top




Build Date:

2013-04-22
Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.