Get-CacheCount

This PowerShell cmdlet enables the user to get the total number of items currently present in the cache. It is a vital tool for monitoring cache performance, capacity planning, and data growth in the distributed environment. This cmdlet can be used to validate data consistency across certain nodes or the entire cluster of the cache.

Get-CacheCount -Name [-Server] `
               [-NoLogo] [-LoadBalancerEnabled] `
               [-TlsCertPath] [-TlsCertPassword] `
               [-Credentials]

Examples

  • This command displays total number of items currently present in the cache. 
Get-CacheCount -Name defaultCache -Server "20.200.20.11,20.200.20.12"
  • This command displays the total number of items currently in the defaultCache using the specified DNS, David-Watson.
Get-CacheCount -Name demoCache -Server David-Watson
  • This command displays the total number of items currently in the defaultCache through the specified load-balanced server, 20.200.20.11.
Get-CacheCount -Name demoCache -LoadBalancerEnabled `
               -Server 20.200.20.11
  • This command displays the number of items in defaultCache using the specified servers 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-CacheCount -Name defaultCache -Server "20.200.20.11,20.200.20.12" `
               -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
  • This command displays total number of items currently present in the cache, using security credentials. This command reads the deployment details specified in the config.ncconf.
Get-CacheCount -Name 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
-Name* <String> Specifies the name of the cache for which the item count is needed.
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.
NOTE: Comma-separated IP addresses are to be specified in case of multiple servers inside double quotes.		 IP of local machine
-LoadBalancerEnabled <SwitchParameter> Specifies whether to use a load balancer when connecting to the cache. False
-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. -
-Credentials <pscredential> Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node. -