Fortinet FortiAnalyzer Ansible Collection

FortiAnalyzer/Galaxy Multi-versions Guide

  • FortiAnalyzer Galaxy Versions Mapping

User's Guide

  • Install FortiAnalyzer Ansible Galaxy
  • Run Your First Playbook
  • Error Handling
  • Frequently Asked Questions (FAQ)
  • Get Help

Modules Digest

  • Modules Digest

Modules Index

  • Object Oriented Modules
    • faz_cli_fmupdate_analyzer_virusreport – Send virus detection notification to FortiGuard.
    • faz_cli_fmupdate_avips_advancedlog – Enable/disable logging of FortiGuard antivirus and IPS update packages received by FortiManager’s built-in FortiGuard.
    • faz_cli_fmupdate_avips_webproxy – Configure the web proxy for use with FortiGuard antivirus and IPS updates.
    • faz_cli_fmupdate_customurllist – Configure the URL database for rating and filtering.
    • faz_cli_fmupdate_diskquota – Configure disk space available for use by the Upgrade Manager.
    • faz_cli_fmupdate_fctservices – Configure FortiGuard to provide services to FortiClient installations.
    • faz_cli_fmupdate_fdssetting – Configure FortiGuard settings.
    • faz_cli_fmupdate_fdssetting_pushoverride – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for clients.
    • faz_cli_fmupdate_fdssetting_pushoverridetoclient – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for clients.
    • faz_cli_fmupdate_fdssetting_pushoverridetoclient_announceip – Announce IP addresses for the device.
    • faz_cli_fmupdate_fdssetting_serveroverride – Server override configure.
    • faz_cli_fmupdate_fdssetting_serveroverride_servlist – Override server.
    • faz_cli_fmupdate_fdssetting_updateschedule – Configure the schedule when built-in FortiGuard retrieves antivirus and IPS updates.
    • faz_cli_fmupdate_fgdsetting – Cli fmupdate fgd setting
    • faz_cli_fmupdate_fwmsetting – Configure firmware management settings.
    • faz_cli_fmupdate_fwmsetting_upgradetimeout – Configure the timeout value of image upgrade process.
    • faz_cli_fmupdate_multilayer – Configure multilayer mode.
    • faz_cli_fmupdate_publicnetwork – Enable/disable access to the public FortiGuard.
    • faz_cli_fmupdate_serveraccesspriorities – Configure priorities for FortiGate units accessing antivirus updates and web filtering services.
    • faz_cli_fmupdate_serveraccesspriorities_privateserver – Configure multiple FortiManager units and private servers.
    • faz_cli_fmupdate_serveroverridestatus – Configure strict/loose server override.
    • faz_cli_fmupdate_service – Enable/disable services provided by the built-in FortiGuard.
    • faz_cli_fmupdate_webspam_fgdsetting – Configure the FortiGuard run parameters.
    • faz_cli_fmupdate_webspam_fgdsetting_serveroverride – Server override configure.
    • faz_cli_fmupdate_webspam_fgdsetting_serveroverride_servlist – Override server.
    • faz_cli_fmupdate_webspam_webproxy – Configure the web proxy for use with FortiGuard antivirus and IPS updates.
    • faz_cli_metafields_system_admin_user – Cli meta fields system admin user
    • faz_cli_system_admin_group – User group.
    • faz_cli_system_admin_group_member – Group members.
    • faz_cli_system_admin_ldap – LDAP server entry configuration.
    • faz_cli_system_admin_ldap_adom – Admin domain.
    • faz_cli_system_admin_profile – Admin profile.
    • faz_cli_system_admin_profile_datamaskcustomfields – Customized datamask fields.
    • faz_cli_system_admin_profile_writepasswdprofiles – Profile list.
    • faz_cli_system_admin_profile_writepasswduserlist – User list.
    • faz_cli_system_admin_radius – Configure radius.
    • faz_cli_system_admin_setting – Admin setting.
    • faz_cli_system_admin_tacacs – TACACS+ server entry configuration.
    • faz_cli_system_admin_user – Admin user.
    • faz_cli_system_admin_user_adom – Admin domain.
    • faz_cli_system_admin_user_adomexclude – Excluding admin domain.
    • faz_cli_system_admin_user_dashboard – Custom dashboard widgets.
    • faz_cli_system_admin_user_dashboardtabs – Custom dashboard.
    • faz_cli_system_admin_user_metadata – Configure meta data.
    • faz_cli_system_admin_user_policyblock – Policy block write access.
    • faz_cli_system_admin_user_policypackage – Policy package access.
    • faz_cli_system_admin_user_restrictdevvdom – Restricted to these devices/VDOMs.
    • faz_cli_system_alertconsole – Alert console.
    • faz_cli_system_alertemail – Configure alertemail.
    • faz_cli_system_alertevent – Alert events.
    • faz_cli_system_alertevent_alertdestination – Alert destination.
    • faz_cli_system_autodelete – Automatic deletion policy for logs, reports, archived, and quarantined files.
    • faz_cli_system_autodelete_dlpfilesautodeletion – Automatic deletion policy for DLP archives.
    • faz_cli_system_autodelete_logautodeletion – Automatic deletion policy for device logs.
    • faz_cli_system_autodelete_quarantinefilesautodeletion – Automatic deletion policy for quarantined files.
    • faz_cli_system_autodelete_reportautodeletion – Automatic deletion policy for reports.
    • faz_cli_system_backup_allsettings – Scheduled backup settings.
    • faz_cli_system_centralmanagement – Central management configuration.
    • faz_cli_system_certificate_ca – CA certificate.
    • faz_cli_system_certificate_crl – Certificate Revocation List.
    • faz_cli_system_certificate_local – Local keys and certificates.
    • faz_cli_system_certificate_oftp – OFTP certificates and keys.
    • faz_cli_system_certificate_remote – Remote certificate.
    • faz_cli_system_certificate_ssh – SSH certificates and keys.
    • faz_cli_system_connector – Configure connector.
    • faz_cli_system_csf – Add this device to a Security Fabric or set up a new Security Fabric on this device.
    • faz_cli_system_csf_fabricconnector – Fabric connector configuration.
    • faz_cli_system_csf_trustedlist – Pre-authorized and blocked security fabric nodes.
    • faz_cli_system_dns – DNS configuration.
    • faz_cli_system_docker – Docker host.
    • faz_cli_system_fips – Settings for FIPS-CC mode.
    • faz_cli_system_fortiview_autocache – FortiView auto-cache settings.
    • faz_cli_system_fortiview_setting – FortiView settings.
    • faz_cli_system_global – Global range attributes.
    • faz_cli_system_guiact – System settings through GUI.
    • faz_cli_system_ha – HA configuration.
    • faz_cli_system_ha_peer – Peers.
    • faz_cli_system_ha_privatepeer – Peer.
    • faz_cli_system_ha_vip – VIPs.
    • faz_cli_system_interface – Interface configuration.
    • faz_cli_system_interface_ipv6 – IPv6 of interface.
    • faz_cli_system_interface_member – Physical interfaces that belong to the aggregate or redundant interface.
    • faz_cli_system_localinpolicy – IPv4 local in policy configuration.
    • faz_cli_system_localinpolicy6 – IPv6 local in policy configuration.
    • faz_cli_system_localinpolicy6_dport – Cli system local in policy6 dport
    • faz_cli_system_localinpolicy6_dst – Cli system local in policy6 dst
    • faz_cli_system_localinpolicy6_intf – Cli system local in policy6 intf
    • faz_cli_system_localinpolicy6_src – Cli system local in policy6 src
    • faz_cli_system_localinpolicy_dport – Cli system local in policy dport
    • faz_cli_system_localinpolicy_dst – Cli system local in policy dst
    • faz_cli_system_localinpolicy_intf – Cli system local in policy intf
    • faz_cli_system_localinpolicy_src – Cli system local in policy src
    • faz_cli_system_locallog_disk_filter – Filter for disk logging.
    • faz_cli_system_locallog_disk_setting – Settings for local disk logging.
    • faz_cli_system_locallog_fortianalyzer2_filter – Filter for FortiAnalyzer2 logging.
    • faz_cli_system_locallog_fortianalyzer2_setting – Settings for locallog to fortianalyzer.
    • faz_cli_system_locallog_fortianalyzer3_filter – Filter for FortiAnalyzer3 logging.
    • faz_cli_system_locallog_fortianalyzer3_setting – Settings for locallog to fortianalyzer.
    • faz_cli_system_locallog_fortianalyzer_filter – Filter for FortiAnalyzer logging.
    • faz_cli_system_locallog_fortianalyzer_setting – Settings for locallog to fortianalyzer.
    • faz_cli_system_locallog_memory_filter – Filter for memory logging.
    • faz_cli_system_locallog_memory_setting – Settings for memory buffer.
    • faz_cli_system_locallog_setting – Settings for locallog logging.
    • faz_cli_system_locallog_syslogd2_filter – Filter for syslog logging.
    • faz_cli_system_locallog_syslogd2_setting – Settings for remote syslog server.
    • faz_cli_system_locallog_syslogd3_filter – Filter for syslog logging.
    • faz_cli_system_locallog_syslogd3_setting – Settings for remote syslog server.
    • faz_cli_system_locallog_syslogd_filter – Filter for syslog logging.
    • faz_cli_system_locallog_syslogd_setting – Settings for remote syslog server.
    • faz_cli_system_log_alert – Log based alert settings.
    • faz_cli_system_log_devicedisable – Disable client device logging.
    • faz_cli_system_log_deviceselector – Accept/reject devices matching specified filter types.
    • faz_cli_system_log_fospolicystats – FortiOS policy statistics settings.
    • faz_cli_system_log_interfacestats – Interface statistics settings.
    • faz_cli_system_log_ioc – IoC settings.
    • faz_cli_system_log_maildomain – FortiMail domain setting.
    • faz_cli_system_log_pcapfile – Log pcap-file settings.
    • faz_cli_system_log_ratelimit – Logging rate limit.
    • faz_cli_system_log_ratelimit_device – Device log rate limit.
    • faz_cli_system_log_ratelimit_ratelimits – Per device or ADOM log rate limits.
    • faz_cli_system_log_settings – Log settings.
    • faz_cli_system_log_settings_rollinganalyzer – Log rolling policy for Network Analyzer logs.
    • faz_cli_system_log_settings_rollinglocal – Log rolling policy for local logs.
    • faz_cli_system_log_settings_rollingregular – Log rolling policy for device logs.
    • faz_cli_system_log_topology – Logging topology settings.
    • faz_cli_system_log_ueba – UEBAsettings.
    • faz_cli_system_logfetch_clientprofile – Log-fetch client profile settings.
    • faz_cli_system_logfetch_clientprofile_devicefilter – List of device filter.
    • faz_cli_system_logfetch_clientprofile_logfilter – Log content filters.
    • faz_cli_system_logfetch_serversettings – Log-fetch server settings.
    • faz_cli_system_logforward – Log forwarding.
    • faz_cli_system_logforward_devicefilter – Log aggregation client device filters.
    • faz_cli_system_logforward_logfieldexclusion – Log field exclusion configuration.
    • faz_cli_system_logforward_logfilter – Log content filters.
    • faz_cli_system_logforward_logmaskingcustom – Log field masking configuration.
    • faz_cli_system_logforwardservice – Log forwarding service.
    • faz_cli_system_mail – Alert emails.
    • faz_cli_system_metadata_admins – Configure admins.
    • faz_cli_system_ntp – NTP settings.
    • faz_cli_system_ntp_ntpserver – NTP server.
    • faz_cli_system_passwordpolicy – Password policy.
    • faz_cli_system_report_autocache – Report auto-cache settings.
    • faz_cli_system_report_estbrowsetime – Report estimated browse time settings
    • faz_cli_system_report_group – Report group.
    • faz_cli_system_report_group_chartalternative – Chart alternatives.
    • faz_cli_system_report_group_groupby – Group-by variables.
    • faz_cli_system_report_setting – Report settings.
    • faz_cli_system_route – Routing table configuration.
    • faz_cli_system_route6 – Routing table configuration.
    • faz_cli_system_saml – Global settings for SAML authentication.
    • faz_cli_system_saml_fabricidp – Authorized identity providers.
    • faz_cli_system_saml_serviceproviders – Authorized service providers.
    • faz_cli_system_sniffer – Interface sniffer.
    • faz_cli_system_snmp_community – SNMP community configuration.
    • faz_cli_system_snmp_community_hosts – Allow hosts configuration.
    • faz_cli_system_snmp_community_hosts6 – Allow hosts configuration for IPv6.
    • faz_cli_system_snmp_sysinfo – SNMP configuration.
    • faz_cli_system_snmp_user – SNMP user configuration.
    • faz_cli_system_socfabric – SOC Fabric.
    • faz_cli_system_socfabric_trustedlist – Pre-authorized security fabric nodes
    • faz_cli_system_sql – SQL settings.
    • faz_cli_system_sql_customindex – List of SQL index fields.
    • faz_cli_system_sql_customskipidx – List of aditional SQL skip index fields.
    • faz_cli_system_sql_tsindexfield – List of SQL text search index fields.
    • faz_cli_system_sslciphersuites – Configure preferred SSL/TLS cipher suites
    • faz_cli_system_syslog – Syslog servers.
    • faz_cli_system_webproxy – Configure system web proxy.
    • faz_cli_system_workflow_approvalmatrix – workflow approval matrix.
    • faz_cli_system_workflow_approvalmatrix_approver – Approver.
    • faz_dvmdb_adom – ADOM table, most attributes are read-only and can only be changed internally.
    • faz_dvmdb_adom_objectmember – ADOM table, most attributes are read-only and can only be changed internally.
    • faz_dvmdb_device – Device table, most attributes are read-only and can only be changed internally.
    • faz_dvmdb_device_vdom – Device VDOM table.
    • faz_dvmdb_folder – Device manager database folder
    • faz_dvmdb_group – Device group table.
    • faz_dvmdb_group_objectmember – Device group table.
    • faz_eventmgmt_alerts_ack – Acknowledge alert events.
    • faz_eventmgmt_alerts_assign – Assign alert events
    • faz_eventmgmt_alerts_comment – Handle alert comments.
    • faz_eventmgmt_alerts_import – Import basic handlers.
    • faz_eventmgmt_alerts_read – Mark a specific alert event as read.
    • faz_eventmgmt_alerts_unack – Unacknowledge alert events.
    • faz_eventmgmt_basichandlers_import – Import basic handlers.
    • faz_eventmgmt_config_basichandler – Config basic-handler.
    • faz_eventmgmt_config_correlationhandler – Config correlation-handler.
    • faz_eventmgmt_config_dataselector – Config data-selector.
    • faz_eventmgmt_config_notificationprofile – Config notification-profile.
    • faz_eventmgmt_config_trigger – trigger
    • faz_eventmgmt_config_trigger_device – device
    • faz_eventmgmt_config_trigger_filter – filter
    • faz_eventmgmt_config_trigger_filter_rule – rule
    • faz_eventmgmt_correlationhandlers_import – Import correlation handlers.
    • faz_report_config_chart – Config chart.
    • faz_report_config_chart_drilldowntable – Config drill-down-table.
    • faz_report_config_chart_tablecolumns – Config table-columns.
    • faz_report_config_chart_variabletemplate – Config variable-template.
    • faz_report_config_dataset – Config dataset.
    • faz_report_config_dataset_variable – Config variable.
    • faz_report_config_layout – Config layout.
    • faz_report_config_layout_component – Config component.
    • faz_report_config_layout_component_variable – Config variable.
    • faz_report_config_layout_footer – Config footer.
      • Synopsis
      • Requirements
      • FortiAnalyzer Version Compatibility
      • Parameters
      • Notes
      • Examples
      • Return Values
      • Status
      • Authors
    • faz_report_config_layout_header – Config header.
    • faz_report_config_layoutfolder – Config layout-folder.
    • faz_report_config_macro – Config macro.
    • faz_report_config_output – Config output.
    • faz_report_config_output_emailrecipients – Config email-recipients.
    • faz_report_config_schedule – Config schedule.
    • faz_report_config_schedule_addressfilter – Config address-filter.
    • faz_report_config_schedule_devices – Config devices.
    • faz_report_config_schedule_filter – Config filter.
    • faz_report_config_schedule_reportlayout – Config report-layout.
    • faz_report_configfile_import – Import report config files.
    • faz_report_graphfile – Handle graph files.
    • faz_report_graphfile_delete – Handle graph files.
    • faz_report_reports_data_delete – Handle generated reports.
    • faz_report_run – Start report requests.
    • faz_report_run_delete – Handle report requests by task ID.
    • faz_report_template_delete – Delete report template language package files.
    • faz_report_template_import – Import report templates.
    • faz_report_template_install – Install report template language packages from files.
  • Object Manipulating Modules
  • Facts Gathering Modules
  • Daemon Modules
  • Generic Modules

APPENDICES

  • Release Notes
Fortinet FortiAnalyzer Ansible Collection
  • Object Oriented Modules
  • faz_report_config_layout_footer – Config footer.
  • View page source

faz_report_config_layout_footer – Config footer.

Added in version 1.5.0.

Warning

Starting in version 2.0.0, all variables will be named in the underscore naming convention.

  • Possible variable names before 2.0.0: variable-name, variable name, variable.name

  • Corresponding variable names since 2.0.0: variable_name

FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

  • Synopsis

  • Requirements

  • FortiAnalyzer Version Compatibility

  • Parameters

  • Notes

  • Examples

  • Return Values

  • Status

  • Authors

Synopsis

  • This module is able to configure a FortiAnalyzer device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • This module supports check mode and diff mode.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.16.0

FortiAnalyzer Version Compatibility

Supported Version Ranges: v6.2.1 -> latest

Parameters

  • access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
  • bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
  • enable_log Enable/Disable logging for task type: bool default: False
  • forticloud_access_token Access token of forticloud analyzer API users. type: str
  • log_path The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str default: "/tmp/fortianalyzer.ansible.log"
  • proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
  • version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: True
  • rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
  • rc_failed The rc codes list with which the conditions to fail will be overriden type: list
  • state The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom The parameter in requested url type: str required: true
  • layout-id The parameter in requested url type: str required: true
  • report_config_layout_footer Config footer. type: dict
    • footer_id type: int more...

      Supported Version Ranges: v6.2.1 -> latest

    • type type: str choices: [text, graphic, minicover] more...

      Supported Version Ranges: v6.2.1 -> latest

    • graphic type: str more...

      Supported Version Ranges: v6.2.2 -> v6.2.13, v7.4.3 -> latest

    • text type: str more...

      Supported Version Ranges: v6.2.2 -> v6.2.13, v7.4.3 -> latest

Notes

Note

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook
  hosts: fortianalyzers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_network_os: fortinet.fortianalyzer.fortianalyzer
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
  tasks:
    - name: Config footer.
      fortinet.fortianalyzer.faz_report_config_layout_footer:
        # bypass_validation: false
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        layout_id: <your own value>
        state: present # <value in [present, absent]>
        report_config_layout_footer:
          footer_id: 0 # Required variable, integer
          # type: <value in [text, graphic, minicover]>
          # graphic: <value of string>
          # text: <value of string>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta The result of the request. returned: always type: dict
    • request_url The full url requested. returned: always type: str sample: /sys/login/user
    • response_code The status of api request. returned: always type: int sample: 0
    • response_data The data body of the api response. returned: optional type: list or dict
    • response_message The descriptive message of the api response. returned: always type: str sample: OK
    • system_information The information of the target system. returned: always type: dict
  • rc The status the request. returned: always type: int sample: 0
  • version_check_warning Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Maxx Liu (@MaxxLiu22)

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)

Previous Next

© Copyright 2021-2023, Fortinet.

Built with Sphinx using a theme provided by Read the Docs.