Get-ClusterHealth
This PowerShell cmdlet displays the health status of all nodes registered on the specified cache. It provides details about the cache's status, connection information, and the number of connected clients, making it easier to monitor cache performance.
Get-ClusterHealth -CacheName [-Server] [-Continuous] [-SampleInterval] [-NoLogo]
Examples
- This command displays the nodes of the cache, status, connection among them and connected client count for the cache demoCache.
Get-ClusterHealth -CacheName demoCache
- This command displays the nodes, status, connection information and connected clients on a specific server 20.200.20.11 for the cache demoCache.
Get-ClusterHealth -CacheName demoCache -Server 20.200.20.11
- This command displays the nodes of the cache, status, connection information and connected clients for the cache demoCache continuously after every 3 seconds.
Get-ClusterHealth -CacheName demoCache -Continuous
- This command displays the nodes of the cache, status, connection information and connected clients for the cache demoCache continuously after every 5 second iterval.
Get-ClusterHealth -CacheName demoCache -Continuous -SampleInterval 5
- This command displays the nodes of the cache, status, connection among them and connected client count for the cache demoCache, using security credentials.
Get-ClusterHealth -CacheName demoCache -Credentials(Get-Credential john_smith)
Properties
Note
The parameters with asterisk (*) on their names are the required parameters and the rest are optional.
| Parameters | Data Types | Description | Default Value |
|---|---|---|---|
-CacheName* |
<String> |
Specifies the name of the cache for which the cluster health needs to be displayed. Note: The cache must already exist on the source server. |
- |
-Server |
<String> |
Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered for which cluster health needs to be displayed. | IP of local machine |
-Continuous |
<SwitchParameter> |
Specified to get the statistics continuously. | - |
-SampleInterval |
<Integer> |
Specifies the time between samples in seconds. Minimum value is 1 seconds. | 3 seconds |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
