IClusterService Members
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 | |
---|---|---|
ClusterCounter | Retrieves counter information for the cluster, such as the number of jobs that are running or that have finished. | |
Name | Retrieves the display name of the cluster. |
Top
Public Methods
Name | Description | |
---|---|---|
AddJob | Adds the specified job to the cluster. | |
AddJobs | Adds one or more specified jobs to the cluster. | |
AddTask | Adds the specified task to the specified job. | |
AddTasks | Adds one or more specified tasks to the specified job. | |
ApproveNode | Approves the addition of the specified node to the cluster. | |
CancelJob | Cancels the specified job. | |
CancelJobs | Cancels one or more specified jobs. | |
CancelTask | Cancels the specified task. | |
CancelTasks | Cancels one or more specified tasks. | |
CheckAnyTask | Checks for tasks in the job that have finished, failed, or been canceled and returns the task. | |
EndCommand | Cancels the specified command on all nodes on which the command is running. | |
ExecuteCommand | Overloaded. Executes a task on a specified group of nodes in the cluster. | |
GetCachedCredentials | Encrypt the credentials for the client to cache. | |
GetClusterEnvironmentVariables | Retrieves the cluster-wide environment variables. The variables are available to all tasks on all nodes. | |
GetClusterParameters | Retrieves the cluster's configuration parameters. | |
GetJob | Retrieves a job from the cluster. | |
GetJobCounter | Retrieves counter information for a specified job. | |
GetJobResourceUsage | Retrieves the resource usage information for the specified job. | |
GetNewCommandId | Gets a command identifier that is used to execute a command. | |
GetNode | Retrieves information about a specified node. | |
GetTask | Retrieves a task from the specified job. | |
GetTaskResourceUsage | Retrieves the resource usage information for the specified task. | |
IsInRole | Determines whether the calling user is in a particular role, for example, the BUILTIN\\Administrators role. | |
JoinNode | Add a new node to the cluster. | |
ListJobs | Overloaded. Retrieves jobs in the cluster. | |
ListJobsOnNode | Retrieves all jobs that are running on the specified node. | |
ListNodes | Retrieves the list of nodes in the cluster. | |
ListTasks | Overloaded. Retrieves tasks in the specified job. | |
ListTasksOnNode | Retrieves a list of all tasks running on the node. | |
ModifyJob | Overloaded. Modifies the specified job. | |
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. | |
QueueJob | Overloaded. Adds the specified job to the cluster and scheduling queue. | |
QueueJobs | Overloaded. Adds one or more jobs to the cluster and scheduling queue. | |
ReadExecutionResult | Retrieves the output from a command. | |
RemoveNode | Removes the specified node from the cluster | |
RequeueJob | Queues the specified job again. | |
RequeueJobs | Queues one or more specified jobs again. | |
RequeueTask | Queues the specified task again. | |
RequeueTasks | Queues one or more specified tasks again. | |
ResumeNode | Resumes scheduling new jobs and tasks on the specified node. | |
SetClusterEnvironmentVariable | Sets a cluster-wide environment variable. | |
SetClusterParameter | Sets a configuration parameter for the cluster. | |
SetJobCachedCredentials | Sets the RunAs credentials for the specified job. | |
SetJobCredentials | Sets the RunAs credentials for the specified job. | |
SubmitJob | Overloaded. Adds the specified job to the scheduling queue. | |
SubmitJobs | Overloaded. Adds one or more specified jobs to the scheduling queue. | |
WaitForCommand | Waits for execution of the command to be completed on at least one node. |
Top
See Also
Reference
IClusterService Interface
Microsoft.ComputeCluster Namespace