1.2. Using the Ansys Licensing Settings Utility

To run Licensing Settings utility on Windows, choose Start> Ansys 2024 R2> Ansys Licensing Settings 2024 R2.

To run the utility on Linux, type the following:

/ansys_inc/v242/licensingclient/linx64/LicensingSettings

To use the utility, select an action from the list of options on the left.

Command Line Interface Options

Log in to and out of your Ansys ID account:

LicensingSettings account login

LicensingSettings account logout

Options:

--help Show help [boolean]

--token Token file or string [string]

--input Login with the token file generated on the AnsysID portal

Examples:

LicensingSettings account login --input "path/to/file.json"

Login using a token from a file.

LicensingSettings account login --token "TOKEN STRING"

Login using a token string.

LicensingSettings account login

Log into your Ansys ID account. If already logged in, show logged-in user details.

LicensingSettings account logout

Log out of the currently signed in account.

 

1.2.1. Defining FlexNet Publisher License Servers

You are asked to specify your license server during the product installation if you have not done so during a previous product installation. If you did not specify your license server during the product installation, or if your license server has changed, use the FlexNet Publisher > License Servers option to define the FlexNet Publisher server, default communications port and usage order. This information is stored in the ansyslmd.ini file.

  • To enable FlexNet publisher, toggle theEnabled option.

  • To add license servers, click the "plus" icon (located below the existing servers) and enter the communications port and server hostname(s) then click Test to verify the configuration. If the server is available, a green check mark is displayed to the right of the server information. Click Save to complete this process.

    Note:  To specify redundant triad servers, enter the hostname for each of the three servers in the spaces available.

  • To remove a license server, click the "minus" icon to the left of the appropriate server and then click Save to complete this process.

  • To adjust the order of the servers in your list, click and hold the "double arrow" icon to the left of the appropriate server and drag the selection to the new postion within your list. Click Save to complete this process. The order of the servers dictates the order in which they are queried when attempting to check out a license.

Note:  Unresponsive servers can slow the license check-out process. If a license server is likely to be offline or otherwise unresponsive for an extended time, consider removing it from the list.

Command Line Interface Options

Enable FlexNet Publisher:

LicensingSettings fnp enable

Options:

--help Show help [boolean]

Disable FlexNet Publisher:

LicensingSettings fnp disable

Options:

--help Show help [boolean]

Add FlexNet Publisher license server(s) to an existing configuration:

LicensingSettings fnp server add

Options:

--help Show help [boolean]

--input Add FlexNet Publisher license server(s) to existing configuration [required]

Examples:

LicensingSettings fnp server add --input 1055@server1

Adds 1055@server1 to the end of the servers list.

LicensingSettings fnp server add --input 1055@server1,1055@server2

Adds 1055@server1 and 1055@server2 to the end of the servers list.

LicensingSettings fnp server add --input 1055@server1:server2:server3

Adds the triad 1055@server1, 1055@server2, 1055@server3 to the end of the servers list.

Remove FlexNet Publisher license server(s) from an existing configuration:

LicensingSettings fnp server remove

Options:

--help Show help [boolean]

--input The server(s) to be removed from the configuration

--all Remove all the FlexNet Publisher license servers from existing configuration

Examples:

LicensingSettings fnp server remove --input 1055@server1

Removes 1055@server1 from the configured server list.

LicensingSettings fnp server remove --input 1055@server1,1055@server2

Removes 1055@server1 and 1055@server2 from the configured server list.

LicensingSettings fnp server remove --input 1055@server1:1055@server2:1055@server3

Removes the triad 1055@server1, 1055@server2, 1055@server3 from the configured server list.

LicensingSettings fnp server remove --all

Removes all servers from the list.

List configured FlexNet Publisher license server(s):

LicensingSettings fnp server list

Options:

--help Show help [boolean]

Set FlexNet Publisher license server(s), removing the previous configuration:

LicensingSettings fnp server set

Options:

--help Show help [boolean]

--input Set FlexNet Publisher license server(s), removing any previous configuration [string] [required]

Examples:

LicensingSettings fnp server set --input 1055@server1

Sets 1055@server1 as license server.

LicensingSettings fnp server set --input 1055@server1,1055@server2

Sets 1055@server1 and 1055@server2 as license servers.

LicensingSettings fnp server set --input 1055@server1:server2:server3

Sets the triad of 1055@server1, 1055@server2, 1055@server3 as license server.

 

1.2.2. Displaying Features Usage

Click the FlexNet Publisher > Features in Use option to display all features that are currently being used. This option displays:

  • The license server name

  • Current license file in use

  • Available license features

  • Available licenses per feature

  • Licenses used per feature

Command Line Interface Options

Get license feature status:

LicensingSettings fnp server in-use

Options:

--help Show help [boolean]

 

1.2.3. Borrowing Licensing Increments

Click the FlexNet Publisher > Borrowing option to display a drop-down menu containing a list of borrowable licensing increments (available only on Windows machines). License borrowing allows you to take a license for use while not connected to the network.

Note:  This feature is available after defining a FlexNet server.

To borrow license increments:

  1. From the Borrowing page, select the license increments you wish to borrow from the Borrowable Increments drop-down menu.

  2. Set the return date for each increment.

  3. When you have finished selecting your increments and setting the dates for each, click Borrow.

  4. When you are finished with the license increments, return to the Borrowing page and click Return for the appropriate increment or Return All to return all increments.

Command Line Interface Options

Borrow a License Increment from the License Server List:

LicensingSettings fnp borrow checkout

Options:

--help Show help [boolean]

--input Specify the increments to borrow from license server [required]

--expiry Expiration/return date [required]

Example:

LicensingSettings fnp borrow checkout --input "cfd_solve_level1","cfd_solve_level2" --expiry 2022-10-03

Borrows the increments "cfd_solve_level1" and "cfd_solve_level2" from license the server.

Return a license increment from the license server list:

LicensingSettings fnp borrow checkin

Options:

--help Show help [boolean]

--input Specify the borrowed increments to return to license server

--all Return all borrowed increments to license server

Example:

LicensingSettings fnp borrow checkin --input "cfd_solve_level1","cfd_solve_level2"

Returns "cfd_solve_level1" and "cfd_solve_level2" to license the server.

Get a list of currently borrowed increments:

LicensingSettings fnp borrow in-use

Options:

--help Show help [boolean]

List increments available for borrowing:

LicensingSettings fnp borrow list

Options:

--help Show help [boolean]

 

1.2.4. Operations on Shared Web Licenses

Click the Web Licensing > Shared option to display a list of Shared Web product licenses. Products are displayed along with the related "customers" (accountid). Multiple products with the same name, but with different customers, can be displayed.

License roaming allows you to take a license for use while not connected to the network. It is similar to Borrowing with FlexNet Publisher licenses.

To roam with Shared Web product licenses:

  1. From the Shared page, select the Roaming option.

  2. A list of available Shared Web product licenses is displayed. Click the Check Out button for the appropriate product.

  3. A dialog box is displayed, allowing you to select the number of product licenses you require and the return date for the licenses.

  4. When you have selected the number of licenses and the return date, click Check Out.

  5. Perform the above steps for all Shared Web product licenses you wish to roam with.

  6. When you are finished with the licenses, return to the Shared page and click Return for the appropriate licenses or Return All to return all licenses.

JSON File Property Specifications

accountId: The customer account to which this product is entitled.

available: The quantity of this product available to be checked out for the logged in Ansys ID account.

id: A unique identifier for a particular license entitlement. Can be used to checkout or checkin a specific product from a specific customer account.

name: Product name

partNumber: Product SKU

total: The maximum quantity potentially available for the logged in Ansys ID account.

version: The maximum version of client software this product license supports.

Command Line Interface Options

Enable Shared Web licensing:

LicensingSettings web shared enable

Options:

--help Show help [boolean]

Disable Shared Web licensing:

LicensingSettings web shared disable

Options:

--help Show help [boolean]

Roaming with a Shared Web Licenses:

LicensingSettings web shared products checkout

Options:

--help Show help [boolean]

--input Check out products specified in file

--name Name of the product to checkout

--count Count of the product to checkout, mandatory for each product name

--expires Expiry of the products in ISO8601 format date or duration [string]

Examples:

LicensingSettings web shared products checkout --name "Example Name 1" --count 234 --name "Example Name 2" --count 24 --expires "P3DT4H59M"

Checkout products using the CLI.

LicensingSettings web shared products checkout --input 'path/to/input/file.json'

Checkout products listed in a file.

The file should be a valid of valid JSON structure with following format:

  {
    "products": [
      {
        "name": "Example Name",
        "count": 23
      },
      {
        "partNumber": "PARTNUMBER",
        "count": 343
      },
      {
        "id": "ID",
        "count": 23
      }
    ],
    "expires": "ISO8601 format date or duration"
  }

The 'expires' field is optional; if not specified, existing checkout date will be used, in absence of which the default duration from the server will be used.

If multiple 'expires' are specified, the last one will be used for the checkout.

Return a Shared Web License:

LicensingSettings web shared products checkin

Options:

--help Show help [boolean]

--input Check in products specified in file

--all Check in all products of specified type

--name Check in products by name

--type Specify the type of products to checkin [choices: "roaming", "on-demand"]

Example:

LicensingSettings web shared products checkin --name "Example Name 1" --name "Example Name 2" --type roaming

Check in some products of type 'roaming'.

LicensingSettings web shared products checkin --all --type roaming

Check in all roaming products.

LicensingSettings web shared products checkin --type on-demand --all

Check in all on-demand products.

LicensingSettings web shared products checkin --input "path/to/file.json" --type roaming

Check in products specified in input file, of type roaming.

The file should be a valid of valid JSON structure with following format:

  {
    "products": [
      {
        "name": "Example Name"
      },
      {
        "partNumber": "PARTNUMBER"
      },
      {
        "id": "ID"
      }
    ]
  }

Note that the file used for checkout can also be used here, but 'count' will not be honored.

Get a List of Shared Web Licenses:

LicensingSettings web shared products in-use

Options:

--help Show help [boolean]

--type Product usage type [string] [required] [choices: "roaming", "on-demand", "all"] [default: "all"]

List Shared Web Licenses Available:

LicensingSettings web shared products list

Options:

--help Show help [boolean]

--output Get products list in the specified file [required]

Example:

The output would have product information in JSON structure with following format:

  {
    "id": "Unique identifier for this license asset",
    "partNumber": "Product SKU",
    "accountId": "Customer account this product is entitled to",
    "name": "Product name",
    "version": "Maximum version of client software this product license supports",
    "available": "Quantity of this product available to be checked out for the logged in Ansys ID account",
    "total": "Maximum quantity potentially available for the logged in Ansys ID account"
  }
 

1.2.5. Enabling Elastic Licensing

Click the Elastic Licensing option to enable elastic licensing and import your Elastic License Server and Elastic License Server PIN.

To enable elastic licensing:

  1. Toggle the Enabled option.

  2. Click Import CLS ID and CLS Pin and browse to the directory containing json file supplied by your elastic licensing administrator.

  3. Select the file and click Open.

  4. Click Save.

    This information is saved to your ansyslmd.ini file.

To disable elastic licensing:

  1. Toggle the Enabled option.

  2. Click Save.

To import new elastic server information:

If license administrator changes the PIN for the Elastic License Server, client-side users should perform the following steps.

  1. From the Elastic page, click the Import CLS ID and CLS Pin button.

  2. Browse to the directory containing json file supplied by your elastic licensing administrator.

  3. Select the file and click Open.

  4. Click Save.

    Your ansyslmd.ini file is updated, and the ID and PIN are displayed in the Ansys Licensing Settings utility.

Command Line Interface Options

Enable Elastic Licensing:

LicensingSettings web elastic enable

Options:

--help Show help [boolean]

Disable Elastic Licensing:

LicensingSettings web elastic disable

Options:

--help Show help [boolean]

Print Elastic Licensing Settings:

LicensingSettings web elastic list

The output can be passed into the 'set' command.

Options:

--help Show help [boolean]

Example:

LicensingSettings web elastic list > tmp.json

Configuring Elastic Licensing Settings:

LicensingSettings web elastic set

Configure Elastic Licensing settings via specified input file.

Options:

--help Show help [boolean]

Example:

LicensingSettings web elastic set --input tmp.json

 

1.2.6. Configuring a Proxy Server

Click the Web Licensing > Proxy option to display the proxy server configuration window.

To use the local machine proxy settings on the Windows platform, enable the Use machine proxy settings (Windows only) option.

To specify a proxy server, enable the Use specified proxy server option and the enter the Proxy Server Address, Username and Password for the server.

Command Line Interface Options

Displaying current proxy settings:

LicensingSettings web proxy list

Options:

--help Show help [boolean]

Define Proxy Settings:

LicensingSettings web proxy set

Options:

--help Show help [boolean]

--server Proxy server to be set (Example: https://localhost:8080). Use 'windows' to use Windows proxy settings. [required]

Examples:

LicensingSettings web proxy set --server windows

Set windows proxy as proxy server.

LicensingSettings web proxy set --server "http://<proxyserver>:<port>"

Set a proxy server via a URL (no authentication).

LicensingSettings web proxy set --server "http://<username>:<password>@<proxyserver>:<port>"

Set a proxy server via a URL (with authentication).

Test Proxy Settings:

LicensingSettings web proxy test

Options:

--help Show help [boolean]

--server Proxy server to test (Example: https://localhost:8080). Use 'windows' to test Windows proxy settings. [string] [required]

Examples:

LicensingSettings web proxy test --server windows

Test the windows proxy.

LicensingSettings web proxy test --server "http://<proxyserver>:<port>"

Test a proxy server via a URL (no authentication).

LicensingSettings web proxy test --server "http://<username>:<password>@<proxyserver>:<port>"

Test a proxy server via a URL (with authentication.)

Remove Proxy Settings:

LicensingSettings web proxy remove

Options:

--help Show help [boolean]

 

1.2.7. Setting License Service Priority

Click the Preferences > License service priority option to display the order in which the licenses are utilized.

  • To change the license service priority, click and hold the "double arrow" icon to the left of the appropriate license service and drag the selection to the new position within your list. Elastic web is always last and cannot be moved. After you have modified your list, click Save to retain your changes.

Command Line Interface Options

View the Current Priority of Licensing Services:

LicensingSettings preferences service list

Options:

--help Show help [boolean]

Set the Licensing Service Priority:

LicensingSettings preferences service set

Options:

--help Show help [boolean]

--input Set order of licensing services [choices: "FlexNet Publisher","Shared web","Elastic web"] [required]

Examples:

LicensingSettings preferences service set --input "Shared web","FlexNet Publisher","Elastic web"

Set the order of licensing services.

Resetting Licensing Service Priority:

LicensingSettings preferences service reset

Options:

--help Show help [boolean]

 

1.2.8. Setting HPC User Preferences

Click the Preferences > HPC priority option to display the HPC products that are available and the order in which HPC licenses are checked-out.

  • To change the license priority, click and hold the "double arrow" icon to the left of the appropriate license and drag the selection to the new position within your list. After you have modified your list, click Save to retain your changes.

  • To disable an HPC license, disable the check box to the left of the appropriate license and then click Save.

Command Line Interface Options

Enable an HPC License:

LicensingSettings preferences hpc enable

Options:

--help Show help [boolean]

--input HPC preference to enable [choices: Ansys HPC Pack,Ansys HPC,Ansys Discovery Ultimate Enterprise CPU Core Extension] [required]

Example:

LicensingSettings preferences hpc enable --input "Ansys HPC"

Enables “Ansys HPC”.

Disable an HPC Licensing:

LicensingSettings preferences hpc disable

Options:

--help Show help [boolean]

--input HPC preference to disable [choices: Ansys HPC Pack,Ansys HPC,Ansys Discovery Ultimate Enterprise CPU Core Extension] [required]

Example:

LicensingSettings preferences hpc disable --input "Ansys HPC"

Disables “Ansys HPC”.

List HPC License Priority:

LicensingSettings preferences hpc list

Options:

--help Show help [boolean]

Set the HPC License Priority:

LicensingSettings preferences hpc set

Options:

--help Show help [boolean]

--input HPC preference to enable [choices: Ansys HPC Pack,Ansys HPC,Ansys Discovery Ultimate Enterprise CPU Core Extension] [required]

Example:

LicensingSettings preferences hpc set --input "Ansys HPC","Ansys HPC Pack","Ansys Discovery Ultimate Enterprise CPU Core Extension"

Reset HPC License Priority:

LicensingSettings preferences hpc reset

Resets the HPC preferences to default state and order.

Options:

--help Show help [boolean]

Example:

LicensingSettings web elastic set --input tmp.json

 

1.2.9. Gathering Diagnostics

Clicking the Diagnostics option and then clicking Generate gathers various licensing-related files, logs and related information about your license client system and places them in a single directory as well as a compressed file. This feature is useful if you want to easily review the files from a single location, or if you need to send them to a technical support representative.

Command Line Interface Options

Gather Diagnostics:

LicensingSettings diagnostics

Options:

--version Show version

--help Show help [boolean]