• 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
  • DataSource Providers
    • Add-BackingSource
    • Remove-BackingSource
  • Custom Dependency
    • Add-CustomDependency
    • Remove-CustomDependency
  • Pub/Sub Messaging
    • Get-Topics
  • Bridge
    • New-Bridge
    • Add-BridgeNode
    • Add-BridgeCache
    • Start-Bridge
    • Set-BridgeCacheMode
    • Start-BridgeStateTransfer
    • Stop-Bridge
    • Remove-Bridge
    • Remove-BridgeCache
    • Remove-BridgeNode
  • Mapreduce
    • Add-MapReduce
  • Compact Serilaization
    • Add-CompactType
    • Add-PortableType
    • Remove-PortableType
    • Remove-CompactType
  • Security
    • Enable-NCacheSecurity
    • Add-NCacheUserOrGroup
    • Remove-NCacheUserOrGroup
    • Enable-NCacheTLS
    • Disable-NCacheTLS
    • Disable-NCacheSecurity
    • 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-NCache
    • Register-NCacheEvaluation
    • Unregister-NCache
    • Get-NCacheVersion

Get-ClusterHealth - PowerShell Cmdlet

This lists all nodes registered on cache specified to monitor cache performance. It displays the status of the cache, connection and the number of connected clients.

Note

This feature is only available in NCache Enterprise and Professional.

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

Examples of Get-ClusterHealth - PowerShell Cmdlet

  • This example displays the nodes of the cache, status, connection among them and connected clients count for the cache demoCache to monitor cache performance.
Get-ClusterHealth -CacheName demoCache
  • This command displays the nodes, status, connection among the nodes and connected clients on a specific server for the cache demoCache to monitor cache performance.
Get-ClusterHealth -CacheName demoCache -Server 20.200.20.11
  • This command displays the nodes of the cache, status, connection among them and connected clients for the cache demoCache after every default sample interval.
Get-ClusterHealth -CacheName demoCache -Continuous
  • This command displays the nodes of the cache, status, connection among them and connected clients for the cache demoCache after every 3 second iterval.
Get-ClusterHealth -CacheName demoCache -Continuous -SampleInterval 3

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 in order 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 - PowerShell Cmdlet

  • This example displays the nodes of the cache, status, connection among them and connected clients count for the cache demoCache to monitor cache performance.
get-clusterhealth -cachename demoCache
  • This command displays the nodes, status, connection among the nodes and connected clients on a specific server for the cache demoCache to monitor cache performance.
get-clusterhealth -cachename demoCache -server 20.200.20.11
  • This command displays the nodes of the cache, status, connection among them and connected clients for the cache demoCache after every default sample interval.
get-clusterhealth -cachename demoCache -continuous
  • This command displays the nodes of the cache, status, connection among them and connected clients for the cache demoCache after every 3 second iterval.
get-clusterhealth -cachename demoCache -continuous -sampleinterval 3

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 in order 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 - PowerShell Cmdlet
  • Properties
  • Examples of Get-ClusterHealth - PowerShell Cmdlet
  • 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