Set-LocalNodeMaxConcurrentTaskPolicy

Synopsis

Sets the maximum number of tasks that the node will run at once.

Syntax

Set-LocalNodeMaxConcurrentTaskPolicy [-Automatic] <SwitchParameter>

Set-LocalNodeMaxConcurrentTaskPolicy [-NumberOfCoresOnNode] <SwitchParameter>

Set-LocalNodeMaxConcurrentTaskPolicy [-ExplicitNumber] <SwitchParameter> [-Number] <Int32>

Detailed Description

The Set-LocalNodeMaxConcurrentTaskPolicy function sets the policy that limits the number of tasks a node will run concurrently.

Laserfiche Distributed Computing Cluster currently supports three policies for setting the maximum number of concurrent tasks:

  • - Automatic: The Automatic policy uses a number that the service estimates will maximize throughput.
  • - NumberOfCoresOnNode: The NumberOfCoresOnNode policy uses the number of cores on the machine.
  • - ExplicitNumber: The ExplicitNumber policy uses a user specified number.

Parameters

-Automatic <SwitchParameter>
	Specifies that the automatic policy should be used to determine the maximum number of tasks that the node will run at once.
 	Required?                    true
	Position?                    1
	Default value
	Accept pipeline input?       false
	Accept wildcard characters?  false
-NumberOfCoresOnNode <SwitchParameter>
	Specifies that the number of cores on the machine should be used as the maximum number of tasks that the node will run at once.
	Required?                    true
	Position?                    1
	Default value
	Accept pipeline input?       false
	Accept wildcard characters?  false
-ExplicitNumber <SwitchParameter>
	Specifies a that a user specified number should be used as the maximum number of tasks that the node will run at once.
	Required?                    true
	Position?                    1
	Default value
	Accept pipeline input?       false
	Accept wildcard characters?  false
-Number <Int32>
	The user specified number that should be used as the maximum number of tasks that the node will run at once.
	Required?                    true
	Position?                    2
	Default value
	Accept pipeline input?       false
	Accept wildcard characters?  false

Inputs

None

You cannot pipe input to this function.

Outputs

None

This function does not return any output.

Examples

Example 1

PS C:\> Set-LocalNodeMaxConcurrentTaskPolicy -NumberOfCoresOnNode

Sets the node to perform as many tasks at once as there are processor cores on that machine.

Example 2

PS C:\> Set-LocalNodeMaxConcurrentTaskPolicy -ExplicitNumber 5

Sets the node to perform a maximum of 5 tasks at once.

Example 3

PS C:\> Set-LocalNodeMaxConcurrentTaskPolicy -Automatic

Sets the node to use the automatic policy to determine the number of tasks that can be run at once.

Related Links

Get-LocalNodeMaxConcurrentTaskPolicy

Reset-LocalNodeMaxConcurrentTaskPolicy