Add-CacheSecurity
Note
This feature is only available in NCache Enterprise Edition.
Add-CacheSecurity cmdlet enables the user to configure cache level security
for the cache. This allows the following operations:
Add new users
Remove user
Enable security for cache.
Disable security for cache.
Add-CacheSecurity -Name [-AddUser] [-RemoveUser] [-DisableSecurity] [-DisableSecurity] -PrimaryLdap [-PrimaryLdapPort] [-SecondaryLdap] [-SecondaryLdapPort] [-NewUser] [-NewUserPassword] [-NewUserDN] [-DeleteUser] -UserId -Password -Server -NoLogo
These properties are explained in detail in the Properties section.
Examples
- The following command adds new user david_watson to demoClusteredCache's user list where user id is john_smith and primary LDAP controller is yourprimarydomain.
Add-CacheSecurity -AddUser -UserID john_smith -Password mypassword -NewUser david_watson -NewUserDN "CN=David Watson,OU=admin,DC=yourdomain,DC=org" -NewUserPassword userpassword -PrimaryLdap yourprimarydomain -PrimaryLdapPort 389 -Server 20.200.20.11 -Name demoClusteredCache
- The following command adds a new user david_watson to demoClusteredCache's user list where user id is john_smith, primary domain controller is yourprimarydomain and secondary (optional) domain controller is yoursecondarydomain.
Add-CacheSecurity -AddUser -UserID john_smith -Password mypassword -NewUser david_watson -NewUserDN "CN=David Watson,OU=admin,DC=yourdomain,DC=org" -NewUserPassword userpassword -PrimaryLdap yourprimarydomain -PrimaryLdapPort 389 -SecondaryLdap yoursecondarydomain -SecondaryLdapPort 389 -Server 20.200.20.11 -Name demoClusteredCache
- The following command deletes a user david_watson from demoClusteredCache where user id is john_smith and primary domain controller is yourprimarydomain.
Add-CacheSecurity -RemoveUser -UserID john_smith -Password mypassword -DeleteUser david_watson -PrimaryLdap yourprimarydomain -PrimaryLdapPort 389 -Server 20.200.20.11 -Name demoClusteredCache
- The following command enables security for user john_smith on demoClusteredCache with yourprimarydomain as primary domain controller.
Add-CacheSecurity -EnableSecurity -UserID john_smith -Password mypassword -PrimaryLdap yourprimarydomain -PrimaryLdapPort 389 -Server 20.200.20.11 -Name demoClusteredCache
- The following command disables security for user john_smith on demoClusteredCache where the primary domain controller is yourprimarydomain.
Add-CacheSecurity -DisableSecurity -UserID john_smoth -Password mypassword -PrimaryLdap yourdomain -PrimaryLdapPort 389 -Server 20.200.20.11 -Name demoClusteredCache
Properties
Note: The parameters with an asterisk (*) with their names are the required parameters and the rest are optional.
| Parameters | Data Types | Description | Default Value |
|---|---|---|---|
-Name* |
<String> |
Specifies the name of the cache for which security will be configured. | - |
-Server* |
<String> |
Specifies the server node on which NCache service is running. | IP of local machine |
-PrimaryLdap* |
<String> |
Specifies the primary domain controller for the users. | - |
-PrimaryLdapPort |
<Integer> |
Specifies the port on which primary domain controller is running. | 389 |
-SecondaryLdap |
<String> |
Specifies the secondary domain controller for the users. Used for credential authentication if the primary domain controller is unavailable. | - |
-SecondaryLdapPort |
<Integer> |
Specifies the port on which secondary domain controller is running. | 389 |
-UserId* |
<String> |
Specifies the user-id used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This user-id must be the LDAP user-id prefixed with the domain name. | - |
-Password* |
<String> |
Specifies the password of the user that is used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This password must be the same as the LDAP directory user password. | - |
-EnableSecurity |
<SwitchParameter> |
Specifies that the cmdlet is being used for enabling security on a specific cache. | - |
-DisableSecurity |
<SwitchParameter> |
Specifies that the cmdlet is being used for disabling security on a specific cache. | - |
-AddUser |
<SwitchParameter> |
Specifies that the cmdlet is being used for adding a user to cache's users list. | - |
-DeleteUser |
<String> |
Specifies the existing user which is now being deleted or removed from NCache cache users. | - |
-NewUser |
<String> |
Specifies the user name to add. | - |
-NewUserDN |
<String> |
Specifies the new user's distinguished name. | - |
-NewUserPassword |
<String> |
Specifies the new user's password. | - |
-RemoveUser |
<SwitchParameter> |
Specifies that the cmdlet is being used for removing a user from NCache cache users. | - |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | - |