Export (0) Print
Expand All

ISubmissionFilter Interface

This interface defines the methods for implementing a custom job submission filter. The HPC Job Scheduler Service can call submission filters to provide additional checks and controls when jobs are submitted to the cluster. This type of filter is defined as a DLL (its methods are called directly by the HPC Job Scheduler Service), and is configured by the administrator at the job template level.


Namespace: Microsoft.Hpc.Scheduler.AddInFilter.HpcClient
Assembly: Microsoft.Hpc.Scheduler (in Microsoft.Hpc.Scheduler.dll)

'Usage
Dim instance As ISubmissionFilter

public interface ISubmissionFilter
public interface ISubmissionFilter
public interface ISubmissionFilter

The HPC Job Scheduler Service can run a submission filter when jobs are submitted to the cluster. The submission filter can check job properties against information of your choosing. The filter can also change job property values before jobs are added to the queue.

The filter must implement the FilterSubmission and the RevertSubmission methods. To validate a job that has just been submitted, the HPC Job Scheduler Service calls the FilterSubmission method. The return value from this method determines if the job will be rejected or added to the queue (after further validation). If the call to FilterSubmission returns JobFailed, then the HPC Job Scheduler Service calls RevertSubmission for all previously run filters in the chain.

The Microsoft HPC Pack 2008 R2 SP2 SDK code samples include an example submission filter (in the Scheduler/Filters/DLL folder).

The behavior of the HPC Job Scheduler Service is undefined when filters return directly by throwing an exception. To avoid this, use try/catch constructions and set a valid return response within the catch area if an exception is thrown.

All calls to filter methods are time bounded and are aborted if they exceed the allowed time. The time allowed for FilterSubmission and RevertSubmission is determined by the Submission Filter Timeout setting that the cluster administrator can configure in Job Scheduler options (the timeout for cluster-wide filters also applies to the job template filters).The default timeout is 15 seconds.

DLLs that contain more than one implementation of this interface are rejected by the HPC Job Scheduler Service.

Do not use the scheduler APIs to cancel a job from within a filter. This can cause the HPC Job Scheduler Service to stop responding. To cancel a job, the filter should return the FailJob filter response. This response value causes the HPC Job Scheduler Service to cancel the job and mark it as Failed.

DLL filters are only called if they are specified in the job template that is used for the job. For more information, see How to Add or Remove Job Template Level Submission or Activation Filters.

Platform Note: This class was introduced in Windows HPC Server 2008 R2 with Service Pack 2 (SP2) and is not supported in previous versions.


Development Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012

Target Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2003 R2, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, with HPC Pack Client Utilities




Build Date:

2013-04-22

Community Additions

ADD
Show:
© 2014 Microsoft