Stop-Cache - PowerShell Cmdlet
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.
Important
NCache OSS has different parameters in some Cmdlet instances. Please refer to the seperate Open Source PowerShell Reference to ensure intended working in this case.
Stop-Cache [-Name] [-IsGracefulStop] [-Port] [-Server] [-IsStopForMaintenance] [-Timeout] [-Credentials] [-NoLogo]
Examples of Stop-Cache - PowerShell Cmdlet
- This PowerShell Cmdlet stops the cache named demoCache on local server using port 8250.
Stop-Cache –Name demoCache
- This PowerShell Cmdlet stops the cached named demoCache on server node 20.200.20.11 using default port 8250.
Stop-Cache –Name demoCache –Server 20.200.20.11
- This command stops cache demoCache gracefully existing on server 20.200.20.11.
Stop-Cache -Name demoCache -Server 20.200.20.11 -IsGracefulStop
- This command stops cache for maintenance demoCache existing on server 20.200.20.11 for a 30 minutes time period.
Stop-Cache -Name demoCache -Server 20.200.20.11 -IsStopForMaintenance -Timeout 30
- This command stops demoCache on severs 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> |
Provided by the user if the user wants the server to be stopped gracefully i.e the server wouldn’t be forcefully stopped. | False |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
-Port |
<Integer> |
Specifies the management port on which the NCache server is listening if the server channel is not using the default port. | 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. | False |
-Timeout |
<Integer> |
Specifies the time interval for which cache is going under maintenance. The value must range from 0 to 600. | 0 |
-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. | - |
