Set-HpcPool

Set-HpcPool

Sets the weight of a resource pool.

Syntax

Parameter Set: pool
Set-HpcPool -Pool <HpcPool> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Weight <Int32> ] [ <CommonParameters>]

Parameter Set: name
Set-HpcPool -Name <String> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Weight <Int32> ] [ <CommonParameters>]




Detailed Description

The Set-HpcPool cmdlet sets the weight of an HPC resource pool. This cmdlet 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

-ClusterConnectionString<String[]>

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING <head_node_name>.

This parameter was introduced in HPC Pack 2016.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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>

Specifies 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>

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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: Set the weight of a resource pool

This command sets the weight of an existing pool using the pool name and weight parameters.


PS C:\> Set-HpcPool -Name "Pool01" -Weight 10

Related topics

Community Additions

ADD
Show: