ICluster interface
Defines methods to manage the nodes, jobs, and tasks in a compute cluster.
To create an instance of this interface, call the CoCreateInstance function. Use CLSID_Cluster as the class identifier and IID_ICluster as the interface identifier. For an example, see Creating the Cluster Object.
Members
The ICluster interface inherits from the IDispatch interface. ICluster also has these types of members:
- Methods
Methods
The ICluster interface has these methods.
| Method | 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 which tasks for the job have finished, failed, or been canceled. |
| Connect | Connects to the specified cluster. |
| CreateClusterEnumerable | Creates an enumerable object. |
| CreateJob | Creates a job. |
| CreateJobFromXml | Creates a job using the specified XML document. |
| CreateJobFromXmlFile | Creates a job using the specified XML file. |
| CreateTask | Creates a task. |
| CreateTaskFromXml | Creates a task using the specified XML document. |
| CreateTaskFromXmlFile | Creates a task using the specified XML file. |
| DeleteCachedCredentials | Deletes the specified user's credentials from the cache. |
| EndCommand | Cancels the specified command on all nodes. |
| ExecuteCommand | Executes a task on a specified group of nodes in the cluster. |
| ExecuteCommandWithPaging | Executes a task on a specified group of nodes in the cluster. The output is returned in the requested page size. |
| get_ClusterCounter | Retrieves counter information for the cluster. |
| get_ComputeNodes | Retrieves the list of compute nodes in the cluster. |
| get_EnvironmentVariables | Retrieves the cluster-wide environment variables. |
| get_ErrorMessage | Retrieves a description of the error that occurred when a method of the ICluster interface failed. |
| get_IsAsynchronous | Determines whether calls to the server are executed asynchronously. |
| get_Name | Retrieves the display name of the cluster. |
| get_Parameters | Retrieves the cluster's configuration parameters. |
| get_Timeout | Retrieves the maximum time that the application will wait for a response from the cluster when making synchronous calls. |
| 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. |
| GetTask | Retrieves the task from the specified job. |
| GetTaskResourceUsage | Retrieves the resource usage information for the specified task. |
| IsAdmin | Determines whether the user is a member of the cluster's Administrators group. |
| ListAllJobs | Retrieves all jobs in the cluster. |
| ListAllJobsWithPaging | Retrieves all jobs in the cluster. The jobs are returned in blocks of jobs from a specified snapshot of the cluster. |
| ListJobs | Retrieves all jobs in the cluster that were submitted by the specified owner and that have the specified status. |
| ListJobsOnNode | Retrieves all jobs that are running on the specified node. |
| ListJobsWithPaging | Retrieves all jobs in the cluster that were submitted by the specified owner and that have the specified status. The jobs are returned in blocks of jobs from a specified snapshot of the cluster. |
| ListTasks | Retrieves all tasks in the specified job. |
| ListTasksOnNode | Retrieves a list of all tasks running on the node. |
| ListTasksWithPaging | Retrieves all tasks in the specified job. The tasks are returned in blocks of tasks from a specified snapshot of the job. |
| ModifyJob | Modifies the specified job. |
| ModifyJobTerm | Modifies the specified job term. |
| PauseNode | Prevents the scheduler from starting new jobs and tasks on the specified node until the ICluster::ResumeNode method is called; existing jobs and tasks will continue to run. |
| put_IsAsynchronous | Sets whether calls to the server are executed asynchronously. |
| put_Timeout | Sets the maximum time that the application will wait for a response from the cluster when making synchronous calls. |
| QueueJob | Adds the specified job to the cluster and scheduling queue. |
| QueueJobs | Adds one or more specified jobs to the cluster and scheduling queue. |
| ReadExecutionResult | Retrieves the output from a command. |
| 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. |
| SetCachedCredentials | Sets the credentials for the specified user in the credential cache. |
| SetClusterParameter | Sets a configuration parameter for the cluster. |
| SetEnvironmentVariable | Sets a cluster-wide environment variable. |
| SetJobCredentials | Sets the credentials for the specified job. |
| SetJobCredentialsFromCache | Sets the credentials for the specified job using credentials from the credential cache. |
| SubmitJob | Adds the specified job to the scheduling queue. |
| SubmitJobs | 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. |
| 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. |
Remarks
After creating an instance of this interface, call the Connect method to connect to the cluster. You can then create and schedule jobs and tasks on the cluster.
To create the Cluster object in a script, use Microsoft.ComputeCluster.Cluster as the program identifier when calling the CreateObject method.
Requirements
Product |
Compute Cluster Pack Client Utilities |
Type library |
Ccpapi.tlb |