Get-HpcClusterOverview

  • Reference
Module:
HPCPack2019

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

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

Description

The Get-HpcClusterOverview cmdlet 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.

Examples

Example 1: Get a cluster overview

PS C:\>Get-HpcClusterOverview -Scheduler "HeadNode"

This command 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.

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

-Scheduler

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

ClusterOverview