Remove-NCacheUserOrGroup

This PowerShell cmdlet removes a user or group from the NCache security configuration. It allows you to specify the server, user or group name, access level, cache name (if applicable), administrative credentials, and to disable security. The cmdlet verifies the user's credentials, evaluates the access level, and then removes the specified user or group as required.

 Remove-NCacheUserOrGroup -Server -AccessLevel  `
                          [-CacheName] -UserOrGroupName `
                          -NodeAdminCredentials [-TlsCertPath] ` 
                          [-TlsCertPassword] 

Examples

• This command removes the administrator user David Watson from the NCache server with the IP address 20.200.20.11. Upon successful removal of the user, NCache security is also disabled for the server using credentials.

$nodeAdmin = Get-Credential `

Remove-NCacheUserOrGroup -Server 20.200.20.11 AccessLevel Admin `
                         -NodeAdminCredentials $nodeAdmin -UserOrGroupName david_watson

• This command removes the user David Watson from the defaultCache cache hosted on the server with the IP address 20.200.20.11.

$nodeAdmin = Get-Credential `

Remove-NCacheUserOrGroup -Server 20.200.20.11 -AccessLevel Cache `
                         -CacheName defaultCache -NodeAdminCredentials $nodeAdmin `
                         -UserOrGroupName david_watson

• This command removes the gMSA cache user user1gmsa$ from the cache named defaultCache on server 20.200.20.11. The credentials supplied through -NodeAdminCredentials are used to authorize the remove operation.

$nodeAdmin = Get-Credential

Remove-NCacheUserOrGroup -Server 20.200.20.11 `
                         -AccessLevel Cache -CacheName defaultCache `
                         -NodeAdminCredentials $nodeAdmin `
                         -UserOrGroupName user1gmsa$

• This command removes the group dev from the defaultCache cache hosted on the server with the IP address 20.200.20.11. Upon successful removal of the group, NCache security is also disabled for the server.

$nodeAdmin = Get-Credential

Remove-NCacheUserOrGroup -Server 20.200.20.11 -AccessLevel Cache `
                         -CacheName defaultCache -NodeAdminCredentials $nodeAdmin `
                         -UserOrGroupName dev

• This command removes david_watson from the Admin access list on the specified server, using the provided node administrator credentials. It runs from a machine where NCache is not installed and connects to the server using mutual TLS (mTLS). The client certificate C:\certs\client.pem authenticates the machine running the cmdlet, and -TlsCertPassword decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.

$nodeAdmin = Get-Credential

Remove-NCacheUserOrGroup -Server 20.200.20.11 -AccessLevel Admin `
                         -NodeAdminCredentials $nodeAdmin -UserOrGroupName david_watson `
                         -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters	Data Types	Description	Default Value
-Server*	<string>	Specifies the IP address of the NCache server from which the user or group is being removed.	-
-UserOrGroupName*	<string>	Specifies the name of the user or group being removed.	-
-AccessLevel*	<string>	Specifies whether the user or group being removed is a cache user or an admin user.	-
-CacheName	<string>	Specifies the name of the cache for which the user or group is being removed. This parameter is required when -AccessLevel is set to Cache.	-
-NodeAdminCredentials*	<pscredential>	Specifies the credentials of a user with sufficient privileges to remove a user or group from NCache.	-
-TlsCertPath	<string>	Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using New-NCacheTlsCertificate. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use -CustomCertificatePath.	-
-TlsCertPassword	<string>	Password used to load the encrypted private key in the PEM file specified by -TlsCertPath. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration.	-