What does Enable-NCEncryption do?

Enable-NCEncryption enables client-side encryption on a specified NCache cache.

Where is cache data encrypted?

Data is encrypted at the client before it is transmitted to the cache server and is stored in encrypted form at rest.

Which parameters are required for Enable-NCEncryption?

Key, Provider, and CacheName are required parameters.

Can multiple server IP addresses be specified?

Yes. The Server parameter can accept multiple server IP addresses as a comma-separated list.

What is the default port for Enable-NCEncryption?

The default value of the Port parameter is 9803.

Enable-NCEncryption

This PowerShell cmdlet enables client-side encryption on a specified cache. When encryption is enabled, all data is encrypted at the client before being transmitted to the cache server and is stored in encrypted form at rest. Encrypted data is decrypted when accessed by authorized clients, ensuring protection during both data-in-transit and data-at-rest. This cmdlet is used to secure sensitive cache data by enforcing client-side data protection.

Enable-NCEncryption -Key -Provider `
                    [-Server] [-Port] `
                    [-TlsCertPath] [-TlsCertPassword] `
                    -CacheName [-Credentials]

Examples

This command enables the encryption on the cache server 20.200.20.11 for the defaultCache.

Enable-NCEncryption -CacheName defaultCache -Server 20.200.20.11 `
                    -Key txujoegdxzwiophd -Provider TripleDES128

This command enables the encryption on the cache servers 20.200.20.11 and 20.200.20.12 for the defaultCache.

Enable-NCEncryption -CacheName defaultCache -Server "20.200.20.11,20.200.20.12" `
                    -Key txujoegdxzwiophd -Provider TripleDES128

This command enables encryption for defaultCache on the specified server using the TripleDES128 provider and the supplied encryption key. 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.pem authenticates the machine running the cmdlet, and -TlsCertPassword decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.

Enable-NCEncryption -CachName defaultCache -Server 20.200.20.11 `
                    -Key txujoegdxzwiophd -Provider TripleDES128 `
                    -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"

This command enables the encryption on the cache servers 20.200.20.11 and 20.200.20.12 for the defaultCache, using credentials for authentication.

Enable-NCEncryption -CacheName defaultCache -Server "20.200.20.11,20.200.20.12" `
                    -Key txujoegdxzwiophd -Provider TripleDES128 `
                    -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
`-Key*`	`<String>`	Specifies the encryption key that will be used to encrypt and decrypt the cache data. This key must be securely generated and managed to maintain the integrity of the encryption process.	-
`-Provider*`	`<String>`	Specifies the encryption algorithm or provider to be used for encrypting the data.	-
`-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.	-
`-Credentials`	`<pscredential>`	Specifies the user credentials required to authenticate and authorize access when setting encryption on a remote cache server.	-
`-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 configured.	-
`-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.	-

Enable-NCEncryption

Examples

Properties

Note

Contact Us