How do I list all running caches on the local machine?

To list all caches on your local machine, simply execute the 'Get-Caches' cmdlet in PowerShell. This returns a list of all total caches registered on the server, along with their topology and current operational status.

How can I see detailed information like PID and Uptime for NCache caches?

By adding the '-Detail' switch to the command (e.g., 'Get-Caches -Detail'), you can view comparatively detailed information including Cache Name, Status, Process-ID (PID), Cluster Size, Uptime, Capacity, and Item Count.

Does Get-Caches work on NCache Linux installations?

Yes, the 'get-caches' command is fully supported on Linux. On Linux, you can also use '-userid' and '-password' parameters for authentication if NCache security is enabled on the Cache Server.

Get-Caches

Get-Caches cmdlet retrieves a complete list of all registered caches, displaying their topology(Local, Partitioned, Replicated, or Partitioned of Replica), running or stopped status, and essential operational details. Administrators use Get-Caches to quickly assess cache health, verify deployments, and troubleshoot issues across clustered and standalone NCache environments on Windows and Linux.

Note

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

Windows PowerShell
Linux CLI

Get-Caches [-Server] [-Port] [-InMemoryStoreType] [-Topology] [-Detail] [-NoLogo] [-Credentials]

Examples

This command displays all caches registered on the local machine.

Get-Caches

This command displays all caches currently registered on the server 20.200.20.11 with detailed information.

Get-Caches -Detail -Server 20.200.20.11

This command displays all caches registered on the local machine with detailed information.

Get-Caches -Detail

This command displays all DistributedCache caches currently registered on the server 20.200.20.11 with detailed information.

Get-Caches -Detail -Server 20.200.20.11 -InMemoryStoreType DistributedCache

This command displays all Partitioned caches currently registered on the server 20.200.20.11 with detailed information.

Get-Caches -Detail -Server 20.200.20.11 -Topology Partitioned

This command displays all DistributedCache Partitioned caches currently registered on the server 20.200.20.11 with detailed information.

Get-Caches -Detail -Server 20.200.20.11 -InMemoryStoreType DistributedCache -Topology Partitioned

This command displays detailed information about all caches running on server 20.200.20.11 using user credentials.

Get-Caches -Detail -Server 20.200.20.11 -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
`-Server`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. It includes the server node for which the user wants to get the list of registered caches.	IP of local machine
`-Port`	`<Integer>`	Specifies the server port where the NCache Service is listening.	8250
`-InMemoryStoreType`	`<String>`	Specifies the type of the cache.	-
`-Topology`	`<String>`	For topology other than local you have to give topology and cluster port. Specifies the topology in case of clustered cache.	-
`-Detail`	`<SwitchParameter>`	Displays a comparatively detailed information about the caches registered on the server. This information includes Cache-Name, Status, Process-ID, Cluster-size, UpTime, Capacity and Count.	False
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-Credentials`	`<pscredential>`	Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user who has appropriate permissions at the node.	-

get-caches [-server] [-port] [-inmemorystoretype] [-topology] [-detail] [-nologo] [-userid] [-password]

Examples

This command displays all caches registered on the local machine.

get-caches

This command displays all caches currently registered on the server 20.200.20.11 with detailed information.

get-caches -detail -server 20.200.20.11

This command displays all caches registered on the local machine with detailed information.

get-caches -detail

This command displays all DistributedCache caches currently registered on the server 20.200.20.11 with detailed information.

get-caches -detail -server 20.200.20.11 -inmemorystoretype DistributedCache

This command displays all Partitioned caches currently registered on the server 20.200.20.11 with detailed information.

get-caches -detail -server 20.200.20.11 -topology Partitioned

This command displays all DistributedCache Partitioned caches currently registered on the server 20.200.20.11 with detailed information.

get-caches -detail -server 20.200.20.11 -inmemorystoretype DistributedCache -topology Partitioned

This command displays detailed information about all caches running on server 20.200.20.11 with user credentials.

get-caches -detail -server 20.200.20.11 -userid john_smith -password pass123

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters	Data Types	Description	Default Value
`-server`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. It includes the server node for which the user wants to get the list of registered caches.	IP of local machine
`-port`	`<Integer>`	Specifies the server port where the NCache Service is listening.	8250
`-inmemorystoretype`	`<String>`	Specifies the type of the cache.	-
`-topology`	`<String>`	For topology other than local you have to give topology and cluster port. Specifies the topology in case of clustered cache.	-
`-detail`	`<SwitchParameter>`	Displays a comparatively detailed information about the caches registered on the server. This information includes Cache-Name, Status, Process-ID, Cluster-size, UpTime, Capacity and Count.	False
`-nologo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-userid`	`<String>`	Specifies the user id used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This user id must be the active directory user id.	-
`-password`	`<String>`	Specifies the password of the user that is used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This password must be the same as the active directory user password.	-

Get-Caches

Note

Examples

Properties

Note

Contact Us