Stop-Cache

The Stop-Cache PowerShell cmdlet enables administrators to stop one or more caches on a particular server node. It supports Graceful Shutdown to guarantee data consistency by allowing background tasks to finish.

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.

Stop-Cache -Name [-IsGracefulStop] `
                 [-Port] [-Server] `
                 [-IsStopForMaintenance] [-Timeout] `
                 [-TlsCertPath] [-TlsCertPassword] ` 
                 [-Credentials] [-NoLogo]

Examples

  • This command stops the cache named defaultCache on local server.
Stop-Cache -Name defaultCache
  • This command stops the cache named defaultCache on server node 20.200.20.11.
Stop-Cache -Name defaultCache -Server 20.200.20.11
  • This command stops the cache defaultCache on 20.200.20.11 gracefully.
Stop-Cache -Name defaultCache -Server 20.200.20.11 `
           -IsGracefulStop
  • This command stops the cache defaultCache on 20.200.20.11 for a 30 minutes time period for maintenance.
Stop-Cache -Name defaultCache -Server 20.200.20.11 `
           -IsStopForMaintenance -Timeout 30
  • This command stops defaultCache on servers 20.200.20.11 and 20.200.20.12.
Stop-Cache -Name defaultCache -Server "20.200.20.11,20.200.20.12"
  • This command stops defaultCache on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Stop-Cache -Name defaultCache -Server 20.200.20.11 `
           -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
  • This command stops the cache named defaultCache on local server using security credentials.
Stop-Cache -Name defaultCache -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
-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. 9803
-Server <String> Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered, and the user wants to stop the cache on that particular server node. IP of 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
-TlsCertPath <string> Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using New-NCacheTlsCertificate. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use -CustomCertificatePath. -
-TlsCertPassword <string> Password used to load the encrypted private key in the PEM file specified by -TlsCertPath. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration. -
-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. -