Get-Caches

This enables the user to get the list of the total caches registered on the server along with their topology and status individually if they are running or not with process id.

Note

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

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

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 the server node for which the user wants to get the list of registered caches. 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. -