Get-HpcPool

Get-HpcPool

Gets a resource pool.

Syntax

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




Detailed Description

The Get-HpcPool cmdlet gets the resource pool specified by the Name parameter. If no pool exists with the name specified, an error results. If no pool name is specified, all available pools are returned.

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

This command gets property information for a specific resource pool that is on the cluster:


PS C:\> $Pool = Get-HpcPool –Scheduler "HEADNODE" –Name "Default"

Example 2: Get all resource pools in a cluster

This command gets property information for all of the resource pools that are on the cluster:


PS C:\> $Pool = Get-HpcPool –Scheduler "HEADNODE"

Related topics

Community Additions

ADD
Show: