ICluster.SetClusterParameter Method

Article
04/17/2009

Sets a configuration parameter for the cluster.

Namespace: Microsoft.ComputeCluster
Assembly: CcpAPI (in ccpapi.dll)

Usage

Syntax

'Declaration
Sub SetClusterParameter ( _
    name As String, _
    value As String _
)

void SetClusterParameter (
    string name,
    string value
)

void SetClusterParameter (
    String^ name, 
    String^ value
)

void SetClusterParameter (
    String name, 
    String value
)

function SetClusterParameter (
    name : String, 
    value : String
)

Parameters

name
The name of the parameter. The names are case-insensitive.

value
The value of the parameter.

Remarks

Only a user with administrator privileges can set the cluster's configuration parameters. The following are the supported configuration parameters.

Parameter	Description
ActivationFilterProgram	The absolute path to an application that determines whether a job should be run. This application is run for each job before the job is started. This application returns 0 if the job should be started and a nonzero value otherwise. It must accept a single command-line argument, which is an absolute path to an XML file that specifies the terms of the job. The job terms are an attribute of the Job element. The ExtendedTerms element contains the name/value pairs for application-defined extended job terms. For more information, see Job Schema.
ActivationFilterTimeout	Time-out value for the activation filter, in seconds. By default, the filter must complete in 15 seconds.
BackfillLookahead	Number of jobs that the scheduler searches to find jobs that can backfill (see IJob.IsBackfill) the jobs at the top of the queue. The following lists the possible values. If less than zero, search the entire job queue. If zero, do not backfill jobs. If greater than zero, the value is the number of jobs to search. The default is -1.
EventLogLevel	Sets the error log level. The log level can be one of the following values: Off Critical Error Warning Information Verbose ActivityTracing All For a description of these values see the SourceLevels enumeration in the System.Diagnostics namespace.
HeartbeatInterval	Interval for the scheduler to attempt to contact the node. The default interval is 60 seconds.
InactivityCount	Number of times the scheduler must attempt to contact a node before it can declare the node unreachable. The default number is 3.
JobRetryCount	Maximum number of times the system will rerun a job when a system error occurs (not when a job error occurs). The default number is 3. The job's status is set to Failed when the count is reached.
JobRuntime	Default run time for any job if not specified on the job. If not set on the job, the default is Infinite. The format is dd:hh:mm or Infinite. If the run time of the job exceeds this limit, the job is terminated and its status is set to Failed.
SpoolDir	An absolute path to the folder that will spool the output from the task run by the ICluster.ExecuteCommand method.
SubmissionFilterProgram	The absolute path to an application that determines whether a job should be submitted to the queue. This application is run for each job before the job is added to the scheduling queue. This application returns 0 if the job should be submitted and a nonzero value otherwise. It must accept a single command-line argument, which is an absolute path to an XML file that specifies the terms of the job. The job terms are an attribute of the Job element. The ExtendedTerms element contains the name/value pairs for application-defined extended job terms. For more information, see Job Schema.
SubmissionFilterTimeout	Time-out value for the submission filter, in seconds. By default, the filter must complete in 15 seconds.
TaskRetryCount	Maximum number of times the system will rerun a task when a system error occurs (not when a task error occurs). The default number is 3. The task's status is set to Failed when the count is reached.
TTLCompletedJobs	The minimum number of days that a completed job will be kept. A completed job is a job whose status is finished, canceled, or failed. The default interval is five days; this is the recommended minimum.

You can update CCP configuration parameters only; you cannot delete CCP parameters. The method validates the value for CCP parameters and fails if the value is out-of-range.

If you specify a parameter name that is not in the list, the method adds the parameter to the cluster. The cluster does not use the custom parameter but it is available for others to use. You can delete or update custom parameters. To delete custom parameters, set the value parameter to NULL.

To retrieve the current configuration values, access the ICluster.Parameters property.

The filter programs can be configured alternatively using the following registry keys:

HKLM\SYSTEM\CurrentControlSet\Services\CCPSchedSvc\Enum
      ActivationFilterProgram
      ActivationFilterTimeout
HKLM\SYSTEM\CurrentControlSet\Services\CCPSchedSvc\Enum
      SubmissionFilterProgram
      SubmissionFilterTimeout

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003, Windows XP

Target Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003 with Compute Cluster Pack Client Utilities, Windows XP with Compute Cluster Pack Client Utilities