Get-CacheClientStatistics
Note
This feature is only available in NCache Enterprise and Professional Editions.
Get-CacheClientStatistics cmdlet displays the statistics of the specified cache. It displays a list of performance counters by default which can be extended by a list of custom counters. It helps you save the counters in a .CSV file which can be opened in Microsoft Excel. Moreover, the .CSV file can be converted to .BLG format for viewing counters in Performance Monitor.
Get-CacheClientStatistics [-CacheName] [-Clients] [-CounterNames] [-DoNotShowDefaultCounters] [-Continuous] [-Format] [-SampleInterval] [-MaxSamples] [-NoLogo]
These properties are explained in detail in the Properties section.
Examples
- The following command displays the default counters of the client for demoCache from the default node.
Get-CacheClientStatistics -CacheName demoCache
- The following command displays the default counters for the cache demoCache from the client nodes 20.200.20.19 and 20.200.20.20.
Get-CacheClientStatistics -CacheName demoCache -Clients "20.200.20.19,20.200.20.20"
- The following command displays the specified counters for demoCache and does not display the default counters.
Get-CacheClientStatistics -CacheName demoCache -DoNotShowDefaultCounters -CounterNames "Compression/sec"
- The following command displays the default counters and specified counters of the cache demoCache.
Get-CacheClientStatistics -CacheName demoCache -CounterNames "Compression/sec"
- The following command displays the default counters for the cache demoCache continuously after every default sample interval.
Get-CacheClientStatistics -CacheName demoCache -Continuous
- The following command gets default counters for the cache demoCache continuously after every 3 second interval.
Get-CacheClientStatistics -CacheName demoCache -Continuous -SampleInterval 3
- The following command gets default counters and specified counters for cache demoCache continuously after every 3 second interval and displays output in csv format.
Get-CacheClientStatistics -CacheName demoCache -Continuous -SampleInterval 3 -Format csv
- The following command gets default counters and specified counters for the cache demoCache continuously after every 3 seconds and saves the output in .CSV file at the path provided.
Get-CacheClientStatistics -CacheName demoCache -Continuous -SampleInterval 3 -Format csv | Out-File -Encoding ascii "C:\test.csv"
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 counters need to be fetched. | - |
-Clients |
<String> |
Specifies one or more client node name(s) where the NCache service is running client node of specified cache is registered. NOTE: Comma (,) separated client names are to be specified in case of multiple clients. |
Local Machine |
-CounterNames |
<String> |
Specifies one or more counter(s) not included in default counters that should be displayed. NOTE: Comma (,) separated counter names are to be specified in case of multiple counters. The Perfmon counters mentioned on this page can be fetched by this switch. |
- |
-Continuous |
<SwitchParameter> |
Specified in order to get the statistics continuously. | - |
-DoNotShowDefaultCounters |
<SwitchParameter> |
Specifies whether default counters are to be shown. NOTE: This parameter is only valid if Counter Names are provided. |
False |
-Format |
<String> |
By default display format is tabular but it can be set to CSV, and that CSV output can be saved in CSV file for future use. | Tabular |
-SampleInterval |
<Integer> |
Specifies the time between samples in seconds. Minimum value is 3 seconds. | 1 |
-MaxSamples |
<Integer> |
Specifies the number of samples to get from each counter. To get samples continuously (no maximum sample size), use the Continuous parameter. NOTE: The Continuous parameter and the MaxSamples parameter cannot be used in the same command. If Sample Interval is provided, it will take the next Sample after that interval otherwise it will use the default value i.e. 3 seconds. |
1 |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |