Alteryx Designer Desktop Knowledge Base

Definitive answers from Designer Desktop experts.

Common Commands for an Alteryx License Server (ALS) Admin

KylieF
Alteryx Community Team
Alteryx Community Team
Created

What is the Alteryx License Server?

 

The Alteryx License Server, or ALS, is a locally-hosted license server meant to help customers with network restrictions activate in an online environment. It is built to exist outside of a company’s network and communicate directly with our third-party licensing service, Flexera, but also communicate with user devices on secure local networks.

Check out our Help Documentation for all system requirements and prerequisites for setting up an ALS.

 

ALS Common Commands:

 

Initial Start-Up Commands:

All start-up commands are completed from the directory: C:/Program Files/Alteryx/LicenseServer/Server

 


Status Check:
Status Check confirms that the ALS service is running and can be used to confirm the health of the ALS and troubleshoot communication issues.


Command:

 

flexnetls.bat -status

 


Setting Up Commands:

All setup commands are completed from the directory: C:/Program Files/Alteryx/LicenseServer/Enterprise

Key Mapping:

Key Mapping is the primary command for adding or removing keys to your ALS. If the key has already been mapped, and you are increasing or decreasing the seat count allocated to the ALS, you will need to input the total amount you are allocating for the count number. This command will not add or subtract from an existing seat count but replace it.


Command:

 

Version 2018.3:
flexnetlsadmin -server http://localhost:7070 -authorize admin [Password] -activate -id 1234-abcd-2234-bbcd-3234-cbcd-4234-dbcd -count #

Version 2021.4+:

flexnetlsadmin -server http://localhost:7070/api/1.0/instances/~ -authorize admin [Password] -activate -id 1234-abcd-2234-bbcd-3234-cbcd-4234-dbcd -count #

In all versions, to map multiple license keys in a single command, append the following line to the above commands for each additional license key:

-activate -id [License Key] -count #

 


Note: Trying to remove a key from the ALS? Run the above command appropriate to your version of ALS and set the seat count to zero!

Password Update:
This command will update the password of the administrator to the newly specified password.


Command:

 

Version 2018.3:
flexnetlsadmin -server http://localhost:7070 -authorize admin [Old_Password] -users -edit admin [New_Password]

Version 2021.4+:

flexnetlsadmin -server http://localhost:7070/api/1.0/instances/~ -authorize admin [Old_Password] -users -edit admin [New_Password]

 


Best Practice: We recommend documenting your password as the ALS doesn’t currently have a password recovery system implemented. This command requires you to know your former password to update it.


List or Reporting Commands:

All list or reporting commands are completed from the directory: C:/Program Files/Alteryx/LicenseServer/Enterprise

List:
The list command provides a complete list of all the keys currently mapped to the ALS and their seat count.


Command:

 

licenseserveradmincmd.exe -s http://localhost:7070 -u admin -p [Password] -l

 


Verbose:
This command will provide a complete list of all the product features mapped to the ALS and activated users. This will include the email address of the user, their device ID and the products activated.


Command:

 

2018.3:
flexnetlsadmin -server http://localhost:7070 -authorize admin [Password] -licenses -verbose

2021.4+:

flexnetlsadmin -server http://localhost:7070/api/1.0/instances/~ -authorize admin [Password] -licenses -verbose

 


Tips and Tricks:

 

Multiple ALS Instances: While reservations allow for the ALS administrator to hold a specific seat for a user, if you do not want your users to have access to a license at all, a second ALS may be optimal. Examples of this are setting up an ALS for your Servers and one for your Designer users. This way, a user can’t accidentally activate a Server key!

Passwords: We recommend all ALS passwords be standardized and recorded. The ALS does have a time out period for too many failed commands with the wrong password.

Lone Wolf ALS: It’s best practice to put the ALS on its own server that is not shared with an Alteryx Server or Designer. While they don’t use the same ports for communication, they will compete for resources, and any updates to the ALS will require the Server or Designer to be taken offline for the update duration.



Additional Resources: