Stop-Cache
This PowerShell cmdlet enables users to stop the cache on a specified server as well as stop a cache gracefully. It also enables the users to stop multiple caches on specified server.
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.
Stop-Cache -Name [-IsGracefulStop] [-Port] [-Server] [-IsStopForMaintenance] [-Timeout] [-Credentials] [-NoLogo]
Examples
- This command stops the cache named demoCache on local server.
Stop-Cache –Name demoCache
- This command stops the cache named demoCache on server node 20.200.20.11.
Stop-Cache –Name demoCache –Server 20.200.20.11
- This command stops the cache demoCache on 20.200.20.11 gracefully.
Stop-Cache -Name demoCache -Server 20.200.20.11 -IsGracefulStop
- This command stops the cache demoCache on 20.200.20.11 for a 30 minutes time period for maintenance.
Stop-Cache -Name demoCache -Server 20.200.20.11 -IsStopForMaintenance -Timeout 30
- This command stops demoCache on servers 20.200.20.11 and 20.200.20.12.
Stop-Cache -Name demoCache -Server "20.200.20.11,20.200.20.12"
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 one or more name(s) of caches separated by comma which are registered on the server. Those cache(s) is/are stopped on the server. Note: Comma separated cache names are to be specified in case of multiple caches only. |
- |
-IsGracefulStop |
<SwitchParameter> |
Specifies if the server should be stopped gracefully, ensuring all background operations complete to avoid data loss. Without this, the server stops forcefully, risking operation loss. | - |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
-Port |
<Integer> |
Specifies the server port where the NCache Service is listening. | 8250 |
-Server |
<String> |
Specifies the server name where NCache Service is running and the user wants to stop the cache on that particular server node | Local Machine |
-IsStopForMaintenance |
<SwitchParameter> |
Specifies if the cache is stopping for maintenance. | - |
-Timeout |
<Integer> |
Specifies the time interval for which cache is going under maintenance. The value must range from 0 to 600 minutes. | 0 |
-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. | - |
