community
cancel
Showing results for 
Search instead for 
Did you mean: 

Alteryx Designer Knowledge Base

Definitive answers from Designer experts.
Community v19.9

The latest release includes several enhancements designed to improve your Community experience!

Learn More

Common Commands for an Alteryx License Server (ALS) Admin

Moderator
Moderator
Created on

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 able to 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 set up 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:

 

 

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

 

 


Note: Trying to remove a key from the ALS? Set complete this command and set the seat count to zero!

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


Command:

 

 

flexnetlsadmin -server http://localhost:7070 -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 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 more complete list of all the product features mapped the ALS and the users activated. This will include the email address of the user, their device ID and the products activated.


Command:

 

 

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

 

 



Verbose Output:

This allows for the export of the verbose list into a .csv file or .txt file.


Command:

 

 

flexnetlsadmin -server http://localhost:7070 -authorize admin [Password] -licenses -verbose -out C:\[Path]\output.csv

 

 

 

RESERVATIONS:

What are reservations?

Reservations are a method of reserving a seat or seats on a license for a set user or group of users. This seat or seats will become inaccessible to all other users. Reservations will hold as many seats as requested or are left on the key, whichever limit is met first and will hold the seats until the reservation is updated or removed by the administrator.


How to set up a reservation:

Setting up a reservation is a two step process, the creation of the JSON file providing the ALS the specifications of the reservation (e.g. What key the user is holding, the user’s email"), and the upload of the reservation to the ALS through command line.


Creating the Reservation JSON:

The JSON file must contain the email of the user as well as all features that the user will have access to. There are multiple features for each product and it is necessary to list all the features of that product to properly hold the license. To identify the features for each product the ALS administrator can complete the ‘verbose’ command provided under ‘List and Reporting Commands’ or reach out to the Fulfillment team at fulfillment@alteryx.com.

Best Practice: Be sure to update the name of the reservation to the specific purpose of the reservation. In the example JSON we have named this reservation Demo, however this can be updated and should you have several reservations we recommend naming each one differently for better administration of the reservations. (EX: HR, Accounting, Project Alteryx)

Note: Multiple users can be included in a reservation through repeating the template as shown below for each user.


JSON Example:

{"name": "Demo","reservations": 
[{"hostId": {"type":"USER","value":"AlteryxUser1@alteryx.com“},
"reservationEntries": [{
"featureName": "Alteryx_Enterprise_Server",
"featureVersion": "1.0",
"featureCount": 1},

{"featureName": "FlowChartMode",
"featureVersion": "1.0",
"featureCount": 1},

{"featureName": "Unlimited_Cores",
"featureVersion": "1.0",
"featureCount": 1},

{"featureName": "AllowScheduler",
"featureVersion": "1.0",
"featureCount": 1}]

[{"hostId": {"type":"USER","value":"AlteryxUser2@alteryx.com“},

"reservationEntries": [{
"featureName": "Alteryx_Enterprise_Server",
"featureVersion": "1.0",
"featureCount": 1},

{"featureName": "FlowChartMode",
"featureVersion": "1.0",
"featureCount": 1},

{"featureName": "Unlimited_Cores",
"featureVersion": "1.0",
"featureCount": 1},

{
"featureName": "AllowScheduler",
"featureVersion": "1.0",
"featureCount": 1}]
}]}

Reservation Commands:

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

 

Best Practice: Be sure to save your JSON file to the Enterprise folder!

 

Uploading a Reservation:

This command completes the initial upload of the JSON file and makes the set reservation active.


Command: 

 

 

flexnetlsadmin -server http://localhost:7070 -authorize admin [Password] -reservations -load Reservation_JSON.json

 

 



Listing All Reservations:
List All Reservations provided a complete list of all reservations currently uploaded to the ALS. This list will include the name of the reservation and its group number.


Command:

 

 

flexnetlsadmin -server http://localhost:7070 -authorize admin [Password] -reservations

 

 



Note: Each reservation will be provided a unique group number, starting at 1 and no reservation number will be repeated, even if the former reservation with that number has been removed.

Removing a Single Reservation:
This command is used for removing a single reservation, and deletes the reservation based on the group number. The group number can be located through the List All Reservations command.


Command:

 

 

flexnetlsadmin -server http://localhost:7070 -authorize admin [Password] -reservations -delete -group #

 

 



Removing All Reservations:
This command will remove all current reservations uploaded to the ALS.


Command: 

 

 

flexnetlsadmin -server http://localhost:7070 -authorize admin [Password] -reservations -delete

 

 

 

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 a 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 it’s 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 being taken offline for the update duration.