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] [-AdminUserID] [-AdminPassword] [-DeleteUser] [-DisableSecurity] [-DomainController] [-EnableSecurity] [-NewUser] [-NewUserPassword] [-NodeName] [-NoLogo] [-RemoveUser] [-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 -AdminUserID john_smith -AdminPassword mypassword -NewUser david_watson -NewUserPassword userpassword -NewUserDN "CN=David Watson,OU=admin,DC=yourdomain,DC=org " -DomainController yourdomain.org -DomainControllerPort 389 -NodeName 20.200.20.11
- The following command adds a new user david_watson to the admin list on node 20.200.20.11 which has administrator john_smith. This writes the credentials to Alachisoft.NCache.Service.exe.config file. Writing these credentials to Alachisoft.NCache.Service.exe.config is required if you have one or more caches configured to auto-start.
Add-NodeSecurity -AddUser -AdminUserID john_smith -AdminPassword mypassword -NewUser david_watson -NewUserPassword userpassword -NewUserDN "CN=David Watson,OU=admin,DC=yourdomain,DC=org" -DomainController yourdomain.org -DomainControllerPort 389 -NodeName 20.200.20.11 -WriteToServiceConfig
Note
The WriteToServiceConfig parameter is used to populate the NCache service config file with the admin credentials. Now, if you restart the service and Auto Start Cache on Service Startup is enabled, these credentials will be used for authentication against the startup request.
- 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 -AdminUserID john_smith -AdminPassword mypassword -DeleteUser david_watson -DomainController yourdomain.org -DomainControllerPort 389 -NodeName 20.200.20.11
- The following command enables security on node 20.200.20.11 which has administrator john_smith.
Add-NodeSecurity -EnableSecurity -AdminUserID john_smith -AdminPassword mypassword -DomainController yourdomain.org -DomainControllerPort 389 -NodeName 20.200.20.11
- The following command disables security on node 20.200.20.11 which has administrator john_smith.
Add-NodeSecurity -DisableSecurity -AdminUserID john_smith -AdminPassword mypassword -DomainController yourdomain.org -DomainControllerPort 389 -NodeName 20.200.20.11
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 |
|---|---|---|---|
-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 information to add. | - |
-NewUserDN |
<String> |
Specifies the new user's distinguished name. | - |
-NewUserPassword |
<String> |
Password of new user. | - |
-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. | - |
-DomainControllerPort |
<Integer> |
Specifies the port on which domain controller is running. | 389 |
-Port |
<Integer> |
Specifies the port on which NCache service is running. | 8250 |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | - |