Remove-HpcPool

Remove-HpcPool

Removes a resource pool.

Syntax

Parameter Set: pool
Remove-HpcPool -Pool <HpcPool> [-ClusterConnectionString <String[]> ] [-Force] [-Scheduler <String[]> ] [ <CommonParameters>]

Parameter Set: name
Remove-HpcPool -Name <String> [-ClusterConnectionString <String[]> ] [-Force] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Remove-HpcPool cmdlet removes the specified resource pool. Returns an error if the pool is used in one or more templates. You can use the Force parameter to force removal of the pools, which resets the template or templates to use the default pool.

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

-Force

Indicates that this operation forces the removal of the specified pool. This parameter resets the template or templates to use the default pool.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the pool on the cluster to be deleted. 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 to remove. 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 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

<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: Remove a resource pool by name

This command removes a resource pool using the name of the head node and the name of the pool that you want to remove:


PS C:\>Remove-HpcPool –Scheduler "HeadNode" -Name "Pool01" 

Related topics

Community Additions

ADD
Show: