Data Collection Commands

Altium Log File


ftlm_parse_altiumlog: Usage Message

SYNOPSIS:
    Parses and loads checkouts found in an Altium debug log.

USAGE:
    % ftlm_parse_altiumlog <ARGUMENTS> [OPTIONS]

ARGUMENTS:
    -dir <dir>             -- Directory that contains debug logs to parse.
                              Only files named with the format of SS.YYYYMMDD
                              are parsed.
    -f <file>              -- Specific log file to parse. Ignored if -dir is
                              passed. On Windows, use / for the path delimiter
                              and // before each space if there are spaces in
                              the path.
    -h                     -- Show help message.

OPTIONS:
    -tag   <tag>           -- Tag to be used for data contained in file.
    -host  <host>          -- Name of license server host. Default: master.
    -start <timestamp>     -- Ignore all events before this timestamp.
    -tz    <timezone>      -- Set to timezone which was used to generate the
                              debug log. Ex: PST8PDT. If debug log was
                              generated in the same timezone as the LM
                              server, leave blank.
    -noload                -- Do not load parsed data into the database.
    -loadonly              -- Do not parse debug log for new data, only load
                              previously parsed data into the database.
    -force                 -- Reparse data that has been previously parsed.
    -q                     -- Set verbosity to 0.
    -v                     -- Increase verbosity (may be repeated).

EXAMPLES:
    % ftlm_parse_altiumlog -tag ALTIUM -dir /remote/licenses/logs
    % ftlm_parse_altiumlog -tag ALTIUM -f SS.20100701.log -tz EST5EDT
    % ftlm_parse_altiumlog -tag ALTIUM -f SS.log -tz UTC-8

BETA CAE BETA LM


ftlm_parse_beta: Usage Message

USAGE:
    ftlm_parse_beta [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_beta BETA beta_lm_stat -h betalmsrv1 -a
    % ftlm_parse_beta BETA beta_lm_stat -h 6007@betalmsrv1 -a
    % ftlm_parse_beta BETA beta_lm_stat -h betalmsrv1,betalmsrv2,betalmsrv3 -a

ClearCase


ftlm_parse_clearcase: Usage Message

USAGE:
    ftlm_parse_clearcase [OPTIONS] TAG COMMAND ARGS

OPTIONS:
    -h        -- Print help message.
    -v        -- Increase output verbosity.
    -host     -- Specify license server host.
    -port     -- Specify license server port.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLE:
    % ftlm_parse_clearcase CLEARCASE clearlicense
    % ftlm_parse_clearcase -host CLEARCASE-SERVER -port 7744
                           CLEARCASE clearlicense

Wibu Codemeter Log File


ftlm_parse_codemeterlog: Usage Message

SYNOPSIS:
    Parses and loads checkouts found in a Code Meter debug log.

USAGE:
    % ftlm_parse_codemeterlog <ARGUMENTS> [OPTIONS]

ARGUMENTS:
    -dir <dir>             -- Directory that contains debug logs to parse.
                              Only files named with the format of
                              CodeMeter*.log are parsed.
    -f <file>              -- Specific log file to parse. Ignored if -dir is
                              passed. On Windows, use / for the path delimiter
                              and // before each space if there are spaces in
                              the path.
    -h                     -- Show help message.

OPTIONS:
    -tag   <tag>           -- Tag to be used for data contained in file.
    -host  <host>          -- Name of license server host. Default: master.
    -start <timestamp>     -- Ignore all events before this timestamp.
    -tz    <timezone>      -- Set to timezone which was used to generate the
                              debug log. Ex: PST8PDT. If debug log was
                              generated in the same timezone as the LM
                              server, leave blank.
    -noload                -- Do not load parsed data into the database.
    -loadonly              -- Do not parse debug log for new data, only load
                              previously parsed data into the database.
    -force                 -- Reparse data that has been previously parsed.
    -q                     -- Set verbosity to 0.
    -v                     -- Increase verbosity (may be repeated).

EXAMPLES:
    % ftlm_parse_codemeterlog -tag CodeMeter -dir /remote/licenses/logs
    % ftlm_parse_codemeterlog -tag CodeMeter 
                              -f CodeMeter2016-02-04-140221.log -tz EST5EDT
    % ftlm_parse_codemeterlog -tag CodeMeter 
                              -f CodeMeter2016-02-04-140221.log -tz UTC-8

Dassault DSLS


ftlm_parse_dsls: Usage Message

USAGE:
    ftlm_parse_dsls [OPTIONS] TAG HOST PORT COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.
    -usekeystore        -- The server is secured by a password. The parser
                           will look for a <TAGNAME>.ks file in the vovlmd
                           directory and use it for authentication
                           (see DSLS docs).
    -robust             -- Ignore unparsable license usage lines

    On Windows, use / for the path delimiter and // before each space if
    there are spaces in the command path.

EXAMPLES:
    % ftlm_parse_dsls DASSAULT dslssrv 9999 DSLicSrv

Dassault DSLS Log File


ftlm_parse_dslslog: Usage Message

SYNOPSIS:
    Parses and loads denials, and optionally checkouts, found in a Dassault
    DSLS debug log.

USAGE:
    % ftlm_parse_dslslog <ARGUMENTS> [OPTIONS]

ARGUMENTS:
    -dir <dir>             -- Directory that contains debug logs to parse.
                              Only files named with the format of debug.
                              YYYYMMDD are parsed.
    -f <file>              -- Specific log file to parse. Ignored if -dir
                              is passed. On Windows, use / for the path
                              delimiter and // before each space if there
                              are spaces in the path.
    -h                     -- Show help message.

OPTIONS:
    -tag   <tag>           -- Tag to be used for data contained in file.
    -host  <host>          -- Name of license server host. Default: master.
    -start <timestamp>     -- Ignore all events before this timestamp.
    -tz    <timezone>      -- Set to timezone which was used to generate the
                              debug log. Ex: PST8PDT. If debug log was
                              generated in the same timezone as the LM
                              server, leave blank.
    -checkouts             -- Parse checkout data in addition to denial data.
    -noload                -- Do not load parsed data into the database.
    -loadonly              -- Do not parse debug log for new data, only load
                              previously parsed data into the database.
    -force                 -- Reparse data that has been previously parsed.
    -q                     -- Set verbosity to 0.
    -v                     -- Increase verbosity (may be repeated).

EXAMPLES:
    % ftlm_parse_dslslog -tag DSLSLOG -dir /dassault/ldslslog
    % ftlm_parse_dslslog -tag DSLSLOG -f LicenseServer20140630221630.log
                         -tz EST5EDT
    % ftlm_parse_dslslog -tag DSLSLOG -f LicenseServer20140630221630.log
                         -tz UTC-8

FlexNet Publisher


ftlm_parse_flexlm: Usage Message

SYNOPSIS:
    ftlm_parse_flexlm [OPTIONS] TAG stat|info LMSTAT_COMMAND_...

OPTIONS:
    -v                  -- Increase verbosity.
    -site "SITENAME"    -- Assign site for source of data.
    -trackdisplay       -- Track display field. The display field is normally
                           used to indicate what display was used for a
                           checkout. There are cases where some vendors use
                           the display field store information that is not
                           related to the display and some cases where the
                           display contains spaces and other special
                           characters. Because of this, the display field in
                           the checkout line is ignored by default.
    -tracksubfeatures   -- Track subfeature field. A subfeature is a special
                           field that follows the display field and is most
                           often used to indicate that a specific function of
                           a feature is being utilized. An example would be
                           when a token-based feature is checked out, the
                           subfeature will contain the tool that was enabled
                           as a result of checking out the token-based
                           feature. Some vendors use spaces in this field, or
                           the display field (see above), which will result
                           in false subfeatures.  Because of this, the
                           subfeatures field is ignored by default.
    -trackallsubfeatures -- Track all subfeatures, even those not in the list.
                           If this is on, it implies '-tracksubfeatures' is
                           on, and also track subfeatures not in the list,
                           possibly false ones.
    -trackreservations  -- Track reservations. Reserved licenses that are not
                           used are considered checkouts by LicenseMonitor if
                           this option is enabled. The checkouts are for a
                           special user, beginning with "r:", that includes
                           the reservation object name, so that these
                           checkouts can be distinguished from real usage in
                           the LicenseMonitor reports. Enabling this option
                           allows LicenseMonitor to quickly and easily
                           identify waste that is created as a result of
                           obsolete and overly aggressive reservations.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_flexlm  SNPS stat lmstat -a -c 1727@pluto
    % ftlm_parse_flexlm -site "NewYork" SNPS stat lmstat -a -c 1727@pluto

FlexNet Publisher Debug Log


ftlm_parse_debuglog: Usage Message

SYNOPSIS:
    Parses and loads denials, and optionally checkouts, found in a FLEXlm
    debug log. If TIMESTAMP lines are not included in the log file, either the
    -initialday argument must be used, or the debug log file name must include
    the starting date in the format of YYYYMMDD or YYYY.MM.DD. For parsing
    debug logs from triads, use the -host option to denote the server from
    which the data originates.

USAGE:
    % ftlm_parse_debuglog <ARGUMENTS> [OPTIONS]

ARGUMENTS:
    -dir <dir>             -- Directory that contains debug logs to parse.
                              Only files named with the format of debug.
                              YYYYMMDD are parsed.
    -f <file>              -- Specific log file to parse. Ignored if -dir is
                              passed. On Windows, use / for the path delimiter
                              and // before each space if there are spaces in
                              the path.
    -h                     -- Show help message.

OPTIONS:
    -initialday <date>     -- Specify initial date in MM/DD/YYYY format.
                              Required if log file was created with options
                              file, or if log lacks an initial TIMESTAMP
                              statement.
    -host  <host>          -- Name of license server host. If parsing debug
                              logs from triads, use this option to denote the
                              server from which the data originates.
                              Default: master.
    -tag   <tag>           -- Tag to be used for data contained in file.
    -start <timestamp>     -- Ignore all events before this timestamp.
    -tz    <timezone>      -- Set to timezone which was used to generate the
                              debug log. Ex: PST8PDT. If debug log was
                              generated in the same timezone as the LM
                              server, leave blank.
    -checkouts             -- Parse checkout data in addition to denial data.
    -noload                -- Do not load parsed data into the database.
    -loadonly              -- Do not parse debug log for new data, only load
                              previously parsed data into the database.
    -nomerge               -- The checkout records are loaded with origin=6,
                              which means that no merging can be performed.
                              Note: As no merging algorithm is implemented
                              for now, so this is equivalent to origin=2
                              (i.e. logs)
    -force                 -- Reparse data that has been previously parsed.
    -q                     -- Set verbosity to 0.
    -v                     -- Increase verbosity (may be repeated).

EXAMPLES:
    % ftlm_parse_debuglog -tag EDA -dir /remote/licenses/logs
    % ftlm_parse_debuglog -tag CDN -f debug.log -initialday 07/01/2010
    % ftlm_parse_debuglog -tag SNP -f debug.20100701.log -tz EST5EDT
    % ftlm_parse_debuglog -tag MGC -f debug.log -checkouts -tz UTC-8

FlexNet Publisher Options File


ftlm_parse_flexlmoptions: Usage Message

DESCRIPTION:
  A parser to track the change of FLEXlm License option files.

SYNOPSYS:
  ftlm_parse_flexlmoptions [OPTIONS] TAGNAME FILE

OPTIONS:
   -v      -- Increase verbosity
   -h      -- This help

EXAMPLES:
  % ftlm_parse_flexlmoptions SNPS license.opt
  % ftlm_parse_flexlmoptions -v -v CDS license2.opt

Fujitsu ICAD


ftlm_parse_icad: Usage Message

SYNOPSIS:
    A script to parse the output of Fujitsu's ICAD license manager. This
    license manager is known to output unsupported 2-byte characters (namely,
    Japanese characters). If parsing such an instance, a wrapper script will
    need to be used that converts these characters to ASCII characters.

USAGE:
    ftlm_parse_icad [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_icad ICAD LicMon.bat

GNS


ftlm_parse_gns: Usage Message

USAGE:
    ftlm_parse_gns [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_gns GNS licstat ALL serverhost

Green Hills


ftlm_parse_ghs: Usage Message

USAGE:
    ftlm_parse_ghs [OPTIONS] TAG COMMAND

OPTIONS:
    -h               -- Print help message.
    -v               -- Increase output verbosity.
    -acp <timespec>  -- Artificial Check-in period.

NOTE:
    On Windows, use / for the path delimiter and // before each space
    if there are spaces in the command path.

EXAMPLES:
    % ftlm_parse_ghs GHS find_ghs_licenses -w 

Green Hills Legacy (Elan)


ftlm_parse_elan: Usage Message

SYNOPSIS:
    Executes the Elan license status command and parses its output to
    discover capacity and utilization information so that it can be recorded
    into server memory.
    
SYNTAX:
    ftlm_parse_elan TAG [OPTIONS]

OPTIONS:
    -command COMMAND  -- Specify status command.
                         Default: elmadmin -l (rely on path)
    -daemon DAEMON    -- Specify license server daemon (informational only).
                         Default: ghs
    -port PORT        -- Specify license server port (informational only).
                         Default: 0
    -site SITENAME    -- Specify license server site.
                         Default: local
    -type TYPE        -- Specify license server type.
                         Default: ghs
    -h                -- Show this help.
    -v                -- Increase output verbosity, can be repeated.
    -quiet            -- Do not echo status command output.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_ghs ELAN
    % ftlm_parse_ghs ELAN -site "NewYork" -command "/opt/local/bin/elmadmin"

LSTC


ftlm_parse_lstc: Usage Message

USAGE:
    ftlm_parse_lstc [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_lstc LSTC lstc_qrun
    % ftlm_parse_lstc LSTC lstc_qrun -s lstcsrv1

IBM LUM


ftlm_parse_lum: Usage Message

USAGE:
    ftlm_parse_lum [OPTIONS] TAG stat|info COMMAND ARGS

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.
    -host <lum_server>  -- Constrain to specified LUM servers. Separate
                           multiple servers with commas.
    -port <port>        -- Specify license server port for display purposes.
    -tracktestlics      -- Enable tracking of common test licenses found in
                           LUM, such as iFOR Test Product and HAL Test
                           Product.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_lum LUM stat i4blt -s
    % ftlm_parse_lum -host lum1,lum2,lum3 LUM info i4blt -lp -i
    % ftlm_parse_lum -port 7744 LUM stat ssh rmtsrv LUMblt -s

IBM LUM Denials


ftlm_parse_lum_denials: Usage Message

DESCRIPTION:
   Parse a LUM report for denial events.

SYNOPSIS:
    % ftlm_parse_lum_denials -tag TAGNAME [OPTIONS]

OPTIONS:
    -cmd                   -- Specify LUM command to use. Default: LUMblt.
    -host   <lum server>   -- Constrain to specified LUM servers. Use commas
                              to separate multiple hosts.
    -noload                -- Do not load denial data into database.
    -tz     <timezone>     -- Set to timezone which was used to generate the
                              denial events. Ex: PST8PDT. 
                              If denial events were generated in the same
                              timezone as the LM server, leave blank.
    -tracktestlics         -- Enable tracking of common test licenses found in
                              LUM, such as iFOR Test Product and HAL Test
                              Product.
    -h                     -- Show this help.    
    -v                     -- Increase verbosity. Repeatable.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_lum_denials -tag LUM1 i4blt -r 1
    % ftlm_parse_lum_denials -tag LUM1 -host lnxlum1 ssh rmtsrv i4blt -r 1
    % ftlm_parse_lum_denials -tag LUM1 -host lnxlum1,lnxlum2
       -tz EST5EDT i4blt -r 1

Wolfram MathLM


ftlm_parse_mathlm: Usage Message

USAGE:
    ftlm_parse_mathlm [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_mathlm MATHLM monitorlm

OLicense


ftlm_parse_olicense: Usage Message

USAGE:
    ftlm_parse_olicense [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_olicense OLicense olixtool -OLicenseServer
        simpack-srv01:17010

QF-Test


ftlm_parse_qftest: Usage Message

USAGE:
    ftlm_parse_qftest [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_qftest QFTEST /usr/local/qftest/bin/qftest -batch
       -licenseserver.dump -licenseserver.password xxxxxxxx

Remote LicenseMonitor


lm_parse_remotelm: Usage Message

Utility that will obtain and load data from a remote LicenseMonitor instance
into a local instance.

    lm_parse_remotelm -host <host> -site <site> <TAGSPECS> [OPTIONS]

Arguments:

    -host                    Define the remote LM server host. This can
                             be either a DNS name or IP address.
    -site                    Define the site name that will be displayed
                             in the local LM instance.

Tag Specs:

    -tagprefix <prefix>      By default, all remote tags are processed.
                             Use this argument to specify a name prefix
                             for local copy of remote tags.
    -remotetag <tag>         Specify a single remote tag from which to
                             gather data.
    -localtag <tag>          Used to specify the local tag name when
                             -remotetag is used. If specified,
                             -localtagprefix setting is ignored.

Options:

    -port <port>             Remote LM server port. Defaults to 5555.

Examples:

    % lm_parse_remote -host uklmsrv -remotetag snps -localtag UK_snps
    % lm_parse_remote -host uklmsrv -tagprefix UK_

Reprise RLM


ftlm_parse_rlmstat: Usage Message

USAGE:
    ftlm_parse_rlmstat [OPTIONS] TAG HOST PORT COMMAND

OPTIONS:
    -h               -- Print help message.
    -v               -- Increase output verbosity.
    -acp <timespec>  -- Artificial Check-in period.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_rlmstat RTDA localhost 7070 rlmstat -a

Altair License Key File (RTDAKEY)


ftlm_parse_rtdakey: Usage Message

DESCRIPTION:
  A parser to track the usage of VOV Key Licenses.

SYNOPSYS:
  ftlm_parse_rtdakey [OPTIONS] TAGNAME PROJECT@HOST:PORT

OPTIONS:
   -v      -- Increase verbosity
   -h      -- This help

EXAMPLES:
  % ftlm_parse_rtdakey LMKEY licmon@jupiter:5555
  % ftlm_parse_rtdakey -v -v NCKEY vnc@pluto:6271

Sentinel HASP


ftlm_parse_hasp: Usage Message

USAGE:
    ftlm_parse_hasp [OPTIONS] TAG HOST COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.
    -trackdisplay       -- Track display field. The display field is normally
                           used to indicate what display was used for a
                           checkout. There are cases where some vendors use
                           the display field store information that is not
                           related to the display and some cases where the
                           display contains spaces and other special
                           characters. Because of this, the display field in
                           the checkout line is ignored by default.

NOTES:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_hasp HASP sentlmsrv1 vovhaspstat

Sentinel RMS


ftlm_parse_sentinel: Usage Message

USAGE:
    ftlm_parse_sentinel [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.
    -trackdisplay       -- Track display field. The display field is normally
                           used to indicate what display was used for a
                           checkout. There are cases where some vendors use
                           the display field store information that is not
                           related to the display and some cases where the
                           display contains spaces and other special
                           characters. Because of this, the display field in
                           the checkout line is ignored by default.

NOTES:
    Some versions of Sentinel's lsmon utility on Windows have the behavior of
    requiring the enter key to be pressed at the end of its output dump. This
    means that when executed as a background task in LicenseMonitor, the task
    will never end. If the lsmon utility being interfaced with exhibits this
    behavior, make a copy of the vovlsmon.bat script template found in
    $VOVDIR/bat and place it somewhere outside of the $VOVDIR directory.
    Modify it to point to the lsmon.exe being interfaced with, then configure
    the status command to point to this script instead of lsmon.exe directly.

    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_sentinel SENTINEL lsmon sentlmsrv1

Silvaco


ftlm_parse_silvaco: Usage Message

USAGE:
    ftlm_parse_silvaco [OPTIONS] TAG COMMAND
    
OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.
    -host               -- Set artificial server host to show in reports.
                           Default: Obtain from sflm output.
    -port               -- Set artificial server port to show in reports.
                           Default: Obtain from sflm output. 
                           If not present, 0.
    
NOTE:
    On Windows, use / for the path delimiter and // before each space if
    there are spaces in the command path.
    
EXAMPLES:
    % ftlm_parse_silvaco SILVACO sflm
    % ftlm_parse_silvaco SILVACO /remote/tools/silvaco/bin/sflm

T-Systems LICMAN


ftlm_parse_tsystems: Usage Message

USAGE:
    ftlm_parse_licman [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_tsystems TSYSTEMS /opt/tsystems/bin/licman20_appl

X-Formation LM-X


ftlm_parse_lmx: Usage Message

USAGE:
    ftlm_parse_lmx [OPTIONS] TAG COMMAND

OPTIONS:
    -h                  -- Print help message.
    -v                  -- Increase output verbosity.

NOTE:
    On Windows, use / for the path delimiter and // before each space if there
    are spaces in the command path.

EXAMPLES:
    % ftlm_parse_lmx LMX lmxendutil -licstat
    % ftlm_parse_lmx LMX lmxendutil -licstat -host lmxsrv
    % ftlm_parse_lmx LMX lmxendutil -licstat -host lmxsrv -port 6200