What does Get-ClusterHealth do?

Get-ClusterHealth displays health information for the nodes registered in a specified NCache cluster, including node status, connection information, and connected client count.

Which parameter is required for Get-ClusterHealth?

The CacheName parameter is required.

Can cluster health be retrieved continuously?

Yes. Use the Continuous parameter to retrieve cluster health statistics continuously.

What is the default sample interval?

The default SampleInterval is 3 seconds.

What is the minimum sample interval?

The minimum SampleInterval value is 1 second.

Which server is used by default?

If Server is not specified, the IP address of the local machine is used.

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.

Get-ClusterHealth -CacheName [-Server] `
                  [-Continuous] [-SampleInterval] `
                  [-TlsCertPath] [-TlsCertPassword] `
                  [-NoLogo]

Examples

This command displays the nodes of the cache, status, connections among them and connected client count for the cache defaultCache.

Get-ClusterHealth -CacheName defaultCache

This command displays the nodes, status, connection information and connected clients on a specific server 20.200.20.11 for the cache defaultCache.

Get-ClusterHealth -CacheName defaultCache -Server 20.200.20.11

This command displays the nodes of the cache, status, connection information and connected clients for the cache defaultCache continuously after every 3 seconds.

Get-ClusterHealth -CacheName defaultCache -Continuous

This command displays the nodes of the cache, status, connection information and connected clients for the cache defaultCache continuously after every 5-second interval.

Get-ClusterHealth -CacheName defaultCache -Continuous `
                  -SampleInterval 5

This command displays the cluster health of defaultCache on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.

Get-ClusterHealth -CacheName defaultCache -Server 20.200.20.11 `
                  -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"

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

Get-ClusterHealth -CacheName defaultCache -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
`-TlsCertPath`	`<string>`	Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using `New-NCacheTlsCertificate`. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use `-CustomCertificatePath`.	-
`-TlsCertPassword`	`<string>`	Password used to load the encrypted private key in the PEM file specified by `-TlsCertPath`. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration.	-

Get-ClusterHealth

Examples

Properties

Note

Contact Us