.png)
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
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>
|
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.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
|
Input Type |
None. |
|
Return Type |
A ClusterOverview object. |
Example 1
C:\PS>Get-HpcClusterOverview -Scheduler HeadNode
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.
