Enable NCache Security
Note
This feature is only available in NCache Enterprise.
This activates NCache security on a server by verifying admin credentials, which can be local or NCache-specific.
Enable-NCacheSecurity [-AdminCredentials] [-Server] [-WriteToServiceConfig]
Examples
- This command enables NCache security on the server with the IP address 20.200.20.11. Before enabling security, the command validates that John Smith has the necessary privileges on the server.
Enable-NCacheSecurity -Server 20.200.21.11 -AdminCredentials(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 |
-AdminCredentials* |
<pscredential> |
Specifies the credentials of an LDAP user with administrative rights on the given server. |
- |
-Server* |
<String> |
Specifies the IP addresses of the servers where security should be enabled. This parameter can accept multiple IP addresses, allowing you to enable security on multiple servers simultaneously. |
- |
-WriteToServiceConfig |
<SwitchParameter> |
Specifies whether to write to service configurations. |
False |
enable-ncachesecurity [-adminuserid] [-adminpassword] [-server] [-writecredentialstoserviceconfig]
Examples
- This command enables NCache security on the server with the IP address 20.200.20.11. Before enabling security, the command validates that John Smith has the necessary privileges on the server.
enable-ncachesecurity -server 20.200.21.11 -adminuserid david_watson -adminpassword pass12345
- This command enables NCache security on the server with the IP address 20.200.20.11. Before enabling security, the command validates whether John Smith has the necessary privileges on the server. Additionally, the
-write-credentials-to-service-config
switch stores the provided credentials in an encrypted form within the service configuration. These stored credentials will be used to facilitate the auto-startup of configured caches with the associated credentials.
enable-ncachesecurity -server 20.200.21.11 -adminuserid david_watson -adminpassword pass12345 -writecredentialstoserviceconfig
Properties
Note
The parameters with asterisk (*) on their names are the required parameters and the rest are optional.
Parameters |
Data Types |
Description |
Default Value |
-admin-user-id |
<String> |
Specifies the user ID of an LDAP user with administrative rights on the given server. These credentials should belong to a user who has appropriate permissions at the node. |
- |
-admin-password |
<String> |
Specifies the password of an LDAP user with administrative rights on the given server. These credentials should belong to a user who has appropriate permissions at the node. |
- |
-server* |
<String> |
Specifies the IP addresses of the servers where security should be enabled. This parameter can accept multiple IP addresses, allowing you to enable security on multiple servers simultaneously. |
- |
-write-credentials-to-service-config |
<SwitchParameter> |
Specifies whether to write to service configurations. |
False |