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] -CacheName [-Credentials]
Examples
- This command enables the encryption on the cache server 20.200.20.11 for the demoCache.
Enable-NCEncryption -CacheName demoCache -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 demoCache.
Enable-NCEncryption -CacheName demoCache -Server "20.200.20.11,20.200.20.12" -Key txujoegdxzwiophd -Provider TripleDES128
- This command enables the encryption on the cache servers 20.200.20.11 and 20.200.20.12 for the demoCache, using credentials for authentication.
Enable-NCEncryption -CacheName demoCache -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. | 8250 |
-CacheName* |
<String> |
Specifies the name of the cache where encryption should be configured. | - |
