Detailed Description

Sets the specified cluster-wide properties. Cluster-wide properties include parameters, environment variables, installation credentials, credentials to use for sending email notifications, the naming series for new compute nodes, and the Windows Deployment Services mode.

Parameters

-ActivationFilterProgram<String>

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.

You cannot specify both the ActivationFilterProgram parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ActivationFilterTimeout<Int32>

Specifies the number of seconds that the activation filter program can run before the job scheduler cancels the activation filter program and starts the job. The range of valid values is from 1 to 120.

You cannot specify both the ActivationFilterTimeout parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

15

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AffinityType<AffinityMode>

Specifies a processor affinity setting that controls the association between tasks and cores.

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

Aliases

none

Required?

false

Position?

named

Default Value

NonExclusiveJobs

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AllocationHistoryTtl<Int32>

Specifies the number of days that the HPCReporting database should store information about the allocation of jobs to nodes.

If you specify the AllocationHistoryTtl parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

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

Aliases

none

Required?

false

Position?

named

Default Value

5

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AllowNewUserConnections<Boolean>

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 nonzero value or $true 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 defined by the scheduling policy for the HPC cluster.

A value of 0 or $false 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 administrator privileges 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.

When you upgrade an HPC cluster , the AllowNewUserConnections property for the cluster is initially set to $false, and it automatically resets to $true when the upgrade is complete.

You cannot specify both the AllowNewUserConnections parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

$true

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutomaticGrowthEnabled<Boolean>

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

A non-zero value or $true indicates that the job scheduler should automatically add free resources to running jobs that still have additional tasks to run.

A value of 0 or $false indicates that the job scheduler should not automatically add free resources to running jobs that still have additional tasks to run.

You cannot specify both the AutomaticGrowthEnabled parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

$true

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutomaticShrinkEnabled<Boolean>

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

A non-zero value or $true indicates that the job scheduler should automatically remove unneeded resources from running jobs that have no additional tasks to run.

A value of 0 or $false indicates that the job scheduler should not automatically remove unneeded resources from running jobs that have no additional tasks to run.

You cannot specify both the AutomaticShrinkEnabled parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

$true

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AzureCollectionInterval<Int32>

Specifies the amount of time in seconds that should elapse between successive attempts to get values for the counters from Windows Azure nodes. The possible values you can specify are from 0 through 30. If you specify 0, attempts to get values for the counters from Windows Azure nodes occur at 60 second intervals.

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

Aliases

none

Required?

false

Position?

named

Default Value

20

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AzureLoggingEnabled<Boolean>

Specifies whether to turn on or off the collection of trace log data from Windows Azure nodes. If collection of data is enabled, the trace logs for all Windows Azure nodes that are deployed are written to the WADLogsTable table in the Windows Azure storage account for each node deployment. Only Critical, Error, and Warning error messages in the trace logs are collected.

A non-zero or $true value turns on the collection of trace log data. A value of 0 or $false turns off the collection of trace log data. Changing this parameter only affects collection of data for future Windows Azure node deployments. The current deployments are not affected.

Important: Collection of log data for Windows Azure deployment activities uses table storage space and generates storage transactions on the storage account associated with each deployment. The storage space and the storage transactions will be billed to your account. Data collection is generally enabled only when problems occur with the deployment and is used to aid in troubleshooting issues with the deployment. After you disable data collection, the logs will not be automatically removed from Windows Azure storage. You may want to keep the logs for future reference by downloading them. The log entries can be cleaned up by removing the WADLogsTable from your storage account.

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

Aliases

none

Required?

false

Position?

named

Default Value

$false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AzureLogsToBlob<LogMode>

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. Valid values for this parameter are:

Disabled No log files are transferred to blob storage (default)

Proxy Only log files from the proxy nodes in with 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

Changing this parameter only affects transfer of trace logs for future Windows Azure node deployments. The current deployments are not affected.

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, especially if you have large deployments, or several concurrent deployments. The storage space and the storage transactions will be billed to your account. After you disable transfer of log files, the log files will not be automatically removed from Windows Azure storage. You may want to keep the log files for future reference by downloading them. The log files can be cleaned up by removing the hpclogs container from your storage account.

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

Aliases

none

Required?

false

Position?

named

Default Value

Disabled

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AzureLogsToBlobInterval<Int32>

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.

Modify this parameter only with the assistance of Microsoft Support.

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

Aliases

none

Required?

false

Position?

named

Default Value

1

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AzureLogsToBlobThrottling<Int32>

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.

Modify this parameter only with the assistance of Microsoft Support.

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

Aliases

none

Required?

false

Position?

named

Default Value

1

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AzureMetricsCollectionEnabled<Boolean>

Specifies whether to collect on the cluster head node and upload to Microsoft certain metrics about the availability, connectivity, and performance of your Windows Azure node deployments. For more information about the collection of these metrics, see the Microsoft HPC Pack Privacy Statement.

A non-zero or $true value turns on the collection of metrics for Windows Azure node deployments. A value of 0 or $false turns off the collection of metrics for Windows Azure node deployments. Changing this parameter only affects collection of metrics for future Windows Azure node deployments. The current deployments are not affected.

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

Aliases

none

Required?

false

Position?

named

Default Value

$false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AzureMetricsJobStatisticsDelayMinutes<Int32>

Specifies an offset in minutes for inclusion of job history information in the metrics that are collected from Windows Azure nodes, when metrics collection is enabled by the AzureMetricsCollectionEnabled parameter. Jobs that run on Windows Azure nodes in the last interval specified by this parameter are not represented in aggregate statistics.

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

Aliases

none

Required?

false

Position?

named

Default Value

3

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AzureStorageConnectionString<String>

Specifies a Windows Azure storage connection string to enable the use of common data and service-oriented architecture (SOA) session monitoring when running SOA jobs on Windows Azure nodes. For configuration details, see Configuring Connection Strings.

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BackfillLoadPeriod<Int32>

Specifies the time in seconds that the job scheduler searches the job queue to find jobs that can backfill the jobs at the top of the job queue.

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

Aliases

none

Required?

false

Position?

named

Default Value

30

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BackfillLookAhead<Int32>

Specifies the number of jobs that the job scheduler searches to find jobs that can backfill the jobs at the top of the job queue.

A value of 0 indicates that the job scheduler should not backfill the jobs at the top of the job queue.

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

You cannot specify both the BackfillLookAhead parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

1000

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CollectCounters<Boolean>

Specifies whether to turn the collection of performance counter data on or off. If you turn off the collection of performance counter data, the heat maps and charts will not show any data from the moment you turn off data collection, and the Get-HpcMetricValue cmdlet will not show any performance counter values.

A non-zero or $true value turns the collection of performance counter data on. A value of 0 or false turns the collection of performance counter data off.

If you specify the CollectCounters parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

Aliases

none

Required?

false

Position?

named

Default Value

$true

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConcurrencyTestRunNumber<String>

Specifies the maximum number of diagnostic tests that the HPC cluster can run simultaneously. Specify 0 to allow an unlimited number of diagnostic tests to run simultaneously.

You cannot specify both the ConcurrencyTestRunNumber parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

5

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DataExtensibilityEnabled<Boolean>

Specifies whether the cluster stores information for custom reporting about jobs, nodes, and the allocation of jobs to nodes.

A nonzero value or $true indicates that the cluster stores information for custom reporting about jobs, nodes, and the allocation of jobs to nodes. A value of 0 or $false indicates that the cluster does not store this information.

If you specify the DataExtensibilityEnabled parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

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

Aliases

none

Required?

false

Position?

named

Default Value

$true

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DataExtensibilityTtl<Int32>

Specifies the number of days that the HPCReporting database should store all of the information about jobs and nodes except for the allocation of jobs to nodes.

If you specify the DataExtensibilityTtl parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

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

Aliases

none

Required?

false

Position?

named

Default Value

365

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DayCounterRetention<Int32>

Specifies how often data for the day performance counters gets deleted from the database, in days. For example, if the value is 180, the data for the day performance counters is deleted every 180 days.

If you specify the DayCounterRetention parameter, the additional parameters that you can specify are HourCounterRetention, MinuteCounterRetention, Scheduler, and the common parameters.If you specify the DayCounterRetention parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

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

Aliases

none

Required?

false

Position?

named

Default Value

180

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DefaultHoldDuration<Int32>

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.

You cannot specify both the DefaultHoldDuration parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

900

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DisableCredentialReuse<Boolean>

Specifies whether the HPC Job Scheduler Service is enabled to cache the credentials that are used to submit a job. A nonzero value or $true indicates that the job scheduler cannot cache the credentials. A value of 0 or $false indicates that the job scheduler can cache credentials. If caching is enabled, a prompt to cache the password appears after new credentials are supplied to submit a job.

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

Aliases

none

Required?

false

Position?

named

Default Value

$false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EmailCredential<PSCredential>

Specifies the user account that the HPC cluster uses to send email notifications, if the email server requires credentials. The account must have administrative permissions on the head node.

If you specify the EmailCredential parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

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

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EmailFromAddress<String>

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

You cannot specify both the EmailFromAddress parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EmailNotificationEnabled<Boolean>

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 nonzero value or $true indicates that the HPC Job Scheduler Service should send email notifications about jobs. A value of 0 or $false indicates that the HPC Job Scheduler Service should not send email notifications about jobs.

You cannot specify both the EmailNotificationEnabled parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

$false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EmailSmtpServer<String>

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.

You cannot specify both the EmailSmtpServer parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EmailUseSsl<Boolean>

Specifies whether the SMTP server that the HPC Job Scheduler Service uses to send email notifications requires a secure connection. A nonzero value or $true indicates that the SMTP server requires a secure connection. A value of 0 or $false indicates that the SMTP server does not require a secure connection.

You cannot specify both the EmailUseSsl parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

$false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnablePools<Boolean>

Specifies whether resource pools are enabled on the HPC Job Scheduler Service. A nonzero value or $true indicates that resource pools are enabled. A value of 0 or $false disables resource pools.

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Environment<String[]>

Sets cluster-wide environment variables in the environments on all of the compute nodes so that applications that run on the HPC cluster can use the environment variables. Specify the environment variables that you want to set and their values in the following format:

"name1=value1"[,"name2=value2"[,"name3=value3"...]

To delete an environment variable, omit the value for the variable. For example, "name1=","name2=20" deletes the environment variable named name1 and sets the environment variable named name2 to 20.

If you specify the Environment parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

Aliases

none

Required?

true

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ExcludedNodesLimit<Int32>

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.

You cannot specify both the ExcludedNodesLimit parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

10

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-GrowByPreemptionEnabled<Boolean>

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 nonzero value or $true indicates that task-level preemption is enabled. A value of 0 or $false indicates that task-level preemption is not enabled.

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

Aliases

none

Required?

false

Position?

named

Default Value

$true

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HeartbeatInterval<Int32>

Specifies how often the job scheduler 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.

You cannot specify both the HeartbeatInterval parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

30

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HourCounterRetention<Int32>

Specifies how often data for the hour performance counters gets deleted from the database, in days. For example, if the value is 30, the data for the hour performance counters is deleted every 30 days.

If you specify the HourCounterRetention parameter, the additional parameters that you can specify are MinuteCounterRetention, DayCounterRetention, Scheduler, and the common parameters.

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

Aliases

none

Required?

false

Position?

named

Default Value

30

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HpcSoftCard<HpcSoftCardPolicy>

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.

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HpcSoftCardTemplate<String>

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.

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InactivityCount<Int32>

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

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. The InactivityCountAzure parameter is introduced to configure Windows Azure nodes separately.

You cannot specify both the InactivityCount parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

3

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InactivityCountAzure<Int32>

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.

You cannot specify both the InactivityCount parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

10

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InstallCredential<PSCredential>

Specifies a PSCredential object for the credentials to use to install compute nodes and run diagnostic tests. Use the Get-Credential cmdlet to get a PSCredential object. Alternatively, you can specify a user in the domain\user_name format, and then the Set-HpcClusterProperty cmdlet prompts you for a password.

If you specify the InstallCredential parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobCleanUpHour<Int32>

Specifies the hour of the day in 24-hour time at which the job scheduler should delete old job records from the database. For example, a value of 23 causes the job scheduler to delete job records that are older than the number of days that the TTLCompletedJobs property specifies at 11:00 PM each day. The value of this parameter must be between 0 and 23.

You cannot specify both the JobCleanupHour parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

2

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobRetryCount<Int32>

Specifies the maximum number of times that the job scheduler automatically tries to rerun a job before marking the job as failed. The value range for this parameter is from 0 to 2,147,483,647.

You cannot specify both the JobRetryCount parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

3

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MinuteCounterRetention<Int32>

Specifies how often data for the minute performance counters gets deleted from the database, in days. For example, if the value is 3, the data for the minute performance counters is deleted every three days.

If you specify the MinuteCounterRetention parameter, the additional parameters that you can specify are HourCounterRetention, DayCounterRetention, Scheduler, and the common parameters.

Aliases

none

Required?

false

Position?

named

Default Value

3

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NettcpOver443<Boolean>

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

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

Aliases

none

Required?

false

Position?

named

Default Value

$true

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NodeNamingSeries<String>

Specifies the naming series to use to generate names for new compute nodes. The format of the naming series should consist of alphabetic characters and a number between percent characters (%), such as MyCluster%1000%. The maximum length of the string for the naming series is 17 characters.

The name for the first compute node will be the string for the naming series without the percent characters; for example, MyCluster1000. The names for subsequent compute nodes increment the numeric portion of the name by one for each new node, until the highest number with the same number of digits that the naming series that you specified is reached; for example, MyCluster1001, MyCluster1002, MyCluster1003,...MyCluster9999.

If you specify the NodeNamingSeries parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NodeReleaseTaskTimeout<Int32>

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.

You cannot specify both the NodeReleaseTaskTimeout parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

15

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PreemptionBalancedMode<PreemptionMode>

Specifies the type of preemption that the job scheduler applies when the SchedulingMode property is set to Balanced.

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

Aliases

none

Required?

false

Position?

named

Default Value

Immediate

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PreemptionType<PreemptionMode>

Specifies the type of preemption that the job scheduler applies when the SchedulingMode property is set to Queued.

You cannot specify both the PreemptionType parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

Graceful

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PriorityBias<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 setting has no effect.

You cannot specify both the PriorityBias parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

MediumBias

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReBalancingInterval<Int32>

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.

You cannot specify both the ReBalancingInterval parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

10

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RestoreMode

Specifies whether the HPC Job Scheduler Service is in restore mode. The HPC Job Scheduler Service restore mode helps bring the cluster to a consistent state in the case that you are performing a database or system restore.

A nonzero value or $true will set the HPC Job Scheduler Service in restore mode. A value of 0 or $false will turn restore mode on the HPC Job Scheduler Service off.

This parameter defaults to true, if no value is specified.

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunCleanUpHour<String>

Specifies the hour of the day in 24-hour time at which the HPC Diagnostics Service should delete old records for diagnostic test runs from the database. For example, a value of 23 causes the HPC Diagnostics Service to delete records for test runs that are older than the number of days that the TtlCompletedRuns property specifies at 11:00 PM each day. The value of this parameter must be between 0 and 23.

You cannot specify both the RunCleanupHour parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

3

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster for which you want to set the properties. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>

Aliases

none

Required?

false

Position?

named

Default Value

%CCP_SCHEDULER%

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SchedulingMode<SchedulingMode>

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

You cannot specify both the SchedulingMode parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

Queued

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SoftCardExpirationWarning<Int32>

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.

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

Aliases

none

Required?

false

Position?

named

Default Value

5

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SubmissionFilterProgram<String>

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.

You cannot specify both the SubmissionFilterProgram parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SubmissionFilterTimeout<Int32>

Specifies the number of seconds that the submission filter program can run before the job scheduler cancels the submission filter program and rejects the job. The range of valid values is from 1 to 120.

You cannot specify both the SubmissionFilterTimeout parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

15

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskCancelGracePeriod<Int32>

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

In Microsoft HPC Pack, 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.

You cannot specify both the TaskCancelGracePeriod parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

15

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskImmediatePreemptionEnabled<Boolean>

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 nonzero value or $true indicates that task-level preemption is enabled. A value of 0 or $false indicates that task-level preemption is not enabled.

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

Aliases

none

Required?

false

Position?

named

Default Value

$true

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskRetryCount<Int32>

Specifies the maximum number of times that the job scheduler automatically tries to rerun a task before marking the task as failed.

You cannot specify both the TaskRetryCount parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

3

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TtlCompletedJobs<Int32>

Specifies the number of days that information about completed jobs remains in the SQL database before the job scheduler deletes the records. A completed job is a job in the Finished, Failed, or Canceled state.

You cannot specify both the TtlCompletedJobs parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

Aliases

none

Required?

false

Position?

named

Default Value

5

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TtlCompletedRuns<String>

Specifies the number of days that information about completed diagnostic test runs remains in the SQL database before the HPC Diagnostics Service deletes the records. A completed diagnostic test run is a test run with a state other than running.

You cannot specify both the TtlCompletedRuns parameter and any of the following parameters: AllocationHistoryTtl, CollectCounters, DataExtensibilityEnabled, DataExtensibilityTtl, EmailCredential, Environment, InstallCredential, MinuteCounterRetention, HourCounterRetention, DayCounterRetention, NodeNamingSeries, or WDSMode.

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

Aliases

none

Required?

false

Position?

named

Default Value

5

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WDSMode<WdsMode>

Specifies the value of the setting that indicates whether Windows Deployment Services on the head node responds to all Pre-Boot Execution Environment (PXE) requests, or only to the requests that come from existing compute nodes.

If you specify the WDSMode parameter, the only additional parameters that you can specify are the Scheduler parameter and the common parameters.

Aliases

none

Required?

false

Position?

named

Default Value

IgnoreUnknown

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

None

Outputs

The output type is the type of the objects that the cmdlet emits.

None

Notes

You must be a cluster administrator to run this cmdlet successfully.

The BrokerTaskProgram and ServiceTaskProgram parameters for this cmdlet were removed in HPC Pack 2008 R2.

Examples

EXAMPLE 1

Sets the credential that is used to install compute nodes and run diagnostics tasks.

PS C:\>Set-HpcClusterProperty -InstallCredential CONTOSO\someone

EXAMPLE 2

Sets the naming series that is used to name new compute nodes added to the HPC cluster in the future. The naming series in this example generates compute node names like MyCluster1000, MyCluster1001, and so on.

PS C:\>Set-HpcClusterProperty -NodeNamingSeries "MyCluster%1000%"

EXAMPLE 3

Sets a cluster-wide environment variable named CCP_CLUSTER_NAME to mycluster.

EXAMPLE 4

Sets a cluster-wide parameter named HeartbeatInterval to 40. This value means that the job scheduler will send a health probe to the HPC Node Manager Service every 40 seconds.

PS C:\>Set-HpcClusterProperty -HeartbeatInterval 40

EXAMPLE 5

Sets the cluster-wide parameters named TtlCompletedRuns and RunCleanupHour to 6 and 4, respectively. As a result, information about completed diagnostic test runs are stored in the database for 6 days, and the information about those test runs that have been stored for greater than 6 days is deleted at 4:00 AM.

PS C:\>Set-HpcClusterProperty -TtlCompletedRuns 6 -RunCleanupHour 4

EXAMPLE 6

Sets the cluster-wide parameters named EmailNotificationEnabled, EmailSmtpServer, and EmailFromAddress to $true, MySmtpServer, and someone@contoso.com, respectively. As a result, email notification about jobs is turned on and the HPC Job Scheduler Service sends those emails by using the SMTP server named MySmtpServer and from an address of someone@contoso.com.