Add-NodeSecurity
Note
This feature is only available in NCache Enterprise edition.
Add-NodeSecurity cmdlet configures server node level security so that
NCache tasks can be performed.
Add-NodeSecurity [-AddUser] [-AdminPassword] [-AdminUserID] [-DeleteUser] [-DisableSecurity] [-DomainController] [-EnableSecurity] [-NewUser] [-NewUserPassword] [-NodeName] [-NoLogo] [-Password] [-Port] [-RemoveUser] [-UserId] [-WriteToServiceConfig]
These properties are explained in detail in the Properties section.
Examples
- The following command adds new user david_watson to security list on node 20.200.20.11 which has administrator john_smith. This writes the credentials to security.ncconf.
Add-NodeSecurity -AddUser -NewUser david_watson –NewUserPassword newpassword -NodeName 20.200.20.11 -AdminUserID john_smith -AdminPassword myPassword -DomainController pdc
- The following command deletes existing user david_watson from the security list on node 20.200.20.11 which has administrator john_smith.
Add-NodeSecurity -RemoveUser -DeleteUser john_smith -NodeName 20.200.20.11 -AdminUserID john_smith -Password myPassword -DomainController pdc
- The following command enables security on node 20.200.20.11 which has administrator john_smith.
Add-NodeSecurity –EnableSecurity -NodeName 20.200.20.11 -AdminUserID john_smith -AdminPassword myPassword -DomainController pdc
- The following command disables security on node 20.200.20.11 which has administrator john_smith.
Add-NodeSecurity –DisableSecurity -NodeName 20.200.20.11 -AdminUserID john_smith -AdminPassword 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 |
|---|---|---|---|
-AddUser |
<SwitchParameter> |
Specifies that the cmdlet is being used for adding a user to NCache node administrators. | - |
-RemoveUser |
<SwitchParameter> |
Specifies that the cmdlet is being used for removing a user from NCache node administrators. | - |
-EnableSecurity |
<SwitchParameter> |
Specifies that the cmdlet is being used for enabling security on a specific node. | - |
-DisableSecurity |
<SwitchParameter> |
Specifies that the cmdlet is being used for disabling security on a specific node. | - |
-NewUser |
<String> |
Specifies the new user name to add. | - |
-NewUserPassword |
<String> |
Password of new user. This is an OPTIONAL parameter. Only useful for secured auto-start caches. | - |
-WriteToServiceConfig |
<SwitchParameter> |
Specifies whether to write to service configurations. If specified, the tool will write user name and password (encrypted) in NCache.Service.exe.config file for caches that require security credentials during auto-start. | - |
-DeleteUser |
<SwitchParameter> |
Specifies the existing user which is now being deleted or removed from NCache node administrators. | - |
-NodeName |
<String> |
Specifies the target node. | - |
-AdminUserID |
<String> |
Specifies the NCache administrator name. | - |
-AdminPassword |
<String> |
Specifies the NCache administrator password. | - |
-DomainController |
<String> |
Specifies the domain controller. | - |
-Port |
<Integer> |
Specifies the port on which NCache service is running. | 8250 |
-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. | - |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | - |