Share via

ICluster 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 ICluster 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 ComputeNodes Retrieves the list of compute nodes in a cluster.
public property EnvironmentVariables Retrieves the cluster-wide environment variables. The variables are available to all tasks on all nodes.
public property ErrorMessage Retrieves a description of the error that occurred when a method of the ICluster interface failed.
public property IsAsynchronous Determines whether calls to the server are executed asynchronously.
public property Name Retrieves the display name of the cluster.
public property Parameters Retrieves the cluster's configuration parameters.
public property Timeout Retrieves or sets the maximum time that the application will wait for a response from the cluster when making synchronous calls.

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 Connect Connects to the specified cluster.
public method CreateClusterEnumerable Creates an enumerable object.
public method CreateJob Creates a job.
public method CreateJobFromXml Creates a job using the specified XML document.
public method CreateJobFromXmlFile Creates a job using the specified XML file.
public method CreateTask Creates a task.
public method CreateTaskFromXml Creates a task using the specified XML document.
public method CreateTaskFromXmlFile Creates a task using the specified XML file.
public method DeleteCachedCredentials Deletes the credentials that were cached for the specified user.
public method EndCommand Cancels the specified command on all nodes on which the command is running.
public method ExecuteCommand Executes a task on a specified group of nodes in the cluster.
public method ExecuteCommandWithPaging Executes a task on a specified group of nodes in the cluster. The output is returned in the requested page size.
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 GetTask Retrieves a task from the specified job.
public method GetTaskResourceUsage Retrieves the resource usage information for the specified task.
public method IsAdmin Determines whether the user is a member of the cluster's Administrators group.
public method ListAllJobs Retrieves all jobs in the cluster.
public method ListAllJobsWithPaging Retrieves all jobs in the cluster. The jobs are returned in blocks of jobs from a specified snapshot of the cluster.
public method ListJobs Retrieves all jobs in the cluster that were submitted by the specified owner and that have the specified status.
public method ListJobsOnNode Retrieves all jobs that are running on the specified node.
public method ListJobsWithPaging Retrieves all jobs in the cluster that were submitted by the specified user and that have the specified status. The jobs are returned in blocks of jobs from a specified snapshot of the cluster.
public method ListTasks Retrieves all tasks in the specified job.
public method ListTasksOnNode Retrieves a list of all tasks running on the node.
public method ListTasksWithPaging Retrieves all tasks in the specified job. The tasks are returned in blocks of tasks from a specified snapshot of the job.
public method ModifyJob Modifies the specified job.
public method ModifyJobTerm Modifies the specified job term.
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 Adds the specified job to the cluster and scheduling queue.
public method QueueJobs Adds one or more jobs to the cluster and scheduling queue.
public method ReadExecutionResult Retrieves the output from a command.
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 SetCachedCredentials Sets credentials for the specified user in the credential cache.
public method SetClusterParameter Sets a configuration parameter for the cluster.
public method SetEnvironmentVariable Sets a cluster-wide environment variable.
public method SetJobCredentials Sets the RunAs credentials for the specified job.
public method SetJobCredentialsFromCache Sets the credentials for the specified job using credentials from the credential cache.
public method SubmitJob Adds the specified job to the scheduling queue.
public method SubmitJobs 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.
public method WaitForCommandWithPaging Waits for execution of the specified command to be completed on at least one node. The output is returned in the requested page size.

Top

See Also

Reference

ICluster Interface
Microsoft.ComputeCluster Namespace