Get-HpcPool
Get-HpcPool
Gets the specified resource pool.
Syntax
Parameter Set: name
Get-HpcPool [-Name <String> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
Gets the pool specified by the Name parameter. If no pool exists with the name specified, an error results. If no pool name is specified, a list of the available pools is returned.
Parameters
-Name<String>
The name of the pool on the cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Scheduler<String>
Specifies the host name or IP address of the head node for the cluster where the specified pool resides. 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
The following example shows you how to get property information for a specific resource pool that is on the cluster:
PS C:\>$a = Get-HpcPool –Scheduler HEADNODE –Name Default
Example 2
The following example shows you how to get property information for all the resource pools that are on the cluster:
PS C:\>$a = Get-HpcPool –Scheduler HEADNODE