Try Playground
Show / Hide Table of Contents

Register-NCache - PowerShell Cmdlet

This PowerShell Cmdlet enables the user to activate/reactivate licenses, or extend evaluation for NCache, both online or offline.

Important

NCache OSS has different parameters in some Cmdlet instances.

  • Windows PowerShell
  • Linux CLI
Register-NCache [-Key] [-Environment] [-Clients] [-Address] [-City] [-Company] [-Country] [-Email] [-FirstName] [-LastName] [-Phone] [-Reactivate] [-State] [-ZipCode] [-AuthCode] [-Server] [-Port] [-Credentials] [-OfflineActivate] [-KeyType] -RegisterAs [-NoLogo]

Examples of Register-NCache - PowerShell Cmdlet

  • This command registers NCache on a local server with the given Server-Only license key for Production environment.
Register-NCache -Key xxxxxxxxx-xxxxxx-xxxxxxxx -Environment Production -FirstName John -LastName Smith -Email john@yourdomain.com -Company your_company_name
  • This command registers NCache on server 20.200.20.11 with the given Client-Server license key for a Production environment with 4 client licenses.
Important

Client Server Licensing:
For Client-Server licensing, you also need to specify the Client Licenses to activate on cache server.

Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@yourdomain.com -Company your_company_name -Server 20.200.20.11 -Environment Production -Clients 4
  • This command reactivates NCache on an already activated machine using the NCache license key.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@yourdomain.com -Company your_company_name -Server 20.200.20.11 -Environment Production -Clients 4 -Reactivate
  • This command activates the NCache image as a Remote Client installation when deploying as a Docker container or on a cloud platform.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@yourdomain.com -RegisterAs RemoteClient -Company your_company_name -Server 20.200.20.11 -Environment Production
  • This command generates an Activation Request Code URL for offline activation of NCache using NCache license key. Copy this URL to another computer with Internet access, open that URL to obtain "Activation Authorization Code". Copy that Authorization Code to this computer and complete your activation by running the following command.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@yourdomain.com -Company your_company_name -Server 20.200.20.11 -Environment Production -OfflineActivate
  • This command activates NCache license on local server with the given Authorization Code.
Register-NCache -AuthCode xxxxxxxxxxxxxx -OfflineActivate
  • This command extends evaluation of NCache on local server with the given extension key.
Register-NCache -Key xxxxxxxxxxxxx -FirstName John -LastName Smith -Email john@yourdomain.com -Company your_company_name -KeyType Extension
  • This command generates an Evaluation Extension Request Code URL for offline evaluation extension of NCache using NCache evaluation extension key. Copy this URL to another computer with Internet access, open that URL to obtain an "Evaluation Extension Authorization Code".
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@yourdomain.com -Company your_company_name -Server 20.200.20.11 -KeyType Extension -OfflineActivate
  • This command extends NCache evaluation on local server with the given Authorization Code.
Register-NCache -AuthCode xxxxxxxxxxxxxx -OfflineActivate
Tip

Reactivate NCache License:
You can reactivate NCache online/offline by specifying the Reactivate parameter in the Register-NCache command.

Properties

Note

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

Parameters Data Types Description Default Value
-Key* <String> Specifies the license key received from Alachisoft. -
-Environment <String> Environment name for which the machine is being activated. Only required at the time of activation/reactivation. -
-Clients* <Integer> Number of client licenses to be activated with the specified environment. Only required at the time of activation/reactivation for Client-Server (Containerized) Licensing. -
-Address <String> Specifies user's address to be registered. -
-City <String> Specifies user's city to be registered. -
-Company <String> Specifies user's company name to be registered.
-Country <String> Specifies user's country name to be registered. -
-Email* <String> Specifies user's email to be registered. -
-FirstName* <String> Specifies user's first name to be registered. -
-LastName* <String> Specifies user's last name to be registered. -
-Phone <String> Specifies user's phone number to be registered. -
-Reactivate <SwitchParameter> Represents reactivation of given license. False
-State <String> Specifies user's state to be registered. -
-Zip Code <String> Specifies user's zip code to be registered. -
-AuthCode* <String> Auth code is generated from the URL which is obtained when Register-NCache command is executed with the OfflineActivate parameter. This is provided by Alachisoft support department for offline activation -
-Server <String> Specifies server name address Local Machine
-Port <Long> Specifies the server port where NCache Service is listening. 8250
-Credentials <pscredential> Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node. -
-OfflineActivate <SwitchParameter> Represents offline activation/reactivation of a given license or extension of evaluation. When this switch is used, the command generates an "Activation/Extension Request Code URL". Copy this URL to another computer with an internet access, open that URL to obtain "Activation/Extension Authorization Code". Copy that code to the machine you are trying to activate/extend the evaluation for and complete your activation/reactivation or extension. False
-KeyType <String> Specifies whether the given key is either an 'Extension' key or a 'License' key. License
-RegisterAs <String> Specifies the installation type when registering a Docker container or on a cloud image. This parameter is applicable only for Docker or cloud image installations. Acceptable values include 'CacheServer', 'RemoteClient' and 'Developer'. Cache Server
-NoLogo <SwitchParameter> Suppresses display of the logo banner. True
register-ncache [-key] [-environment] [-clients] [-address] [-city] [-company] [-country] [-email] [-firstname] [-lastname] [-phonenumber] [-reactivate] [-state] [-zipcode] [-authcode] [-server] [-port] [-userid] [-password] [-offlineactivate] [-keytype] -registeras [-nologo]

Examples of Register-NCache

  • This command registers NCache on a local server with the given Server-Only license key for Production environment.
register-ncache -key xxxxxxxxx-xxxxxx-xxxxxxxx -environment Production -firstname John -lastname Smith -email john@yourdomain.com -company your_company_name
  • This command registers NCache on server 20.200.20.11 with the given Client-Server license key for a Production environment with 4 client licenses.
Important

Client Server Licensing:
For Client-Server licensing, you also need to specify the Client Licenses to activate on cache server.

register-ncache -key xxxxxxxx-xxxxxx-xxxxxxxx -firstname John -lastname Smith -email john@yourdomain.com -company your_company_name -server 20.200.20.11 -environment Production -clients 4
  • This command reactivates NCache on an already activated machine using the NCache license key.
register-ncache -key xxxxxxxx-xxxxxx-xxxxxxxx -firstname John -lastname Smith -email john@yourdomain.com -company your_company_name -server 20.200.20.11 -environment Production -clients 4 -reactivate
  • This command activates the NCache image as a Remote Client installation when deploying as a Docker container or on a cloud platform.
register-ncache -key xxxxxxxx-xxxxxx-xxxxxxxx -firstname John -lastname Smith -email john@yourdomain.com -registeras RemoteClient -company your_company_name -server 20.200.20.11 -environment Production
  • This command generates an Activation Request Code URL for offline activation of NCache using NCache license key. Copy this URL to another computer with Internet access, open that URL to obtain "Activation Authorization Code". Copy that Authorization Code to this computer and complete your activation by running the following command.
register-ncache -key xxxxxxxx-xxxxxx-xxxxxxxx -firstname John -lastname Smith -email john@yourdomain.com -company your_company_name -server 20.200.20.11 -environment Production -offlineactivate
  • This command activates NCache license on local server with the given Authorization Code.
register-ncache -authcode xxxxxxxxxxxxxx -offlineactivate
  • This command extends evaluation of NCache on local server with the given extension key.
register-ncache -key xxxxxxxxxxxxx -firstname John -lastname Smith -email john@yourdomain.com -company your_company_name -keytype Extension
  • This command generates an Evaluation Extension Request Code URL for offline evaluation extension of NCache using NCache evaluation extension key. Copy this URL to another computer with Internet access, open that URL to obtain an "Evaluation Extension Authorization Code".
register-ncache -key xxxxxxxx-xxxxxx-xxxxxxxx -firstname John -lastname Smith -email john@yourdomain.com -company your_company_name -server 20.200.20.11 -keytype Extension -offlineactivate
  • This command extends NCache evaluation on local server with the given Authorization Code.
register-ncache -authcode xxxxxxxxxxxxxx -offlineactivate

Properties

Note

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

Parameters Data Types Description Default Value
-key* <String> Specifies the license key received from Alachisoft. -
-environment <String> Environment name for which the machine is being activated. Only required at the time of activation/reactivation. -
-clients* <Integer> Number of client licenses to be activated with the specified environment. Only required at the time of activation/reactivation for Client-Server (Containerized) Licensing. -
-address <String> Specifies user's address to be registered. -
-city <String> Specifies user's city to be registered. -
-company <String> Specifies user's company name to be registered.
-country <String> Specifies user's country name to be registered. -
-email* <String> Specifies user's email to be registered. -
-firstname* <String> Specifies user's first name to be registered. -
-lastname* <String> Specifies user's last name to be registered. -
-phone <String> Specifies user's phone number to be registered. -
-reactivate <SwitchParameter> Represents reactivation of given license. False
-state <String> Specifies user's state to be registered. -
-zipcode <String> Specifies user's zip code to be registered. -
-authcode* <String> Auth code is generated from the URL which is obtained when Register-NCache command is executed with the OfflineActivate parameter. This is provided by Alachisoft support department for offline activation -
-server <String> Specifies server name address Local Machine
-Port <Long> Specifies the server port where NCache Service is listening. 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. -
-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. -
-offlineactivate <SwitchParameter> Represents offline activation/reactivation of a given license or extension of evaluation. When this switch is used, the command generates an "Activation/Extension Request Code URL". Copy this URL to another computer with an internet access, open that URL to obtain "Activation/Extension Authorization Code". Copy that code to the machine you are trying to activate/extend the evaluation for and complete your activation/reactivation or extension. False
-keytype <String> Specifies whether the given key is either an 'Extension' key or a 'License' key. License
-registeras <String> Specifies the installation type when registering a Docker container or on a cloud image. This parameter is applicable only for Docker or cloud image installations. Acceptable values include 'CacheServer', 'RemoteClient' and 'Developer'. -
-nologo <SwitchParameter> Suppresses display of the logo banner. True
In This Article
  • Examples of Register-NCache - PowerShell Cmdlet
  • Properties
  • Examples of Register-NCache
  • Properties

Contact Us

PHONE

+1 (214) 764-6933   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • NCache Enterprise
  • NCache Professional
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Download
Pricing
Try Playground

Deployments
  • Cloud (SaaS & Software)
  • On-Premises
  • Kubernetes
  • Docker
Technical Use Cases
  • ASP.NET Sessions
  • ASP.NET Core Sessions
  • Pub/Sub Messaging
  • Real-Time ASP.NET SignalR
  • Internet of Things (IoT)
  • NoSQL Database
  • Stream Processing
  • Microservices
Resources
  • Magazine Articles
  • Third-Party Articles
  • Articles
  • Videos
  • Whitepapers
  • Shows
  • Talks
  • Blogs
  • Docs
Customer Case Studies
  • Testimonials
  • Customers
Support
  • Schedule a Demo
  • Forum (Google Groups)
  • Tips
Company
  • Leadership
  • Partners
  • News
  • Events
  • Careers
Contact Us

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Contact Us
  •  
  • Sitemap
  •  
  • Terms of Use
  •  
  • Privacy Policy
© Copyright Alachisoft 2002 - 2025. All rights reserved. NCache is a registered trademark of Diyatech Corp.
Back to top