IScheduler

IScheduler interface

Defines the methods used to schedule and manage the jobs and tasks in a compute cluster.

To create an instance of this interface, call the CoCreateInstance function. Use CLSID_Scheduler as the class identifier and IID_IScheduler as the interface identifier. For an example, see Connecting to a Cluster.

Members

The IScheduler interface inherits from the IDispatch interface. IScheduler also has these types of members:

Methods

The IScheduler interface has these methods.

MethodDescription
AddJob

Adds the specified job to the cluster.

CancelJob

Cancels the specified job.

CancelJob_2

Cancels the specified job and provides a message to the user that explains why you canceled the job, and optionally forces the job to stop immediately.

This method is supported only for Windows HPC Server 2008 R2.

CloneJob

Clones the specified job.

Close

Closes the connection between the application and the HPC Job Scheduler Service.

This method is supported only for Windows HPC Server 2008 R2.

ConfigureJob

Moves the job to the configuration state.

Connect

Connects to the specified cluster.

CreateCommand

Creates a command to execute and writes the output to the cluster's spooler.

CreateCommandInfo

Creates a CommandInfo object that defines the command properties.

CreateFilterCollection

Creates an empty collection to which you add filter properties.

CreateIntCollection

Creates an empty collection to which you add integer values.

CreateJob

Creates a job that uses the default job template.

CreateNameValueCollection

Creates an empty collection to which you can add name/value pairs.

CreateParametricTaskId

Creates a task identifier that identifies a parametric task.

CreatePool

Creates a pool on a cluster based on the supplied name with a desired weight. An exception is thrown if a pool with the same name exists.

CreateSortCollection

Creates an empty collection to which you add sort properties.

CreateStringCollection

Creates an empty collection to which you add string values.

CreateTaskId

Creates a task identifier that identifies a task.

DeleteCachedCredentials

Deletes the credentials that were cached for the specified user.

DeleteEmailCredentials

Removes the email credentials for running jobs.

DeletePool

Deletes a pool on a cluster based on the supplied name. An exception is thrown if the pool doesn’t exist.

EnrollCertificate

Enrolls the user in a certificate based on the supplied template.

GetActiveHeadNode

Retrieves the name of the active head node.

GetCertificateFromStore

Retrieves a certificate matching the thumbprint from the local store encoded as a stream of bytes.

GetCounters

Retrieves counter information for the cluster.

GetJobIdList

Retrieves a list of job identifiers based on the specified filter.

GetJobList

Retrieves a list of job objects based on the specified filter.

GetJobTemplateList

Retrieves a list of job template names defined in the cluster.

GetNodeGroupList

Retrieves a list of node group names defined in the cluster.

GetNodeIdList

Retrieves a list of identifiers for the nodes in the cluster based on the specified filter.

GetNodeList

Retrieves a list of nodes in the cluster based on the specified filter.

GetNodesInNodeGroup

Retrieves the list of nodes in the specified node group.

GetPoolList

Gets a list of all pools on the cluster.

GetServerVersion

Retrieves the file version of the HPC server assembly.

GetUserPrivilege

Retrieves the privilege level of the user.

OpenJob

Retrieves the specified job from the scheduler.

OpenNode

Retrieves a node object using the specified node identifier.

OpenNodeByName

Retrieves a node object using the specified node name.

OpenPool

Opens a pool based on the name of the pool on the cluster.

SetCachedCredentials

Sets the credentials for the specified user in the credential cache, so that the job scheduler can use the credentials for submitting jobs.

SetCertificateCredentials

Uploads a certificate in the client’s certificate store to the scheduler for running jobs as this user.

SetCertificateCredentialsPfx

Uploads a certificate encoded with a password to the scheduler to use for running jobs as this user.

SetClusterParameter

Sets a configuration parameter for the cluster.

SetEmailCredentials

Sets the email credentials by using the specified username and password.

SetEnvironmentVariable

Sets a cluster-wide environment variable.

SetInterfaceMode

Specifies whether the calling application is a console or Windows application.

SubmitJob

Adds the job to the scheduling queue using the job object to identify the job.

SubmitJobById

Adds the job to the scheduling queue using the job identifier to identify the job.

 

Properties

The IScheduler interface has these properties.

PropertyAccess typeDescription

ClusterParameters

Read-only

Retrieves the cluster's configuration parameters.

EnvironmentVariables

Read-only

Retrieves the cluster-wide environment variables.

 

Remarks

After creating an instance of this interface, call the Connect method to connect to a cluster. You can then create and schedule jobs, run commands, and retrieve information about nodes in the cluster.

To create the Scheduler object in a script, use Microsoft.Hpc.Scheduler.Scheduler as the program identifier when calling the CreateObject method.

Requirements

Product

HPC Pack 2008 R2 Client Utilities, HPC Pack 2008 Client Utilities

Type library

Microsoft.Hpc.Scheduler.tlb

See also

HPC Interfaces
ISchedulerJob
ISchedulerNode
ISchedulerCounters
ISchedulerTask

 

 

Show:
© 2016 Microsoft