Get-HpcClusterOverview

Gets an overview of some metrics for the specified HPC cluster, including the number of nodes, jobs, and tasks in various states on the HPC cluster.

Syntax

	Copy Code
Parameter Set: Default Get-HpcClusterOverview [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: Default


Get-HpcClusterOverview [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Gets an overview of some metrics for the specified HPC cluster, including the number of nodes, jobs, and tasks in various states on the HPC cluster.

Parameters

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster for which you want information. 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	%CCP_SCHEDULER%
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.

None.

Outputs

The output type is the type of the objects that the cmdlet emits.

A ClusterOverview object.

Examples

EXAMPLE 1

Gets metrics for the HPC cluster with a head node named HeadNode, including the number of nodes, jobs, and tasks in various states on the HPC cluster.

	Copy Code
Get-HpcClusterOverview -Scheduler HeadNode