Set-HpcPool
Set-HpcPool
Sets the weight on a resource pool.
Syntax
Parameter Set: pool
Set-HpcPool -Pool <HpcPool> [-Scheduler <String> ] [-Weight <Int32> ] [ <CommonParameters>]
Parameter Set: name
Set-HpcPool -Name <String> [-Scheduler <String> ] [-Weight <Int32> ] [ <CommonParameters>]
Detailed Description
Sets the weight on the specified HPC resource pool. Returns an error if the specified pool does not exist, or if the specified weight is less than 0 or greater than 999,999.
Parameters
-Name<String>
Specifies the name of the resource pool that you will be setting the weight on. You cannot specify both the Name and the Pool parameters.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Pool<HpcPool>
The HpcPool object. You cannot specify both the Name and the Pool parameters.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Scheduler<String>
Specifies the host name or IP address of the head node for the cluster that contains the resource pool. 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 |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Weight<Int32>
Integer that specifies the pool weight.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Notes
- This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.
Examples
Example 1
The following HPC Powershell command example shows you how to set the weight of an existing pool using the pool name and weight switch:
PS C:\>Set-HpcPool -Name Pool1 -Weight 10