IClusterService Members

  • Article

Defines methods and properties to manage the nodes, jobs, and tasks in a compute cluster.

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

Public Properties

  Name Description
public property ClusterCounter Retrieves counter information for the cluster, such as the number of jobs that are running or that have finished.
public property Name Retrieves the display name of the cluster.

Top

Public Methods

  Name Description
public method AddJob Adds the specified job to the cluster.
public method AddJobs Adds one or more specified jobs to the cluster.
public method AddTask Adds the specified task to the specified job.
public method AddTasks Adds one or more specified tasks to the specified job.
public method ApproveNode Approves the addition of the specified node to the cluster.
public method CancelJob Cancels the specified job.
public method CancelJobs Cancels one or more specified jobs.
public method CancelTask Cancels the specified task.
public method CancelTasks Cancels one or more specified tasks.
public method CheckAnyTask Checks for tasks in the job that have finished, failed, or been canceled and returns the task.
public method EndCommand Cancels the specified command on all nodes on which the command is running.
public method ExecuteCommand Overloaded. Executes a task on a specified group of nodes in the cluster.
public method GetCachedCredentials Encrypt the credentials for the client to cache.
public method GetClusterEnvironmentVariables Retrieves the cluster-wide environment variables. The variables are available to all tasks on all nodes.
public method GetClusterParameters Retrieves the cluster's configuration parameters.
public method GetJob Retrieves a job from the cluster.
public method GetJobCounter Retrieves counter information for a specified job.
public method GetJobResourceUsage Retrieves the resource usage information for the specified job.
public method GetNewCommandId Gets a command identifier that is used to execute a command.
public method GetNode Retrieves information about a specified node.
public method GetTask Retrieves a task from the specified job.
public method GetTaskResourceUsage Retrieves the resource usage information for the specified task.
public method IsInRole Determines whether the calling user is in a particular role, for example, the BUILTIN\\Administrators role.
public method JoinNode Add a new node to the cluster.
public method ListJobs Overloaded. Retrieves jobs in the cluster.
public method ListJobsOnNode Retrieves all jobs that are running on the specified node.
public method ListNodes Retrieves the list of nodes in the cluster.
public method ListTasks Overloaded. Retrieves tasks in the specified job.
public method ListTasksOnNode Retrieves a list of all tasks running on the node.
public method ModifyJob Overloaded. Modifies the specified job.
public method PauseNode Prevents the scheduler from starting new jobs and tasks on the specified node until the ICluster.ResumeNode method is called. New jobs and tasks will not start while the node is paused, but existing jobs and tasks will continue to run.
public method QueueJob Overloaded. Adds the specified job to the cluster and scheduling queue.
public method QueueJobs Overloaded. Adds one or more jobs to the cluster and scheduling queue.
public method ReadExecutionResult Retrieves the output from a command.
public method RemoveNode Removes the specified node from the cluster
public method RequeueJob Queues the specified job again.
public method RequeueJobs Queues one or more specified jobs again.
public method RequeueTask Queues the specified task again.
public method RequeueTasks Queues one or more specified tasks again.
public method ResumeNode Resumes scheduling new jobs and tasks on the specified node.
public method SetClusterEnvironmentVariable Sets a cluster-wide environment variable.
public method SetClusterParameter Sets a configuration parameter for the cluster.
public method SetJobCachedCredentials Sets the RunAs credentials for the specified job.
public method SetJobCredentials Sets the RunAs credentials for the specified job.
public method SubmitJob Overloaded. Adds the specified job to the scheduling queue.
public method SubmitJobs Overloaded. Adds one or more specified jobs to the scheduling queue.
public method WaitForCommand Waits for execution of the command to be completed on at least one node.

Top

See Also

Reference

IClusterService Interface
Microsoft.ComputeCluster Namespace