Firegen provides a command-line version of the analysis engine that can be used to scripting or scheduling with special requirements that exceeds the default scheduler service. Firegen40CLI will also provide a more verbose output and it may be helpful for troubleshooting.
The use the command-line analyzer, open a command-line prompt, navigate to the location where Firegen is installed (default: C:\Program Files\Altair Technologies\Firegen 4.0) and type the command:
This command will initiate the analysis of all the analysis profiles that have the “Include in scheduled analysis” option set.
To list the available options, use the -h argument:
FireGen 4.0 Command Line Interface
Copyright: Firegen Analytics Inc. – www.firegen.com
-n – Runs the analysis for all the scheduled profiles and does NOT open the report in the default browser.
-a analysis_profile_name – Runs the analysis just for the specified profile name. If the profile name contains spaces, please use quotations marks for the name.
-r number – Runs the analysis repeatedly for the specified number of times, incrementing the day at each iteration. Typically used to generate stats for anomaly detection.
-s date – The start date for repeat analysis (used in conjunction with option r and a in order to build stats for anomaly detection.
-i – Initialize the stats (removes previous stats).
By default, Firegen40CLI will open the report in the default browser as soon as the analysis is finished. For scheduled report this may not be the desired behaviour. To disable the opening of the report in the browser use the following command:
Firegen40CLI can also be used to analyze just on analysis profile, regardless of the “Include in the scheduled analysis” option, by using the “a” argument. For example, if the name of the defined analysis profile is CiscoASA5585, to run the analysis use the following command:
Firegen40CLI -n -a CiscoASA5585
The CLI can also be used to build a baseline for the Firegen anomaly detection engine. Typically, 30-45 days of analysis has to take place before Firegen can have enough data to detect anomalies. With the CLI analyzer, the baseline can be built right after the installation. See the Firegen Log Analyzer Anomaly Detection for more details.