Export (0) Print
Expand All

Remove-HpcPool

Updated: January 10, 2014

Remove-HpcPool

Removes the specified resource pool.

Syntax

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

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




Detailed Description

Removes the specified resource pool. Returns an error if the pool is used in one or more templates. You can use the Force option to force removal of the pools, resetting the template or templates to use the default pool.

Parameters

-Force

Forces the removal of the specified pool. This parameter will reset 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>

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>

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

This following example provides a simple method of removing a resource pool using the name of the head node and name of the pool that you want to remove:


PS C:\>Remove-HPCPool –Scheduler “HeadNode” -Name “Pool1”

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft