Get-Caches - Monitor Cache Performance
This PowerShell Cmdlet enables the user to get the list of the total caches registered on the server along with their topology and status. It also provides the process id for each running cache, allowing users to monitor cache performance effectively.
Important
NCache OSS has different parameters in some Cmdlet instances.
Get-Caches [-Server] [-Port] [-InMemoryStoreType] -Topology [-Detail] [-NoLogo] [-Credentials]
Examples of Get-Caches - Monitor Cache Performance
- This command displays all caches registered on local machine to monitor cache performance.
Get-Caches
- This command displays all caches currently registered on the server 20.200.20.11 with detailed information to monitor cache performance.
Get-Caches -Detail -Server 20.200.20.11
- This command displays all caches currently registered on the server with detailed information.
Get-Caches -Detail
- This command displays all DistributedCacheWithPersistence caches currently registered on the server 20.200.20.11 with detailed information.
Get-Caches -Detail -Server 20.200.20.11 -InMemoryStoreType DistributedCacheWithPersistence
- 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 DistributedCacheWithPersistence partitioned caches currently registered on the server 20.200.20.11 with detailed information.
Get-Caches -Detail -Server 20.200.20.11 -InMemoryStoreType DistributedCacheWithPersistence -Topology Partitioned
- This command authenticates the credentials provided and displays all caches registered on a machine to monitor cache performance.
Get-Caches -Credentials 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 the server node for which the user wants to get the list of caches registered. | - |
-Port |
<Integer> |
Specifies the server port if the server channel is not using the default port. | 8250 |
-InMemoryStoreType |
<String> |
Specifies the type of the cache. | - |
-Topology |
<String> |
Specifies the cache topology in case of a clustered cache. For topologies other than local, you must provide the topology and cluster port. | - |
-Detail |
<SwitchParameter> |
Displays a comparatively detailed information about the caches registered on the server. This information includes Cache Name, Scheme, Status, Process ID, Cluster Size, Up Time, 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 with the appropriate permissions at the node. | - |