Advanced Configuration

CLI only. Define the number of backup files stored by AFA for Cisco firewalls, Juniper SRX devices, or Panorama devices.

Default: 50

Determines whether the add_device_to_group and create_device_group SOAP APIs add both the parent and children devices to the group.

Possible values:

• 0: Both parents and children are added. (Default)
• 1: Only children are added.

Defines the server used for email notification and other AFA related links. Can be an IP address or host name.

For example:

• AFA_URL=https://127.0.0.1/AFA/

• AFA_URL=https://My_AFA_Server/AFA/

Determines whether AFA administrators can add Arista devices to AFA.

Default: FALSE

Determines whether AFA administrators can define ActiveChange options for Azure devices.

Default: FALSE

Determines whether AFA administrators can define ActiveChange options for Cisco ACI devices.

Default: FALSE

Determines whether AFA administrators can add Cisco ISE devices to AFA.

Default: FALSE

Determines whether AFA administrators can add Cisco Meraki devices to AFA.

Default: FALSE

Determines whether analysis is always run, even if the configuration has not changed.

Possible values:

• yes: Analysis is run only if the configuration has changed
• no: Analysis is always run

Automatically create user in AFA from LDAP (if LDAP is defined).

• yes: Automatically create user (default)

• no: Do not create

Determines whether backup files include change history.

Possible values:

• yes. Change history is included
• no. Change history is not included in backups

Determines the IP address of the BusinessFlow host, if not local.

Determines the number of days that legacy changes are kept in report change histories.

Default: 90

Defines the chart threshold value for all condition type charts, including the built-in compliance charts.

Possible value: Integer

Default: 23

Defines a pipe-separated list of Check Point audit log fields that are ignored.

For example:

CKP_Adtlog_Exclude_Fields=CLCStatus|threshold_event_uint

Determines policy backup on Checkpoint FW during a policy change/removal.

• yes: disable the generation of a policy backup on Checkpoint FW during a policy change/removal (default)

• no: enable the generation of a policy backup on Checkpoint FW during a policy change/removal (default)

By default, this property is not defined and all firewall policy and rule information is collected via a single request.

If analysis of firewall policy and rule information fails due to a timeout error, using multiple requests to collect each firewall's data individually may speed up processing and resolve this issue. To activate, set value to yes.

Determines whether policy optimization items are shown for all rules in the policy, and not only those installed on the analyzed module.

Default: yes

Prevents analysis from failing due to inability to connect to defined data center. To activate, set value to yes.

Default: no

Defines the maximum size for each batch data collection for Check Point devices.

For very large policies, set this parameter to a large value, such as 500, to shorten the data collection time.

Possible value: Integer

Default: null

Determines whether a dummy environment is used to speed up log collection on Check Point devices.

Default: no

Determines whether a VIP is shown instead of a MIP in Check Point cluster topologies.

Default: yes

Determines whether the device tree appears fully collapsed or expanded by default.

Possible values:

• True (default). Sets the tree to display collapsed by default.
• False. Sets the tree to display expanded by default.

The SSH connection timeout between the master and collector, in seconds.

Default value (if not defined) is: 180

Determines whether comments match or do not match the regular expression defined in Comments_Regex.

Possible values:

• 0: Does not match
• 1: Matches

Determines whether comprehensive mode is enabled, where AFA queries all services that appear in any rule in the policy.

Default: yes

Determines whether all multiple routes for each range are saved and used for FIP.

Supported only for IOS.

Default: yes

Defines a colon-separated list of values. Rules that contain any of the listed values as services are not listed as covering rules.

Default: null (no exclusions)

Determines the number of days before which rules are considered as unusued.

Additionally, if defined, rules with no rule creation time are considered to be older than the set value.

For example, if this parameter is set to 30, rules that are less than 30 days old are never defined as unused.

0 = Disable this feature, and instead use the value defined in Log_Analysis_Days_Before instead.

Determines the threshold at which warnings are sent for missing log days, in log data-based parts of the policy optimization.

Possible values: Integers, 0-100

0 disables the warning altogether

Default: 50

Defines the database host.

Default: localhost

Defines the database name.

Default: afa

Defines the database username.

Default: afa

Defines the default AFA dashboard shown.

Possible values:

• optimizations.xml (default)
• compliance.xml
• none - do not load a dashboard at login

Sets default for email notifications to newly created users.

By setting this parameter ON, newly added users will not get email notifications when a new report is generated or when configuration changes are applied.

Possible values: 

• yes

• no (default)

By setting this parameter to Yes, the following administrative settings will be set OFF as a default:

1. Creating a new user (Firewall Analyzer Administration page > Users / Roles tab > New User):

   • E-mail Notifications area> Every report

   • E-mail Notifications area> Every configuration change

     

Possible values: 

• yes

• no (default)

By setting this parameter to Yes, the following administrative settings will be set OFF as a default:

1. Creating a new user (Firewall Analyzer Administration page > Users / Roles tab > New User):

   • General Permissions area> Enable Analysis from file
   • General Permissions area> Enable Trusted Traffic - > global
   • E-mail Notifications area> Every report
   • E-mail Notifications area> Every configuration change

   

2. Defining a new user's authentication server (via Firewall Analyzer Administration page > Options > Authentication > Authentication server):

   • LDAP checkbox

   

Determines whether to include Intelligent Policy Optimization recommendations on the Policy Optimization report page.

Possible values:

• yes: Disable IPT recommendations. Recommended if IPT recommendations are causing the report generation to take too long.
• no: Enable IPT recommendations (Default)

Determines whether filtering is disabled for log records whose time is older than the relevant rule's update time or the IPT_Ranges_number update time.

• yes: Disable filtering

• no: Enable filtering (Default)

• yes: remove the map tab from the home GUI and stop the map generation script from running.

• no: Map enabled (default)

Determines whether global monitoring is disabled.

Possible values:

• yes: Monitoring is disabled for all firewalls.
• no: Monitoring is enabled. (Default)

Determines running ongoing log collection

• yes: Disable ongoing log collection. Log collectionwill run in report

• no: Enable ongoing log collection (default)

Determines whether to disable monitoring for routing element devices.

Possible values:

• yes: Monitoring on routing element devices is disabled.
• no: Monitoring on routing element devices are enabled. (Default)

Determines whether traffic log collection is enabled using the ms_trafficlogmanager service.

Possible values:

• yes. Enabled (Default)
• no. Disabled

Determines whether the exported PDF report's Policy page shows the network object content as well as the network object names.

Possible values:

• yes. Network object content and names shown
• no. Network object names shown only (Default)

Defines the timeout, in seconds, for processing a single command in the Expect data collection.

Default: 120

Determines whether the CLI is generated even in case of missing UIds in Cisco PIX devices.

Possible values:

• yes: CLI generation fails in case of missing UID (Default)
• no: CLI is generated even if there are missing UIDs

Determines backplane interface between VRs to provide interconnection in order to route traffic when primary routing table is specified.

Possible values:

• yes: Backplane interface is enabled

• no (or left blank): (default) Uses loaned interface logic

Defines a maximum number of devices for which to run a query with a FIP destination of any.

Default: 100

Determines whether FireFlow XML change files are encoded as UTF-8 or ISO-8859-1.

Possible values:

• UTF-8 (Default)
• ISO-8859-1. Supports Latin characters

• yes: disable emails sent to admin users

• no: emails containing errors (EG license expiration,disk space exhaustion, etc) are always sent to admin users (default)

This parameter impacts the general behavior for FortiManager gateways throughout the system.

• value not set (default): Do not automatically add/remove/move gateways for Fortinet FortiManager devices.

• yes: Automatically add/remove/move gateways for Fortinet FortiManager devices.

  Note: When renaming or moving VDOMs on the FortiManager, existing history will be lost (reports, change history, etc.).

Defines the path of the Analyze from file firewalls.

Default:  $HOME/algosec/fwfiles

Whether to display missing paths table in group query result (useful for FIP troubleshooting)

• yes

• no: (Default)

Determines whether to omit change details from emails about new reports and change alerts, for all users.

Possible values:

• yes: Hides change details for all users. Emails about new reports and change alerts include only the device name and a link to AFA.

• no. Change details are displayed for all users.

  Change this setting per user with the Hide change details checkbox. For details, see Manage users and roles in AFA.

IPT_Density_Action_Limit

The maximum density of a sparse object. When this limit is exceeded, the object is considered semi-dense.

Default: 50

IPT_Recommendation_Max_Ranges

Defines the maximum number of CIDR blocks into which IPT will recommend splitting a host object, if the original object contains more IP addresses/ranges than defined in IPT_Recommendation_Max_Subnets_Per_Range.

Default: 20

IPT_Recommendation_Max_Services

The maximum number of services or applications from which IPT will recommend composing a new object.

Default: 20

IPT_Recommendation_Max_Subnets_Per_Range

Defines the maximum number of CIDR blocks into which IPT will recommend splitting a host object.

IPT recommends creating a new object only when the number of used IP addresses/ranges is smaller than the defined number.

Default: 4

Determines whether rule search results include rules that contain the searched IP only in Any source or destination.

Possible values:

• yes: Rules results include rules where the searched IP address is found in Any source or destination
• no: Rule results do not include rules where the searched IP address is found in Any source or destination (Default)

Defines how often the Check Point and IOS data collection lock file is sampled, in seconds.

The value of this parameter, multiplied by the value of the MAX_LOCK_WAIT parameter equal the total wait time for IOS devices.

Default: 10

Defines the analysis log lookup, in days.

Default: 60

Defines the time period for which traffic database is retained, in months. Traffic logs older than the defined value are deleted.

Default: 12

Defines the time period, in minutes, before which a device's log collection status is set to failure, in case log collection finds no new logs for a specific server for one of the following reasons:

• No logs have arrived to the log server. This may be an issue in the customer environment.
• No logs were found for the target devices. This may be an AFA misconfiguration or error.

Default: 180

Defines the timeout for the entire log collection process, in minutes.

Default: 900 (15 hours)

Defines an email address to use as a default if a new or edited user email address is left empty.

Default: null

Determines whether to ignore defined devices in AFA when creating the map.

Default: null

Defines a time to wait for the Check Point, IOS, or NSM data collection lock file, in seconds.

Default: 7200 (2 hours)

Defines a time to wait for the NSC data collection file, in seconds.

Default: 7200 (2 hours)

Determines the maximum number of analyses that are allowed to run in parallel.

Default: The number of CPUs on the machine.

Determines the maximum number of log collections running in parallel.

Possible values:

• Positive integers
• 0: unlimited

Max monitors to run in parallel.

If not set - monitor will go according to Max_Parallel_Analyses.

Determines whether sorting and filtering in AFA report tables is enabled, and if so, for how many rows.

Sorting and filtering large tables may take a long time.

Possible values:

• Integer, 1 or greater. Defines the maximum number of rows for which sorting and filtering can be performed.
• 0: Sorting and filtering is disabled.

Default: 10,000

Defines the frequency of routing information collection for management devices, such as Panorama, in minutes.

Default: 60

Use this param to decrease the algosec-support.zip file size and also remove unneeded files from report's directory.

Default: no

Defines a single regular expression, including a simple string, to exclude from comparisons during monitoring.

Defines how often data collection runs on Check Point devices, in minutes, even if no new logs are found.

Default: 720

Defines how often a full monitoring cycle is run on Check Point devices, in minutes, even if no new audit logs are found.

Default: 720

Defines how often the monitoring process runs, in hours.

Default: 5

If MONITOR_USE_FREQUENCY_AS_HOUR_OF_DAY is set to no, or does not exist, monitor_frequency defines the hour of the day at which the monitoring process runs. In such cases, supported hours include the hours between 2:00-24:00, skipping 1:00.

Possible values: Integer, multiple of 60.

Configure twice-a-day monitoring
To set twice-a-day monitoring, set monitor_frequencey between the value of 120 and 720 following the the examples below.

For example:

• 60x2 = 120. 120 runs monitoring at 02:00 and 14:00.
• 60x3 = 180. 120 runs monitoring at 03:00 and 15:00.
• 60x4 = 240. 240 runs monitoring at 04:00 and 16:00.
• 60x5 = 300. 240 runs monitoring at 05:00 and 17:00.
• 60x12 = 720. 720 runs monitoring at 00:00 and 12:00.

Configure once-a-day monitoring

1. Set the new MONITOR_USE_FREQUENCY_AS_HOUR_OF_DAY configuration parameter value to no, or delete this parameter.
2. Set the monitor_frequency parameter value to 60x<x>, where <x> is the hour of the day (on the 24-hour clock) at which you want monitoring to run.
   Note: monitor_frequency value must be at least 840.

For example, 60x14 = 840. 840 runs monitoring at 14:00.

Determines whether monitoring processes are run at specific hours of the day.

Possible values:

• no: Monitoring processes run at a frequency defined in minutes and entered via the UI (Administration>Monitoring tab).
• yes: Monitoring processes runs as defined in the monitor_frequency parameter.

Defines the number of days to retain monitoring changes.

Default: 90

Determines whether to show policy optimization items for all the rules in a policy, and not only for those that have the analyzed device in their target.

Possible values:

• Yes: Optimizations shown for all rules in policy
• No: Optimizations shown only for rules that have the analyzed device in their target. (Default)

Determines if routing queries and traffic simulation queries prioritize paths that begin and end with a subnet (and not a cloud) for destinations.

The default setting is yes.

• yes. Enables the preference for subnets in destinations.
• no. Disables the preference for subnets in destinations.

Determines if routing queries and traffic simulation queries prioritize paths that begin and end with a subnet (and not a cloud) for sources.

The default setting is yes.

• yes. Enables the preference for subnets in sources.
• no. Disables the preference for subnets in sources.

If a query destination can be reached by a NAT rule, AFA replaces the query destination to * and then intersects with the destination. This way, even if given the post-NAT address, the query will find the relevant rules.

• yes: disable this replacement (default)

• no: enable this relacement

• yes: disable print of NAT rules in query results

• no: enable print of NAT rules in query results

Defines the timeout for a single query, in seconds.

Default: 15

Determines whether traffic simulation group query results include all devices in device groups, or are grouped by policy with a single representative device for each policy.

Possible values:

• yes. Display group query results by policy.
• no. Do not group query results by policy (Default)

Determines whether to fetch data and groups from LDAP for users authenticated by a Radius server.

Default: no

Determines whether to remove reports for all deleted devices.

Possible values:

• Yes: Remove reports for deleted devices
• No: Keep reports for deleted devices

AppViz uses an improved method for finding risks for traffic flows. In order to determine the risk profile used by the new method, you need to define this global parameter.

If not set, the risk profile used in the last completed report is used for the AppViz risk calculation.

If not set, and there is no last completed report, by default the Standard risk profile will be used.

There are two options:

1. Standard (default)
2. Risk profile name in format: [name].xml. For example, RiskProfile1.xml

Determines the frequency for which to run monitoring on routing elements, in minutes.

Default: 5

Defines the maximum number of rules allowed to be selected for a single FireFlow change request.

Default: 50

Relevant for Palo Alto, Juniper SRX, McAfee SideWinder, Cisco ASA/PIX/FWSM brands:

• When set to no: data collection (routing table, policy rules) is performed only if the device configuration changed.
• When set to yes: data collection will always be performed (without validating if the device configuration changed before).

Default value of this parameter: no

Allows nodes (Remote Agents / Central Manager) to receive syslog messages for devices they do not directly manage.

• By default this parameter is not configured.

• The value format of this parameter is: [Remote Agent1 name], [Remote Agent2 name], [Remote Agent3 name], ...

• For the Remote Agent name, use the name of the node as it appears in Administration > Architecture in ASMS.

• When you specify Remote Agents to sync, the Central Manager is implicitly included. You do not need to define it.

For example:

Device syslog configurations are synced between the Central Manager and Remote Agent RemoteOne:

Device syslog configurations are synced between the Central Manager, and Remote Agents RemoteOne and RemoteTwo:

Determines whether the network map shown in query results shows only the nodes in the network path, without surrounding devices and objects.

Possible values:

• yes: Shows only the nodes in the network path queried, including stub routers, clouds, subnets, and so on.
• no: Shows the nodes in the network path queried, and also surrounding devices and objects. (Default)

For CKP devices R80 and higher we collect all packages during data collection. But some of the packages are not related to device or may not be fully configured, causing analysis to fail.

Set the value of this parameter to the package names to skip. Use a comma (",") as the separator between package names.

SKIP_RISKY_RULES_VULNERABILITIES

Determines whether or not vulnerability information will be skipped for the analyzed devices.

When enabled, analysis time is optimized (especially for devices with large number of rules) and vulnerability information in the log file is reduced.

Possible values:

no (default): Collect vulnerability information

yes: Do not collect vulnerability information

Exclude unattached objects from the device report by setting this parameter to yes.

(By default, this property is not defined)

• To exclude all devices: Add the property 'Skip_unattached_objects_in_report=yes' as a global parameter from within the Advanced Configuration section from Adminstration on ASMS.

• To exclude specific devices: Add the property 'Skip_unattached_objects_in_report=yes' to the 'fwa.meta' file of the specific device. The property can be defined for parent devices, child devices, or both.

  The path for the CLI files is /home/afa/.fa/firewalls/<select relevant firewall>/fwa.meta.

Adds support for TLS1.1 & 1.2 to SMTP Emails.

• yes: add support

• no: support not added (default)

The severity of the risks imported from spreadsheet (case insensitive). Can be one of: Ignore

• Low

• Medium (default)

• Suspected high

• High

Defines the maximum amount of time between syslog collection and memory dump to files, in minutes.

Determines support file download attributes.

• zip: AFA creates zip files for download.
• tar: AFA creates tar files for download.
• tgz: AFA creates tgz files for download. (Default)

• extended_tgz: AFA creates an extended tgz file for download. Use this option when you have devices with names that are longer than 100 characters.

Determines that risk calculation is skipped for private networks. This means that most Z## risks will not be triggered.

Possible values:

• Yes: Skipped for private networks. (Default)
• No: Private networks are included in risk calculation.

Determines whether or not the Add selected devices and their sub-hierarchies to the group checkbox is selected by default when adding a group to AFA:

• The checkbox is selected when the parameter is set to 'no' or when it is not in the configuration file.

• The checkbox is not selected when this parameter is set to 'yes' (default behavior).

Determines whether custom report pages are enabled.

For more details, see Custom report pages.

Possible values:

• yes. Enable custom reports. (Default, when a custom report has been created and installed)
• no. Disable custom reports, preventing any custom reports from appearing in AFA reports.

Determines whether Traffic Simulation Query results on Cisco Nexus devices use wildcard IP ranges.

Possible values:

• yes: Wildcard IP ranges are included.
• no: Wildcard IP ranges are not included. (Default)

Defines the maximum length of a UI session that is not active, in minutes. Any session that goes on for longer than the defined setting is automatically ended.

Default: 300