IScheduler Interface

Definition

Namespace:

Microsoft.Hpc.Scheduler

Assembly:

Microsoft.Hpc.Scheduler.dll

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

[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("F10017E8-B9D3-4171-A974-406C6A7E62EE")]
public interface IScheduler : IDisposable

type IScheduler = interface
    interface IDisposable

Public Interface IScheduler
Implements IDisposable

Derived

Microsoft.Hpc.Scheduler.Scheduler

Attributes

ComVisibleAttribute GuidAttribute

Implements

IDisposable

Properties

ClusterParameters	Retrieves the cluster's configuration parameters.
EnvironmentVariables	Retrieves the cluster-wide environment variables.

Methods

AddJob(ISchedulerJob)	Adds the specified job to the scheduler.
CancelJob(Int32, String)	Cancels the specified job and provides a message to the user that explains why you canceled the job.
CancelJob(Int32, String, Boolean)	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. When you force the job to stop immediately, this method ignores the grace period for canceling the tasks in the job, and does not run the node release task for the job.
CancelJob(Int32, String, Boolean, Boolean)
CloneJob(Int32)	Clones the specified job.
Close()
ConfigureJob(Int32)	Moves the job to the Configuring state.
Connect(String)	Connects you to the specified cluster.
Connect(String, ConnectMethod)
ConnectAsync(SchedulerConnectionContext, CancellationToken)
ConnectAsync(SchedulerConnectionContext, CancellationToken, ConnectMethod)
ConnectServiceAsClient(String, ServiceAsClientIdentityProvider)
ConnectServiceAsClient(String, ServiceAsClientIdentityProvider, String, String)
ConnectServiceAsClientAsync(IHpcContext, ServiceAsClientIdentityProvider, String, String)
ConnectServiceAsClientAsync(IHpcContext, ServiceAsClientIdentityProvider, String, String, ConnectMethod)
CreateCommand(String, ICommandInfo, IStringCollection)	Creates a command to execute.
CreateCommand(String, ICommandInfo, IStringCollection, Boolean)
CreateCommandInfo(INameValueCollection, String, String)	Creates an object that you can use to provide additional property values to a command.
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.
CreateNameValueCollection()	Creates an empty collection to which you can add name/value pairs.
CreateParametricTaskId(Int32, Int32)	Creates a task identifier that identifies an instance of parametric task.
CreatePool(String)
CreatePool(String, Int32)
CreateSortCollection()	Creates an empty collection to which you add sort properties.
CreateStringCollection()	Creates an empty collection to which you add string values.
CreateTaskId(Int32)	Creates a task identifier that identifies a task.
DeleteCachedCredentials(String)	Deletes the credentials that were cached for the specified user.
DeleteEmailCredentials()
DeletePool(String)
DeletePool(String, Boolean)
EnrollCertificate(String)
FinishJob(Int32, String, Boolean, Boolean)
GetActiveHeadNode()
GetCertificateFromStore(String, SecureString)
GetCounters()	Gets counter information for the cluster.
GetJobIdList(IFilterCollection, ISortCollection)	Retrieves a list of job identifiers based on the specified filters.
GetJobList(IFilterCollection, ISortCollection)	Retrieves a list of jobs based on the specified filters.
GetJobTemplateInfo(String)
GetJobTemplateList()	Retrieves a list of job template names defined in the cluster.
GetJobTemplateXml(String)
GetNodeGroupList()	Retrieves a list of node group names defined in the cluster.
GetNodeIdList(IFilterCollection, ISortCollection)	Retrieves a list of node identifiers based on the specified filters.
GetNodeList(IFilterCollection, ISortCollection)	Retrieves a list of nodes based on the specified filters.
GetNodesInNodeGroup(String)	Retrieves the list of nodes in the specified node group.
GetPoolList()
GetServerVersion()	Retrieves the file version of the HPC server assembly.
GetUserPrivilege()	Obsolete. Gets the privilege level of the user.
GetUserRoles()
OpenJob(Int32)	Retrieves the specified job from the scheduler.
OpenJobEnumerator(IPropertyIdCollection, IFilterCollection, ISortCollection)	Retrieves an enumerator that contains the jobs that match the filter criteria.
OpenJobHistoryEnumerator(IPropertyIdCollection, IFilterCollection, ISortCollection)	Retrieves an enumerator that contains the job history information for jobs that match the filter criteria.
OpenJobRowSet(IPropertyIdCollection, IFilterCollection, ISortCollection)	Retrieves a rowset that contains the jobs that match the filter criteria.
OpenNode(Int32)	Retrieves a node object using the specified node identifier.
OpenNodeByName(String)	Retrieves a node object using the specified node name.
OpenNodeEnumerator(IPropertyIdCollection, IFilterCollection, ISortCollection)	Retrieves a rowset enumerator that contains the nodes in the cluster that match the filter criteria.
OpenNodeHistoryEnumerator(IPropertyIdCollection, IFilterCollection, ISortCollection)	Retrieves an enumerator that contains the node history for the nodes in the cluster.
OpenPool(String)
OpenPoolRowSet(IPropertyIdCollection)
RequeueJob(Int32)
SetCachedCredentials(String, String)	Sets the credentials for the specified user in the credential cache, so that the job scheduler can use the credentials for submitting jobs.
SetCertificateCredentials(String, String)
SetCertificateCredentialsPfx(String, String, Byte[])
SetClusterParameter(String, String)	Sets a configuration parameter for the cluster.
SetEmailCredentials(String, String)
SetEnvironmentVariable(String, String)	Sets a cluster-wide environment variable.
SetInterfaceMode(Boolean, IntPtr)	Specifies whether the calling application is a console or Windows application.
SubmitJob(ISchedulerJob, String, String)	Adds a job to the scheduling queue using the job interface to identify the job.
SubmitJobById(Int32, String, String)	Adds the job to the scheduling queue using the job identifier to identify the job.
ValidateAzureUser(String, String)

Events

OnSchedulerReconnect