What permissions does the admin user need to enable NCache security?

The user must be a registered LDAP/Active Directory user and must be configured as a 'Node Administrator' within NCache. Additionally, for remote execution on Windows nodes, the user should be part of the local 'Administrator' group on the target box to allow service-level configuration changes.

Why should I use the -WriteCredentialsToServiceConfig switch?

This switch securely encrypts and stores the admin credentials in the NCache service configuration. It is critical for high-availability environments because it allows secured caches to start automatically upon service reboot without requiring a manual login from an administrator.

How does Enable-NCacheSecurity authenticate users?

NCache utilizes LDAP-integrated security. When the cmdlet is executed, it validates the provided credentials against your primary or secondary Domain Controller. Once authenticated, NCache authorizes the user based on the roles defined in the security.ncconf file.

Can I enable security on multiple NCache servers at once?

Yes, the -Server parameter accepts a comma-separated list of IP addresses or hostnames, allowing you to activate security across an entire cluster simultaneously using a single PowerShell command.

Enable-NCacheSecurity

The Enable-NCacheSecurity PowerShell cmdlet enables server-level security on an NCache node by validating the provided administrative credentials against the configured LDAP or Active Directory provider, ensuring that only authorized NCache administrators can enable and manage secured caches. In addition to enforcing authentication and authorization for all cache operations, the cmdlet can optionally store encrypted credentials in the NCache service configuration, allowing caches configured for auto-start to initialize automatically during service startup or system reboot, making it especially useful for production environments that require secure, unattended cache availability.

Windows PowerShell
Linux CLI

Enable-NCacheSecurity -AdminCredentials -Server [-WriteCredentialsToServiceConfig] [-NoLogo]

Examples

This command enables NCache security on the server with the IP address 20.200.20.11. Before enabling security, it validates that John Smith has the necessary privileges on the server using credentials.

Enable-NCacheSecurity -Server 20.200.20.11 -AdminCredentials (Get-Credential john_smith)

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 -WriteCredentialsToServiceConfig 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.20.11 -AdminCredentials (Get-Credential john_smith) -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
`-AdminCredentials*`	`<pscredential>`	Specifies the credentials of an LDAP user with administrative rights on the given server.	-
`-Server*`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. You can specify 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.	-
`-WriteCredentialsToServiceConfig`	`<SwitchParameter>`	Specifies whether to write to service configurations.	False
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

enable-ncachesecurity -adminuserid -adminpassword -server [-writecredentialstoserviceconfig] [-nologo]

Examples

This command enables NCache security on the server with the IP address 20.200.20.11. Before enabling security, it validates that John Smith has the necessary privileges on the server using credentials.

enable-ncachesecurity -server 20.200.20.11 -adminuserid john_smith -adminpassword pass123

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 -writecredentialstoserviceconfig 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.20.11 -adminuserid john_smith -adminpassword pass123 -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
`-adminuserid*`	`<String>`	Specifies the user ID of an LDAP user with administrative rights on the given server. These credentials should belong to a user with the appropriate permissions at the node.	-
`-adminpassword*`	`<String>`	Specifies the password of an LDAP user with administrative rights on the given server. These credentials should belong to a user with the appropriate permissions at the node.	-
`-server*`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. You can specify 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.	-
`-writecredentialstoserviceconfig`	`<SwitchParameter>`	Specifies whether to write to service configurations.	False
`-nologo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

Enable-NCacheSecurity

Examples

Properties

Note

Contact Us