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 to cache administrator’s list.
Remove user from cache administrator’s list.
Enable security for cache.
Disable security for cache.
Add-CacheSecurity [-Name] [-AddUser] [-DeleteUser] [-DisableSecurity] [-DomainController] [-EnableSecurity] [-NewUser] [-NoLogo] [-Password] [-Port] [-RemoveUser] [-ServerNode] [-UserId]
These properties are explained in detail in the Properties section.
Examples
- The following command adds new users to demoCache’s administrator’s list.
Add-CacheSecurity -Name demoCache -AddUser -NewUser john_smith -ServerNode 20.200.20.11 -UserId john_smith -Password myPassword -DomainController pdc
- The following command deletes a user from demoCache’s administrator’s list.
Add-CacheSecurity -Name demoCache -RemoveUser -DeleteUser john_smith -ServerNode 20.200.20.11 -UserId john_smith -Password myPassword -DomainController pdc
- The following command enables security for user john_smith on demoCache. Make sure that the user has already been added to the cache’s admin list.
Add-CacheSecurity -Name demoCache –EnableSecurity -ServerNode 20.200.20.11 -UserId john_smith -Password myPassword -DomainController pdc
- The following command disables security for user john_smith on demoCache.
Add-CacheSecurity demoCache –DisableSecurity -ServerNode 20.200.20.11 -UserId john_smith -Password myPassword -DomainController pdc
Properties
Note: The parameters with asterisk (*) on 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. | - |
-ServerNode* |
<String> |
Specifies the server node on which NCache service is running. | IP of local machine |
-DomainController* |
<String> |
Specifies the domain controller for the users. | - |
-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 active directory 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 active directory user password. | - |
-AddUser |
<SwitchParameter> |
Specifies that a user is being added to the cache administrator's list. | - |
-DeleteUser |
<String> |
Specifies the existing user to be deleted from cache administrator's list. | - |
-NewUser |
<String> |
Specifies the user name to add. | - |
-RemoveUser |
<SwitchParameter> |
Specifies the user name to be removed from the cache administrator’s list. | - |
-EnableSecurity |
<SwitchParameter> |
Specifies that security is being enabled on a specific node. | - |
-DisableSecurity |
<SwitchParameter> |
Specifies that security is being disabled on a specific node. | - |
-Port |
<Integer> |
Specifies the port on which NCache service is running. | 8250 |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | - |