Scheduler Class

Reference

Definition

Namespace:: Microsoft.Hpc.Scheduler

Assembly:: Microsoft.Hpc.Scheduler.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("3C376723-5FF9-4C55-89BB-E9E7A31577E1")]
public class Scheduler : IDisposable, Microsoft.Hpc.Scheduler.IScheduler, Microsoft.Hpc.Scheduler.ISchedulerV2, Microsoft.Hpc.Scheduler.ISchedulerV3, Microsoft.Hpc.Scheduler.ISchedulerV3SP2, Microsoft.Hpc.Scheduler.ISchedulerV3SP3, Microsoft.Hpc.Scheduler.ISchedulerV3SP4, Microsoft.Hpc.Scheduler.ISchedulerV4, Microsoft.Hpc.Scheduler.ISchedulerV4SP1, Microsoft.Hpc.Scheduler.ISchedulerV4SP3

type Scheduler = class
    interface IScheduler
    interface IDisposable
    interface ISchedulerV2
    interface ISchedulerV3
    interface ISchedulerV3SP2
    interface ISchedulerV3SP3
    interface ISchedulerV3SP4
    interface ISchedulerV4
    interface ISchedulerV4SP1
    interface ISchedulerV4SP3

Public Class Scheduler
Implements IDisposable, IScheduler, ISchedulerV2, ISchedulerV3, ISchedulerV3SP2, ISchedulerV3SP3, ISchedulerV3SP4, ISchedulerV4, ISchedulerV4SP1, ISchedulerV4SP3

Inheritance: Object
Scheduler

Attributes: ClassInterfaceAttribute ComVisibleAttribute GuidAttribute

Implements: IScheduler ISchedulerV2 ISchedulerV3 ISchedulerV3SP2 ISchedulerV3SP3 ISchedulerV3SP4 ISchedulerV4 ISchedulerV4SP1 ISchedulerV4SP3 IDisposable

Constructors

Scheduler()	Initializes of new instance of the Scheduler class.
Scheduler(ISchedulerStore)	Initializes a new instance of this class using the specified store object.

Properties

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

Methods

AddJob(ISchedulerJob)	Adds the specified job to the cluster.
CancelJob(Int32, String)
CancelJob(Int32, String, Boolean)
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 a 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)
Dispose()	Releases resources used by this instance.
EnrollCertificate(String)
Finalize()
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

OnReconnect
OnSchedulerReconnect

Explicit Interface Implementations

ISchedulerV3SP3.OnSchedulerReconnect
ISchedulerV3SP4.OnSchedulerReconnect
ISchedulerV4.OnSchedulerReconnect
ISchedulerV4SP1.OnSchedulerReconnect

Applies to