Remove-HpcPool
Removes a resource pool.
Syntax
Remove-HpcPool
-Pool <HpcPool>
[-Force]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>] Remove-HpcPool
-Name <String>
[-Force]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>] 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.
Examples
Example 1: Remove a resource pool by name
PS C:\>Remove-HpcPool -Scheduler "HeadNode" -Name "Pool01"This command removes a resource pool using the name of the head node and the name of the pool that you want to remove:
Parameters
-ClusterConnectionString
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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the pool on the cluster to be deleted. You cannot specify both the Name and the Pool parameters.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Pool
Specifies the HpcPool object to remove. You cannot specify both the Name and the Pool parameters.
| Type: | HpcPool |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scheduler
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\>
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Notes
- This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.