What metrics does the Get-ClusterHealth output provide?

The output provides a per-node breakdown of: Operational Status (Running/Stopped), number of connected clients, and inter-node connection health. This helps identify unbalanced loads, failed nodes, or broken network links.

When should I use Continuous mode in NCache monitoring?

Use -Continuous mode for live health dashboards or alerting scripts. You can pipe this output to 'Out-GridView' for visual analysis or log it to a file for historical trend tracking. Use Ctrl+C to terminate the stream.

Why is the -Credentials parameter required for Get-ClusterHealth?

This parameter is mandatory when NCache security is enabled. It allows administrators to provide LDAP/Active Directory credentials for authorized access. Use 'Get-Credential' on Windows or '-userid/-password' on Linux.

Get-ClusterHealth

This PowerShell cmdlet retrieves the health status of all nodes registered in the specified NCache cluster. It reports node operational states, inter-node communication health, overall cluster view, and the number of connected clients. This cmdlet is used for monitoring cluster stability, validating high availability, troubleshooting node or connectivity issues, and verifying client load distribution in distributed cache environments.

Windows PowerShell
Linux CLI

Get-ClusterHealth -CacheName [-Server] [-Continuous] [-SampleInterval] [-NoLogo]

Examples

This command displays the nodes of the cache, status, connections 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 interval.

Get-ClusterHealth -CacheName demoCache -Continuous -SampleInterval 5

This command displays the nodes of the cache, status, connections 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>`	Specifies that statistics are retrieved continuously.	-
`-SampleInterval`	`<Integer>`	Specifies the time between samples in seconds. Minimum value is 1 second.	3 seconds
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

get-clusterhealth -cachename [-server] [-continuous] [-sampleinterval] [-nologo]

Examples

This command displays the nodes of the cache, status, connections 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 interval.

get-clusterhealth -cachename demoCache -continuous -sampleinterval 5

This command displays the nodes of the cache, status, connections among them and connected client count for the cache demoCache, using security credentials.

get-clusterhealth -cachename demoCache -userid john_smith -password pass123

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>`	Specifies that statistics are retrieved continuously.	-
`-sampleinterval`	`<Integer>`	Specifies the time between samples in seconds. Minimum value is 1 second.	3 seconds
`-nologo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

Get-ClusterHealth

Examples

Properties

Note

Contact Us