What does Unregister-NCacheLicense do?

Unregister-NCacheLicense deactivates an NCache license so that it can be used to activate another machine.

Does Unregister-NCacheLicense support offline deactivation?

Yes. Use OfflineDeactivate to generate a Deactivation Request URL, then open that URL on a computer with internet access to complete the deactivation.

Can Unregister-NCacheLicense connect using mutual TLS?

Yes. Use TlsCertPath to supply a client PEM certificate when connecting from a machine without an NCache installation to a server requiring mutual TLS. Provide TlsCertPassword only when the private key is encrypted.

Which server does Unregister-NCacheLicense use by default?

If Server is not specified, the cmdlet uses the local machine.

Unregister-NCacheLicense

The Unregister-NCacheLicense PowerShell cmdlet deactivates an NCache license on a machine so that the license can be used to activate another machine. It supports online and offline deactivation and connections to NCache servers configured with mutual TLS (mTLS).

Unregister-NCacheLicense [-Key] [-OfflineDeactivate] `
                         [-Server] [-Port] [-NoLogo] `
                         [-TlsCertPath] [-TlsCertPassword] `
                         [-Credentials]

Examples

This command deactivates NCache on the local server.

Unregister-NCacheLicense -Key xxxxxxxx-xxxxxx-xxxxxxxx

This command deactivates NCache on server 20.200.20.11.

Unregister-NCacheLicense -Key xxxxxxxx-xxxxxx-xxxxxxxx -Server 20.200.20.11

This command generates a Deactivation Request URL for offline deactivation. Copy the URL to another computer with internet access and open it there to complete license deactivation.

Unregister-NCacheLicense -Key xxxxxxxx-xxxxxx-xxxxxxxx -OfflineDeactivate

This command deactivates NCache on server 20.200.20.11 from a machine where NCache is not installed, when the server requires mutual TLS (mTLS). If the client certificate is password-protected, specify its password using the -TlsCertPassword parameter.

Unregister-NCacheLicense -Key xxxxxxxx-xxxxxx-xxxxxxxx -Server 20.200.20.11 `
                         -TlsCertPath "C:\certs\client.pem" `
                         -TlsCertPassword "clientKeyPassword"

Omit -TlsCertPassword if the private key is not encrypted.

Properties

Note

The parameters shown in the syntax are optional according to the supplied help. The deactivation examples use -Key to identify the license being deactivated.

Parameters	Data Types	Description	Default Value
`-Key`	`<String>`	Specifies the deactivation key for the license to deactivate.	-
`-OfflineDeactivate`	`<SwitchParameter>`	Generates a Deactivation Request URL for deactivating a server without internet access. Open the URL on another computer with internet access to complete deactivation.	False
`-Server`	`<String>`	Specifies the server where the NCache Service is running.	Local machine
`-Port`	`<Long>`	Specifies the port used to communicate with the NCache Service.	-
`-TlsCertPath`	`<String>`	Specifies the path to the client PEM certificate used when connecting to an NCache server that requires mTLS. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. 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 certificate is used automatically. Relative paths are resolved against the current PowerShell location. A certificate can be generated using `New-NCacheTlsCertificate`.	-
`-TlsCertPassword`	`<String>`	Specifies the password for the encrypted private key in the PEM file provided through `-TlsCertPath`. Omit this parameter for an unencrypted private key. The password is used only for the current command's connections and is not saved in the server configuration.	-
`-Credentials`	`<pscredential>`	Specifies the credentials required to authorize access to the NCache server. The user must have appropriate permissions on the node.	-
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

Unregister-NCacheLicense

Examples

Properties

Note

Contact Us