Checking DS License Server Availability

DSCheckLS is a command-line tool, installed in the licensing client runtime view, designed to contact the list of declared license servers and rapidly request and release a license to check that license servers are operating correctly, without having to run processes such as CATIA or DSLicMgt. DSCheckLS does not have a graphical interface, no shortcut is added in the Windows start menu, does not need an environment and can be run without using the catstart utility.

  1. On the license client, go to the directory:

    LicensingClientInstallPath\OS\code\bin

    for example:

    C:\Program Files\Dassault
              Systemes\B424\win_b64\code\bin

    and run the DSCheckLS -h command to get the command syntax:

    DSCheckLS [-h|-l|-r lic]

    where:

    • -l: displays the status of the license servers
    • -r lic: requests license "lic" enrolled on the license server.
    • -t lic: requests Token licenses enrolled on the license server.

    While the -r lic existing option requests Named User and Concurrent User type licenses, the -t lic option requests Token type licenses.

    Note: There is no option available to request Credit type licenses.

  2. Run the DSCheckLS -l command.

    DSCheckLS parses the DSLicSrv.txt client-side license server configuration file referencing the list of license servers and validates them.

    The command contacts the declared license servers and displays a status along with information about each contacted license server:

    • the pathname and contents of the DSLicSrv.txt file
    • server status: each status is described in the folowing table:
      StatusDescription
      RUNNINGLicense server up and running
      NOT_SYNCHRONIZEDLicense server and license client not time-synchronized
      HOST_UNREACHEABLEHost did not reply (for example, host has been shut down)
      NOT_RUNNINGHost is up, but license server process not available or down
      CANNOT_CONNECT
      INVALID_SERVER_RESPONSE
      NO_IP_ADDRESSUnable to get license server IP address
      INVALID_SERVER_VERSIONLicense server too old; minimum license server level required not present
      ALREADY_DECLARED Ignored: server is declared more than once in the DSLicSrv.txt file
      INVALID_SERVER_DECLARATION Incorrect license server declaration: incorrect format or invalid characters
      INVALID AUTHENTICATION DATA Missing or invalid authentication file (Managed Licensing Service only)
    • configuration type: STANDALONE or FAILOVER or MANAGED
    • version number
    • build date
    • if offline extraction is enabled or disabled
    • IP address
    • licensing port number
    • exchange message duration with server
    • OS name
    • OS version
    • OS architecture
    • computer id.

    For example:

    Dump of DSLS configuration file (C:\ProgramData\DassaultSystemes\Licenses\DSLicSrv.txt)
    ---------------
    ###### default licensing servers
    lw5sesdsy:4085
    ##servlic1dsy:4085
    ---------------
    1 license servers declared:
    lw5sesdsy:4085
       + status       : RUNNING
       + type         : STANDALONE
       + version      : 6.215.0
       + build date   : 14-Jan-2013 13:56
       + IP address   : 10.239.3.1
       + port         : 4085
       + OS name      : Windows 7
       + OS version   : 6.1
       + OS Arch      : amd64
       + computer id  : HRE-425A10DEF1780905
    

    In the following example, one license server is up and running, and one is not valid because the license server is too old:

    Dump of DSLS configuration file (C:\ProgramData\DassaultSystemes\Licenses\DSLicSrv.txt)
    ---------------
    ###### default licensing servers
    lw5sesdsy:4085
    servlic1dsy:4085
    ---------------
    2 license servers declared:
    lw5sesdsy:4085
       + status       : RUNNING
       + type         : STANDALONE
       + version      : 6.417.0
       + build date   : 14-Jan-2014 13:56
       + IP address   : 10.239.3.1
       + port         : 4085
       + OS name      : Windows 7
       + OS version   : 6.1
       + OS Arch      : amd64
       + computer id  : HRE-425A10DEF1780905
    servlic1dsy:4085
       + status       : INVALID SERVER LEVEL. DSLS V6R2013x or higher is required
       + type         : STANDALONE
       + version      : 6.417.0
       + build date   : 21-Oct-20 10:27
       + IP address   : 10.241.139.253
       + port         : 4085
       + OS name      : AIX
       + OS version   : 6.1
       + OS Arch      : ppc64
       + computer id  : IJX-0473637456F00E01

    If a server failover cluster is declared, all three servers in the cluster are managed.

  3. Run the DSCheckLS -r lic command, replacing "lic" by a real license name, for example like this: DSCheckLS -r IFW.

    This grants then releases the IFW license.

    If the request succeeds, the following information related to the granted license is displayed, for example:

    IFW successfully granted.
    #Granted license info:
    #           - feature             : IFW
    #           - internal_id         : DSCheckLS
    #           - status              : GRANTED
    #           - com_type            : STD
    #           - model               : NAMED_USER
    #           - exp_date            : 14-Sep-2013 01:59
    #           - nb_token            : 1
    #           - customer site       : DS HQ
    #           - customer country    : FRA
    #           - customer id         : DSFRA123
    #           - server              : lw5sesdsy
    #           - nb addditional infos: 0
    #           - postion in queue    : 0

    If the request fails, the reason is provided.

    Data such as authorization rules and MaxReleaseNumber are taken into account

  4. Run echo %errorlevel% for windwos or echo $? for linux to display return codes.

    Return codes and their meaning:

    001: Unexpected error
    002: Initialization failed
    003: Invalid argument or missing parameter
    004: Failed to open DSLS config file
    005: No server declaration found in DSLS config file
    006: Invalid server declaration
    007: Request to server failed due to SSL error
    008: Server not synchronized
    009: Server host not found
    010: Invalid server level
    011: Internal server error
    012: Server request timed out
    013: Failed to connect to server
    014: Same server declared multiple times
    015: Managed Licensing service unavailable
    016: Invalid authentication
    017: Missing authentication
    018: Unregistered authentication
    019: Authentication not yet available
    020: Authentication expired
    021: Authentication revoked
    022: Authentication loading failed
    023: Multiple authentication files found
    101: No license found
    102: No more license available
    103: Host not authorized
    104: IP address not authorized
    105: User not authorized
    106: Invalid feature name
    107: Invalid customer ID
    109: Requested license model is not available