cluscfg listparams

Article
08/06/2015

Applies To: Microsoft HPC Pack 2012, Microsoft HPC Pack 2012 R2

Displays the values of the cluster-wide parameters.

For examples of how to use this command, see Examples.

Syntax

cluscfg listparams [/scheduler:<name>]

cluscfg listparams {/? | /help}

Parameters

Parameter	Description
/scheduler:<name>	Specifies the host name or IP address of the head node for the cluster for which you want to list the values of the cluster-wide parameters. The value must be a valid computer name or IP address. If you do not specify the /scheduler parameter, this command uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies.
/?	Displays Help at the command prompt.
/help	Displays Help at the command prompt.

Remarks

The following table describes the available cluster-wide parameters.

ActivationFilterProgram

Specifies the path and file name of the activation filter program, if one exists. The activation filter program is called every time a job starts. You can use the activation filter program to delay the start of a job.

This parameter has no default value.

ActivationFilterTimeout

Specifies the number of seconds that the activation filter program can run before the HPC Job Scheduler Service cancels the activation filter program and starts the job.

The range of valid values is from 1 through 120.

The default value is 15.

AffinityType

Specifies a processor affinity setting that controls the association between tasks and cores. The following table describes the possible values for this parameter:

Value	Description
AllJobs	Directs the HPC Node Manager Service to set the processor affinity for any task to which an entire node is not allocated. This setting is the best choice for jobs such as parameter sweeps and service-oriented architecture (SOA) jobs, for which multiple instances of the application can run per node and for which you want these instances to be isolated from each other. This setting corresponds to the affinity behavior in HPC Pack 2008.
NoJobs	Directs the HPC Node Manager Service to never set the processor affinity on any task. This setting is an excellent choice if you are running MPI tasks and you want to be sure that you can use the –affinity option for the mpiexec command, even when jobs share nodes. This setting is also useful for applications that set their own processor affinity. This setting corresponds to the affinity behavior in Windows Compute Cluster Server 2003.
NonExclusiveJobs	Directs the HPC Node Manager Service to not set affinity on jobs that are marked as exclusive. This setting is the ideal choice for jobs that contain only one task, because this setting enables that task to take advantage of all cores on the nodes to which the task is assigned. Starting in HPC Pack 2008 with Service Pack 1 (SP1), this setting provided a new affinity setting behavior and became the default setting because it provided the generally preferred behavior for MPI tasks, which are most likely to be sensitive to affinity settings. When you use this setting, MPI tasks in exclusive jobs can take advantage of the –affinity option of the mpiexec command even if the task is not allocated an entire node.

Note

This parameter was introduced in HPC Pack 2008 with SP1 and is not supported in previous versions.

AllowNewUserConnections

Specifies whether the HPC Job Scheduler Service should allow users to connect to the HPC Job Scheduler Service to create and submit new jobs and tasks.

A True value indicates that the HPC Job Scheduler Service should allow users to connect to the HPC Job Scheduler Service to create and submit new jobs and tasks. The HPC Job Scheduler Service places the jobs in a queue and runs them in the order that is defined by the scheduling policy for the HPC cluster.

A False value indicates that the HPC Job Scheduler Service should allow only cluster administrators and system services that are running on the head node of the HPC cluster to connect to the HPC Job Scheduler Service, and it should not allow users without administrative credentials to connect to the HPC Job Scheduler Service. Use a setting of False when you are doing maintenance work for the cluster and you need to prevent users from accessing the HPC Job Scheduler Service and its database. For example, you would use a setting of False while you are backing up and restoring the database. This setting does not prevent cluster administrators from creating and submitting jobs and tasks.

The default value of this parameter is True.

When you upgrade an HPC cluster from HPC Pack 2008, the AllowNewUserConnections property for the cluster is initially set to False, and it automatically resets to True when the upgrade is complete.

Note

This parameter was introduced in HPC Pack 2008 R2.

AutomaticGrowthEnabled

Specifies whether to automatically add free resources to running jobs that still have additional tasks to run.

A value of True indicates that the HPC Job Scheduler Service should automatically add free resources to running jobs that still have additional tasks to run.

A value of False indicates that the HPC Job Scheduler Service should not automatically add free resources to running jobs that still have additional tasks to run.

The default value is True.

AutomaticShrinkEnabled

Specifies whether to automatically remove unneeded resources from running jobs that have no additional tasks to run.

A value of True indicates that the HPC Job Scheduler Service should automatically remove unneeded resources from running jobs that have no additional tasks to run.

A value of False indicates that the HPC Job Scheduler Service should not automatically remove unneeded resources from running jobs that have no additional tasks to run.

The default value is True.

AzureLogsToblob

Specifies whether to turn on or off the transfer of trace log files from Windows Azure worker nodes or proxy nodes to a container in blob storage (hpclogs) in the Windows Azure storage account for each node deployment. The following table describes the possible values for this parameter.

Value	Description
Disabled	No log files are transferred to blob storage (default)
Proxy	Only log files from the proxy nodes in the deployment are transferred to blob storage
Compute	Only log files from the worker nodes in the deployment are transferred to blob storage
All	Log files from the proxy nodes and the worker nodes in the deployment are transferred to blob storage

Important

Saving Windows Azure deployment log files in blob storage uses storage space and generates storage transactions on the storage account associated with each deployment. If enabled, saving log files from worker nodes can affect the performance of all Windows Azure deployments that use the same storage account.

For more information about logging for Windows Azure nodes, see https://go.microsoft.com/fwlink/p/?LinkId=273926.

Note

This parameter was introduced in HPC Pack 2012 with Service Pack 1 (SP1). It is not supported in previous versions.

AzureLogsToBlobInterval

Specifies the interval in minutes between successive uploads of trace log files from Windows Azure nodes to Windows Azure blob storage, when transfer of logs is enabled by the AzureLogsToBlob parameter. Valid values for this parameter are in the range 1 – 10 minutes.

The default value is 5.

Modify this parameter only with the assistance of Microsoft Support.

Note

This parameter was introduced in HPC Pack 2012 with Service Pack 1 (SP1). It is not supported in previous versions.

AzureLogsToBlobThrottling

Specifies a maximum percentage of the network bandwidth of a Windows Azure node to allow for transfer of trace log files from Windows Azure nodes to Windows Azure blob storage, when transfer of logs is enabled by the AzureLogsToBlob parameter. Valid values for this parameter are in the range 1 – 1000, corresponding to 0.1% to 100% of the available network bandwidth.

The default value is 1.

Modify this parameter only with the assistance of Microsoft Support.

Note

This parameter was introduced in HPC Pack 2012 with Service Pack 1 (SP1). It is not supported in previous versions.

BackfillLoadPeriod

Specifies the time in seconds that the HPC Job Scheduler Service searches the job queue to find jobs that can backfill the jobs at the top of the job queue. The maximum number of jobs found is specified by the BackfillLookAhead parameter.

The minimum value is 15.

The default value is 30.

Note

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 3 (SP3). It is not supported in previous versions.

BackfillLookAhead

Specifies the number of jobs that the HPC Job Scheduler Service searches to find jobs that can backfill the jobs at the top of the job queue.

A value of 0 indicates that the HPC Job Scheduler Service should not backfill the jobs at the top of the job queue.

A negative value indicates that the HPC Job Scheduler Service should search though the entire job queue to find jobs that can backfill the jobs at the top of the job queue.

The default value is 1000.

BrokerTaskProgram

Specifies the command that the HPC Job Scheduler Service runs to start a broker task. By changing this value, you can replace the Windows Communication Foundation (WCF) Broker that HPC Pack includes with a custom WCF Broker.

The default value is %CCP_HOME%bin\HpcWcfBroker.exe.

Note

This parameter was introduced in HPC Pack 2008.

DefaultHoldDuration

Specifies the default amount of time in seconds before the HPC Job Scheduler Service reevaluates jobs that are placed on hold by an activation filter program.

The default value is 900 seconds, which equals 15 minutes.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

DisableCredentialReuse

Specifies whether the HPC Job Scheduler Service is enabled to cache the credentials that are used to submit a job.

A value of True indicates that the HPC Job Scheduler Service cannot cache the credentials.

A value of False indicates that the HPC Job Scheduler Service can cache credentials. If caching is enabled, a prompt to cache the password appears after new credentials are supplied to submit a job.

Note

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 3 (SP3) and is not supported in previous versions.

EmailNotificationEnabled

Specifies whether the HPC Job Scheduler Service should send email notifications about jobs when job owners specify that they want to receive such notifications.

A True value indicates that the HPC Job Scheduler Service should send email notifications about jobs. A False value indicates that the HPC Job Scheduler Service should not send email notifications about jobs.

The default value is False.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

EmailSmtpServer

Specifies the name or IP address of the Simple Mail Transfer Protocol (SMTP) server that the HPC Job Scheduler Service should use to send email notifications, if email notifications are enabled.

This parameter has no default value.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

EmailFromAddress

Specifies the email address to use on the From line for email notifications.

This parameter has no default value.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

EmailUseSsl

Specifies whether the SMTP server that the HPC Job Scheduler Service uses to send email notifications requires a secure connection. A True value indicates that the SMTP server requires a secure connection. A False value indicates that the SMTP server does not require a secure connection.

The default value is False.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

EnablePools

Specifies whether resource pools are enabled on the HPC Job Scheduler Service. A value of True indicates that resource pools are enabled. A value of False disables resource pools.

The default value is False.

Note

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2) and is not supported in previous versions.

ExcludedNodesLimit

Specifies the maximum number of nodes that you can add to the list of nodes on which a job should not run. For SOA jobs, the broker cancels sessions that try to exclude a greater number of nodes than are specified by this setting. For other types of jobs, an error occurs if you try to add a greater number of nodes than are specified by this setting to the list of nodes on which a job should not run.

The default value is 10.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

GrowByPreemptionEnabled

Specifies whether the HPC Job Scheduler Service is enabled to take resources from lower priority, running jobs to add resources to higher priority, running jobs. A value of True indicates that task-level preemption is enabled. A value of False indicates that task-level preemption is not enabled.

The default value is True.

Note

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2) and is not supported in previous versions.

HeartbeatInterval

Specifies how often the HPC Job Scheduler Service sends health probes to the HPC Node Manager Service to confirm that the nodes in the HPC cluster are still reachable. This interval is specified in seconds.

The default value is 30.

HpcSoftCard

Specifies the HPC soft card policy on the HPC Job Scheduler service. By default, the HpcSoftCard cluster property is set to Disabled. If you want users to always use soft card authentication, set the property to Required. If you want users to select between a password and a soft card to log on, set the property to Allowed.

Note

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2) and is not supported in previous versions.

HpcSoftCardTemplate

Specifies the name of the certificate template that will be used to create new HPC soft cards for the cluster. When users want to access the cluster, they can generate a soft card credential that is based on this template by running New-HpcSoftCard.

Note

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2) and is not supported in previous versions.

InactivityCount

Specifies the number of heartbeats a compute node can miss before the HPC Job Scheduler Service declares the node unreachable. A compute node misses a heartbeat if there is no reply from the health probes.

The default value is 3.

Note

In versions of HPC Pack prior to HPC Pack 2012 with Service Pack 1 (SP1), the InactivtyCount parameter applies to both on-premises compute nodes and Windows Azure nodes. Starting with HPC Pack 2012 with SP1, the InactivityCount parameter applies only to on-premises compute nodes. Use the InactivityCountAzure parameter to specify the number of missed heartbeats for Windows Azure nodes.

InactivityCountAzure

Specifies the number of heartbeats a Windows Azure node can miss before the job scheduler declares the node unreachable. A Windows Azure node misses a heartbeat if there is no reply from the health probes.

The default value is 10.

Note

This parameter was introduced in HPC Pack 2012 with Service Pack 1 (SP1) and is not supported in previous versions.

JobCleanupHour

Specifies the hour of the day in 24-hour time at which the HPC Job Scheduler Service should delete old job records from the database. For example, a value of 23 causes the HPC Job Scheduler Service to delete job records that are older than the number of days that the TTLCompletedJobs property specifies at 11:00 PM each day.

The possible values of this parameter are from 0 through 23.

The default value is 2.

JobRetryCount

Specifies the maximum number of times that the HPC JobScheduler Service automatically tries to rerun a job before marking the job as Failed.

The value range for this parameter is from 0 through 2,147,483,647.

The default value is 3.

NettcpOver443

Specifies whether the HPC Job Scheduler Service communicates with a Windows Azure node deployment by using a NetTcp binding on port 443. A value of True indicates that a NetTcp binding on port 443 is enabled. A value of False indicates that the communication uses the HTTPS protocol on port 443.

The default value is True.

Note

This parameter was introduced in HPC Pack 2012 and is not supported in previous versions.

NodeReleaseTaskTimeout

Specifies the maximum run time in seconds for Node Release tasks.

Node Release tasks run even when a job is canceled. A cluster administrator or the job owner can force a job that is being canceled to skip the Node Release task.

The value for this parameter cannot be negative. The default value is 15.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

PreemptionBalancedMode

Specifies the type of preemption that the HPC Job Scheduler Service applies when the SchedulingMode property is set to Balanced. The following table describes the possible values for this parameter.

Value	Description
Graceful	Indicates that resources are taken away from jobs that are running as the tasks that are running for those jobs complete. This is an advanced setting.
Immediate	Indicates that resources are taken away from jobs by canceling running tasks and requeuing them.

The default value is Immediate, which is recommended for most workloads.

Note

This parameter was introduced in HPC Pack 2012 with Service Pack 1 (SP1) and is not supported in previous versions. In previous versions, in Balanced mode, preemption is always Immediate.

PreemptionType

Specifies the type of preemption that the HPC Job Scheduler Service applies when the SchedulingMode property is set to Queued. The following table describes the possible values for this parameter.

Value	Description
Graceful	Indicates that queued job will take resources away from lower priority jobs that are running as the tasks that are running for those jobs complete.
Immediate	Indicates that the HPC Job Scheduler Service automatically cancels running jobs when a job with a higher priority is waiting in the queue.
None	Indicates that preemption is turned off. Jobs that are running will continue to run until they complete, and higher priority jobs in the queue must wait for the lower priority jobs to complete before they can begin to run.

The default value is Graceful.

PriorityBias

Specifies how additional resources are allocated to jobs when the SchedulingMode property is set to Balanced. In the Balanced scheduling mode, additional resources are the cluster resources that exceed the total minimum resources for all running jobs. In the Queued scheduling mode, the PriorityBias property has no effect.

The following table describes the possible values for this parameter.

Value	Description
HighBias	Specifies that a job receives ten times the share of the additional resources as a job that is a full priority range below. A full priority range is a difference of 1000 in the priority values for the jobs. For jobs that have priorities that differ by less than a full priority range, the difference in the share of additional resources allocated to the jobs is scaled appropriately.
MediumBias	Specifies that a job receives twice the additional resources as a job that is a full priority range below. A full priority range is a difference of 1000 in the priority values for the jobs. For jobs that have priorities that differ by less than a full priority range, the difference in the share of additional resources allocated to the jobs is scaled appropriately.
NoBias	Specifies that the additional resources are allocated equally across the job queue.

The default value is MediumBias.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

ReBalancingInterval

Specifies the amount time in seconds between successive operations that the HPC Job Scheduler Service performs to rebalance the allocation of resources in the Balanced scheduling mode. The HPC Job Scheduler Service adds or removes resources from job during these operations to start new jobs, fill available resources, and balance resource allocation based on the setting of the PriorityBias property.

The default value is 10.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

SchedulingMode

Specifies how to optimize resource allocation for large batch and Message Passing Interface (MPI) workloads or for service workloads.

The following table describes the possible values for this parameter:

Balanced

Specifies that the HPC Job Scheduler Service should attempt to start all incoming jobs as soon as possible at their minimum resource requirements. After all the jobs in the queue have their minimum resources, the HPC Job Scheduler Service should allocate additional cluster resources to jobs based on their priority. The HPC Job Scheduler Service periodically rebalances resource allocation to fill idle resources, start new jobs, and adjust allocation according the PriorityBias setting.

In the Balanced scheduling mode, the PreemptionType, AutomaticGrowthEnabled, and AutomaticShrinkEnabled settings have no effect.

Queued

Specifies that the HPC Job Scheduler Service should start jobs in queue order, and attempt to allocate the maximum requested resources to running jobs.

In the Queued scheduling mode, the PriorityBias and RebalancingInterval settings have no effect.

The default value is Queued.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

ServiceTaskProgram

Specifies the command that the HPC Job Scheduler Service runs to start a Windows Communication Foundation (WCF) service task on the compute nodes. By changing this value, you can replace the WCF service host that the Microsoft® HPC Pack includes with a custom WCF service host.

The default value is %CCP_HOME%bin\HpcWcfServiceHost.exe.

Note

This parameter was introduced in HPC Pack 2008.

SoftCardExpirationWarning

Specifies the number of days until the soft card certificate expiration date. If the expiration date is equal to or less than the specified number of days, HPC soft card users will receive a warning that their certificate is about to expire.

The default value is 5.

Note

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2) and is not supported in previous versions.

SpoolDir

Starting in Microsoft® HPC Pack 2008, the SpoolDir parameter is no longer used.

The directory in which the clusrun command temporarily stored output for Microsoft Compute Cluster Pack. The default value is \\<head_node>\CcpSpoolDir.

SubmissionFilterProgram

Specifies the file name and path for the submission filter program, if one exists. The submission filter program runs every time a job is submitted. You can use the submission filter program to reject or change jobs that users submit to the job scheduler.

This parameter has no default value.

SubmissionFilterTimeout

Specifies the number of seconds that the submission filter program can run before the HPC Job Scheduler Service cancels the submission filter program and rejects the job.

The range of valid values is from 1 through 120.

The default value is 15.

TaskCancelGracePeriod

Specifies the amount of time in seconds that the HPC Node Manager Service should allow applications to use to exit gracefully.

Starting in HPC Pack 2008 R2, the HPC Node Manager Service stops a running task by sending a CTRL+BREAK signal to the application. To make use of the grace period for task cancelation, the application must include code to handle the CTRL+BREAK event. If the application does not respond to the CTRL+BREAK event, it exits immediately. For an SOA service to use the grace period, it must respond to the ServiceContext.OnExiting event.

The default value is 15.

Note

This parameter was introduced in HPC Pack 2008 R2 and is not supported in previous versions.

TaskImmediatePreemptionEnabled

Specifies whether the HPC Job Scheduler Service is enabled to cancel a task in a job to allow a higher priority job in the queue to start. Unlike the job-level preemption that is configured with the PreemptionType parameter, which cancels the lower priority job and requeues it, task-level preemption can allow a job to continue running even if some of its tasks are preempted on some cluster resources.

A value of True indicates that task-level preemption is enabled. A value of False indicates that task-level preemption is not enabled.

The default value is True.

Note

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 3 (SP3) and is not supported in previous versions.

TaskRetryCount

Specifies the maximum number of times that the HPC Job Scheduler Service automatically tries to rerun a task before marking the task as Failed.

The default value is 3.

TtlCompletedJobs

Specifies the number of days that the records for completed jobs will remain in the SQL database before the HPC Job Scheduler Service deletes the records. A completed job is a job in the Finished, Failed, or Canceled state.

The default value is 5.

Examples

To display the values of the cluster-wide environment parameters on the HPC cluster with a head node named HEADNODE, use the following command:

cluscfg listparams /scheduler:HEADNODE

Share via

cluscfg listparams

Syntax

Parameters

Remarks

Examples

Additional references

Additional resources