Disable-NCEncryption
This PowerShell cmdlet disables client-side encryption on a specified cache. Once encryption is disabled, client-side encryption and decryption stop immediately, and all new data added to the cache is stored in serialized form as configured, both in transit and at rest. This should only be used when encryption is no longer required or for troubleshooting purposes where encryption might interfere with normal cache operations. CacheName is a required parameter. Server, Port, and Credentials are optional.
Disable-NCEncryption [-Server] [-Port] `
[-TlsCertPath] [-TlsCertPassword] `
-CacheName [-Credentials]
Examples
- This command disables the encryption on the cache server at 20.200.20.11 for the defaultCache.
Disable-NCEncryption -CacheName defaultCache -Server 20.200.20.11
- This command disables encryption for defaultCache on the specified server. It runs from a machine where NCache is not installed and connects to the server using mutual TLS (mTLS). The client certificate
C:\certs\client.pemauthenticates the machine running the cmdlet, and-TlsCertPassworddecrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Disable-NCEncryption -CachName defaultCache -Server 20.200.20.11 `
-TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
- This command disables the encryption on the cache server at 20.200.20.11 for the defaultCache, using credentials for authentication.
Disable-NCEncryption -CacheName defaultCache -Server 20.200.20.11 `
-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 |
|---|---|---|---|
-Server |
<String> |
Specifies the IP address of the server where the target cache is hosted. Multiple server IPs can be provided as a comma-separated list. | - |
-Port |
<Long> |
Specifies the port on which the NCache Service is listening. | 9803 |
-CacheName* |
<String> |
Specifies the name of the cache where encryption should be disabled. | - |
-Credentials |
<pscredential> |
Specifies the user credentials required to authenticate and authorize access when disabling encryption on a remote cache server. | - |
-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. |
- |