• Products
  • Solutions
  • Customers
  • Resources
  • Company
  • Pricing
  • Download
Try Playground
  • Monitoring
  • Get-ClusterHealth
Show / Hide Table of Contents
  • Command-Line Interface
  • Cmdlets in Different Editions
  • PowerShell on Windows
    • Setting Up PowerShell Environment
    • Install PowerShell without NCache Installation
  • Install-NCacheModule
  • Client Management
    • Add-ClientNode
    • Remove-ClientNode
    • Add-ClientNodeSecurity
  • Cache Management
    • New-Cache
    • Start-Cache
    • Stop-Cache
    • Set-CacheConfiguration
    • Export-CacheData
    • Export-CacheKeys
    • Export-CacheConfiguration
    • Get-CacheCount
    • Clear-Cache
    • Remove-Cache
    • Set-NCServiceConfigSetting
  • Client Cache
    • New-ClientCache
    • Add-ClientCacheRefDatatype
    • Remove-ClientCacheRefDatatype
    • Remove-ClientCache
  • Node Management
    • Add-Node
    • Remove-Node
  • Query Index
    • Add-QueryIndex
    • Remove-QueryIndex
  • Loader & Refresher
    • Add-LoaderDataSet
    • Invoke-RefresherDataset
    • Remove-LoaderDataSet
    • Add-StartupLoader
    • Remove-StartupLoader
  • Data Source Providers
    • Add-BackingSource
    • Remove-BackingSource
  • Custom Dependency
    • Add-CustomDependency
    • Remove-CustomDependency
  • Pub/Sub Messaging
    • Get-Topics
  • Bridge
    • New-Bridge
    • Remove-Bridge
    • Add-BridgeNode
    • Remove-BridgeNode
    • Add-BridgeCache
    • Remove-BridgeCache
    • Start-Bridge
    • Stop-Bridge
    • Set-BridgeCacheMode
    • Start-BridgeStateTransfer
  • Mapreduce
    • Add-MapReduce
  • Compact Serialization
    • Add-CompactType
    • Remove-CompactType
    • Add-PortableType
    • Remove-PortableType
  • Security
    • Add-NCacheUserOrGroup
    • Remove-NCacheUserOrGroup
    • Enable-NCacheSecurity
    • Disable-NCacheSecurity
    • Enable-NCacheTLS
    • Disable-NCacheTLS
    • Enable-NCEncryption
    • Disable-NCEncryption
  • Data Persistence
    • Suspend-NCacheDataPersistence
    • Resume-NCacheDataPersistence
  • Monitoring
    • Get-Caches
    • Get-CacheLogs
    • Get-CacheLogsList
    • Get-ConnectedClients
    • Get-CacheClientStatistics
    • Get-CacheServerStatistics
    • Add-TestData
    • Test-Stress
    • Get-ClusterHealth
    • New-MemoryDump
    • Get-MemoryDumpList
    • Send-MemoryDump
    • Remove-MemoryDump
    • Measure-CachePerformance
    • Invoke-ServerLogger
    • Import-CacheData
  • Management Center
    • Start-NCacheManagementCenter
    • Stop-NCacheManagementCenter
    • Set-CacheServerPublicIP
  • NCache Playground
    • Start-NCachePlaygroundProcess
    • Stop-NCachePlaygroundProcess
  • NCache Registration
    • Register-NCacheEvaluation
    • Register-NCache
    • Get-NCacheVersion
    • Unregister-NCache

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.

Note

This feature is also available in NCache Professional.

  • Windows PowerShell
  • Linux CLI
Get-ClusterHealth [-CacheName] [-Server] [-Continuous] [-SampleInterval] [-NoLogo]

Examples of Get-ClusterHealth

  • 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

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. -
-Server <String> Specifies the server name for which cluster health needs to be displayed. Local Machine
-Continuous <SwitchParameter> Specified to get the statistics continuously. -
-SampleInterval <Integer> Specifies the time between samples in seconds. Minimum value is 3 seconds. 1
-NoLogo <SwitchParameter> Suppresses display of the logo banner. False
get-clusterhealth [-cachename] [-server] [-continuous] [-sampleinterval] [-nologo]

Examples of Get-ClusterHealth

  • 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

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. -
-server <String> Specifies the server name for which cluster health needs to be displayed. Local Machine
-continuous <SwitchParameter> Specified to get the statistics continuously. -
-sampleinterval <Integer> Specifies the time between samples in seconds. Minimum value is 3 seconds. 1
-nologo <SwitchParameter> Suppresses display of the logo banner. False
In This Article
  • Examples of Get-ClusterHealth
  • Properties
  • Examples of Get-ClusterHealth
  • Properties

Contact Us

PHONE

+1 (214) 764-6933   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • NCache Enterprise
  • NCache Professional
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Download
Pricing
Try Playground

Deployments
  • Cloud (SaaS & Software)
  • On-Premises
  • Kubernetes
  • Docker
Technical Use Cases
  • ASP.NET Sessions
  • ASP.NET Core Sessions
  • Pub/Sub Messaging
  • Real-Time ASP.NET SignalR
  • Internet of Things (IoT)
  • NoSQL Database
  • Stream Processing
  • Microservices
Resources
  • Magazine Articles
  • Third-Party Articles
  • Articles
  • Videos
  • Whitepapers
  • Shows
  • Talks
  • Blogs
  • Docs
Customer Case Studies
  • Testimonials
  • Customers
Support
  • Schedule a Demo
  • Forum (Google Groups)
  • Tips
Company
  • Leadership
  • Partners
  • News
  • Events
  • Careers
Contact Us

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Contact Us
  •  
  • Sitemap
  •  
  • Terms of Use
  •  
  • Privacy Policy
© Copyright Alachisoft 2002 - 2025. All rights reserved. NCache is a registered trademark of Diyatech Corp.
Back to top