ICluster::SetClusterParameter method
Sets a configuration parameter for the cluster.
Syntax
HRESULT SetClusterParameter(
[in] BSTR Name,
[in] BSTR Value
);
Parameters
Name [in]
The name of the parameter. The names are case-insensitive.Value [in]
The value of the parameter.
Return value
If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code. To get a description of the error, call the ICluster::get_ErrorMessage method.
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 the jobs at the top of the queue. The following lists the possible values.
The default is –1. |
| EventLogLevel | Sets the error log level. The log level can be one of the following values:
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 ICluster::ExecuteCommand. |
| 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 user-defined parameter but it is available for others to use. You can delete or update user-defined parameters. To delete user-defined parameters, set the Value parameter to NULL or an empty string. (Note that setting a CCP-defined parameter to an empty string will not delete the parameter.)
To retrieve the current configuration values, call the ICluster::get_Parameters method.
The filter programs can be configured alternatively using the following registry keys:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\CCPSchedSvc\Enum
ActivationFilterProgram
ActivationFilterTimeout
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\CCPSchedSvc\Enum
SubmissionFilterProgram
SubmissionFilterTimeout
Requirements
Product |
Compute Cluster Pack Client Utilities |
Type library |
Ccpapi.tlb |