What does Get-CacheClientStatistics do?

Get-CacheClientStatistics displays performance statistics and counters for a specified NCache cache.

Which parameter is required for Get-CacheClientStatistics?

The CacheName parameter is required.

Can client statistics be collected continuously?

Yes. Use the Continuous parameter to collect statistics continuously.

Can custom performance counters be displayed?

Yes. The CounterNames parameter can be used to specify one or more counters that are not included in the default counters.

Can the statistics be output in CSV format?

Yes. The Format parameter can be set to CSV, and the CSV output can be saved to a file.

Can Continuous and MaxSamples be used together?

No. The Continuous and MaxSamples parameters cannot be used in the same command.

Is Get-CacheClientStatistics available in NCache Open Source?

Yes. This feature is also available in the NCache Open Source edition, although some cmdlet parameters may differ.

Get-CacheClientStatistics

This PowerShell cmdlet displays the statistics of the specified cache. It is a critical utility for performance benchmarking, identifying client-side bottlenecks, and analyzing resource utilization. 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 the Cache Performance Monitor.

Note

This feature is also available in the NCache Open Source. Please keep in mind that NCache Open Source has different parameters in some cmdlet instances.

Get-CacheClientStatistics -CacheName [-Clients] `
                          [-CounterNames] [-DoNotShowDefaultCounters] `
                          [-Continuous] [-Format] `
                          [-TlsCertPath] [-TlsCertPassword] `
                          [-SampleInterval] [-MaxSamples] `
                          [-NoLogo]

Examples

This command displays the default counters of the client for 'defaultCache' from the local node.

Get-CacheClientStatistics -CacheName defaultCache

This command displays the default counters for the cache 'defaultCache' from the client nodes 20.200.20.11 and 20.200.20.12.

Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12"

This command gets values of specified counter names alongside the default counters for 'defaultCache'.

Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" `
                          -CounterNames "Compression/sec"

This command gets values of specified counter names for 'defaultCache'. It does not display the values of default counters.

Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" `
                          -CounterNames "Compression/sec" -DoNotShowDefaultCounters

This command gets the 50 samples from defined counters for 'defaultCache'.

Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" `
                          -CounterNames "Compression/sec" -MaxSamples 50

This command gets values of counters for 'defaultCache' continuously after every 3 seconds.

Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" -Continuous

This command gets values of counters for 'defaultCache' continuously after every 5 seconds.

Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" `
                          -Continuous -SampleInterval 5

This command gets values of default counters for 'defaultCache' continuously after every 1 second and saves the output in CSV format at the given location.

Get-CacheClientStatistics -CacheName defaultCache -Continuous `
                          -SampleInterval 1 -Format CSV | Out-File "C:\stats.csv" `
                          -Encoding ASCII

This command displays client statistics for defaultCache using mutual TLS (mTLS). 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-CacheClientStatistics -CacheName defaultCache -TlsCertPath "C:\certs\client.pem" `
                          -TlsCertPassword "clientKeyPassword"

This command displays the default counters of the client for 'defaultCache' from the local node, using security credentials.

Get-CacheClientStatistics -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 counters need to be fetched. NOTE: The cache must already exist on the source server.	-
`-Clients`	`<String>`	Specifies one or more client node name(s) where the NCache Service is running and client node of specified cache is registered. NOTE: Comma-separated client names are to be specified in case of multiple clients.	IP of 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`	`<Long>`	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
`-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-CacheClientStatistics

Note

Examples

Properties

Note

Contact Us