faz_fact – Gather FortiAnalyzer Facts.

New in version 1.0.0.

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.

• Tested with FortiAnalyzer v6.x and v7.x.

Requirements

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

• ansible>=2.15.0

Parameters

• access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
• enable_log - Enable/Disable logging for task type: bool required: false default: False
• forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
• 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 required: false default: "/tmp/fortianalyzer.ansible.log"
• rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
• rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
• facts - Gathering fortianalyzer facts. type: dict
• fields - Limit the output by returning only the attributes specified in the string array. type: list required: false
• filter - Filter the result according to a set of criteria. type: list required: false
• option - Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. See more details in FNDN API documents. type: str required: false
• sortings - Sorting rules list: items are returned in ascending(1) or descending(-1) order of fields in the list. type: list of dict required: false
• selector - Selector of the retrieved fortianalyzer facts type: str choices:

• Show full selector list...

  • cli_fmupdate_analyzer_virusreport - available versions: >= 6.2.1
  • cli_fmupdate_avips_advancedlog - available versions: >= 6.2.1
  • cli_fmupdate_avips_webproxy - available versions: 6.2.1-7.4.0
  • cli_fmupdate_customurllist - available versions: >= 6.2.1
  • cli_fmupdate_diskquota - available versions: >= 6.2.1
  • cli_fmupdate_fctservices - available versions: >= 6.2.1
  • cli_fmupdate_fdssetting - available versions: >= 6.2.1
  • cli_fmupdate_fdssetting_pushoverride - available versions: >= 6.2.1
  • cli_fmupdate_fdssetting_pushoverridetoclient - available versions: >= 6.2.1
  • cli_fmupdate_fdssetting_pushoverridetoclient_announceip - available versions: >= 6.2.1
  • cli_fmupdate_fdssetting_serveroverride - available versions: >= 6.2.1
  • cli_fmupdate_fdssetting_serveroverride_servlist - available versions: >= 6.2.1
  • cli_fmupdate_fdssetting_updateschedule - available versions: >= 6.2.1
  • cli_fmupdate_fwmsetting - available versions: >= 6.2.1
  • cli_fmupdate_fwmsetting_upgradetimeout - available versions: 7.0.5-7.0.11, >= 7.2.2
  • cli_fmupdate_multilayer - available versions: >= 6.2.1
  • cli_fmupdate_publicnetwork - available versions: >= 6.2.1
  • cli_fmupdate_serveraccesspriorities - available versions: >= 6.2.1
  • cli_fmupdate_serveraccesspriorities_privateserver - available versions: >= 6.2.1
  • cli_fmupdate_serveroverridestatus - available versions: >= 6.2.1
  • cli_fmupdate_service - available versions: >= 6.2.1
  • cli_fmupdate_webspam_fgdsetting - available versions: >= 6.2.1
  • cli_fmupdate_webspam_fgdsetting_serveroverride - available versions: >= 6.2.1
  • cli_fmupdate_webspam_fgdsetting_serveroverride_servlist - available versions: >= 6.2.1
  • cli_fmupdate_webspam_webproxy - available versions: 6.2.1-7.4.0
  • cli_metafields_system_admin_user - available versions: >= 6.2.1
  • cli_system_admin_group - available versions: >= 6.2.1
  • cli_system_admin_group_member - available versions: >= 6.2.1
  • cli_system_admin_ldap - available versions: >= 6.2.1
  • cli_system_admin_ldap_adom - available versions: >= 6.2.1
  • cli_system_admin_profile - available versions: >= 6.2.1
  • cli_system_admin_profile_datamaskcustomfields - available versions: >= 6.2.1
  • cli_system_admin_profile_writepasswdprofiles - available versions: >= 7.4.2
  • cli_system_admin_profile_writepasswduserlist - available versions: >= 7.4.2
  • cli_system_admin_radius - available versions: >= 6.2.1
  • cli_system_admin_setting - available versions: >= 6.2.1
  • cli_system_admin_tacacs - available versions: >= 6.2.1
  • cli_system_admin_user - available versions: >= 6.2.1
  • cli_system_admin_user_adom - available versions: >= 6.2.1
  • cli_system_admin_user_adomexclude - available versions: 6.2.1-7.0.2
  • cli_system_admin_user_dashboard - available versions: >= 6.2.1
  • cli_system_admin_user_dashboardtabs - available versions: >= 6.2.1
  • cli_system_admin_user_metadata - available versions: >= 6.2.1
  • cli_system_admin_user_policypackage - available versions: >= 6.2.1
  • cli_system_admin_user_restrictdevvdom - available versions: 6.2.1-6.2.3
  • cli_system_alertconsole - available versions: >= 6.2.1
  • cli_system_alertemail - available versions: >= 6.2.1
  • cli_system_alertevent - available versions: >= 6.2.1
  • cli_system_alertevent_alertdestination - available versions: >= 6.2.1
  • cli_system_autodelete - available versions: >= 6.2.1
  • cli_system_autodelete_dlpfilesautodeletion - available versions: >= 6.2.1
  • cli_system_autodelete_logautodeletion - available versions: >= 6.2.1
  • cli_system_autodelete_quarantinefilesautodeletion - available versions: >= 6.2.1
  • cli_system_autodelete_reportautodeletion - available versions: >= 6.2.1
  • cli_system_backup_allsettings - available versions: >= 6.2.1
  • cli_system_centralmanagement - available versions: >= 6.2.1
  • cli_system_certificate_ca - available versions: >= 6.2.1
  • cli_system_certificate_crl - available versions: >= 6.2.1
  • cli_system_certificate_local - available versions: >= 6.2.1
  • cli_system_certificate_oftp - available versions: >= 6.2.1
  • cli_system_certificate_remote - available versions: >= 6.2.1
  • cli_system_certificate_ssh - available versions: >= 6.2.1
  • cli_system_connector - available versions: >= 6.2.1
  • cli_system_csf - available versions: >= 7.4.1
  • cli_system_csf_fabricconnector - available versions: >= 7.4.1
  • cli_system_csf_trustedlist - available versions: >= 7.4.1
  • cli_system_dns - available versions: >= 6.2.1
  • cli_system_docker - available versions: 6.2.1-6.2.1, >= 6.4.1
  • cli_system_fips - available versions: >= 6.2.1
  • cli_system_fortiview_autocache - available versions: >= 6.2.1
  • cli_system_fortiview_setting - available versions: >= 6.2.1
  • cli_system_global - available versions: >= 6.2.1
  • cli_system_guiact - available versions: 6.2.1-7.4.0
  • cli_system_ha - available versions: >= 6.2.1
  • cli_system_ha_peer - available versions: >= 6.2.1
  • cli_system_ha_privatepeer - available versions: >= 6.2.1
  • cli_system_ha_vip - available versions: >= 7.0.5
  • cli_system_interface - available versions: >= 6.2.1
  • cli_system_interface_ipv6 - available versions: >= 6.2.1
  • cli_system_interface_member - available versions: >= 6.4.9
  • cli_system_localinpolicy - available versions: >= 7.2.0
  • cli_system_localinpolicy6 - available versions: >= 7.2.0
  • cli_system_locallog_disk_filter - available versions: >= 6.2.1
  • cli_system_locallog_disk_setting - available versions: >= 6.2.1
  • cli_system_locallog_fortianalyzer2_filter - available versions: >= 6.2.1
  • cli_system_locallog_fortianalyzer2_setting - available versions: >= 6.2.1
  • cli_system_locallog_fortianalyzer3_filter - available versions: >= 6.2.1
  • cli_system_locallog_fortianalyzer3_setting - available versions: >= 6.2.1
  • cli_system_locallog_fortianalyzer_filter - available versions: >= 6.2.1
  • cli_system_locallog_fortianalyzer_setting - available versions: >= 6.2.1
  • cli_system_locallog_memory_filter - available versions: >= 6.2.1
  • cli_system_locallog_memory_setting - available versions: >= 6.2.1
  • cli_system_locallog_setting - available versions: >= 6.2.1
  • cli_system_locallog_syslogd2_filter - available versions: >= 6.2.1
  • cli_system_locallog_syslogd2_setting - available versions: >= 6.2.1
  • cli_system_locallog_syslogd3_filter - available versions: >= 6.2.1
  • cli_system_locallog_syslogd3_setting - available versions: >= 6.2.1
  • cli_system_locallog_syslogd_filter - available versions: >= 6.2.1
  • cli_system_locallog_syslogd_setting - available versions: >= 6.2.1
  • cli_system_log_alert - available versions: >= 6.2.1
  • cli_system_log_devicedisable - available versions: >= 6.4.4
  • cli_system_log_fospolicystats - available versions: >= 7.0.2
  • cli_system_log_interfacestats - available versions: >= 6.2.1
  • cli_system_log_ioc - available versions: >= 6.2.1
  • cli_system_log_maildomain - available versions: >= 6.2.1
  • cli_system_log_pcapfile - available versions: >= 7.4.1
  • cli_system_log_ratelimit - available versions: >= 6.4.8
  • cli_system_log_ratelimit_device - available versions: 6.4.8-7.0.2
  • cli_system_log_ratelimit_ratelimits - available versions: >= 7.0.3
  • cli_system_log_settings - available versions: >= 6.2.1
  • cli_system_log_settings_rollinganalyzer - available versions: >= 6.2.1
  • cli_system_log_settings_rollinglocal - available versions: >= 6.2.1
  • cli_system_log_settings_rollingregular - available versions: >= 6.2.1
  • cli_system_log_topology - available versions: 6.4.7-6.4.14, >= 7.0.2
  • cli_system_logfetch_clientprofile - available versions: >= 6.2.1
  • cli_system_logfetch_clientprofile_devicefilter - available versions: >= 6.2.1
  • cli_system_logfetch_clientprofile_logfilter - available versions: >= 6.2.1
  • cli_system_logfetch_serversettings - available versions: >= 6.2.1
  • cli_system_logforward - available versions: >= 6.2.1
  • cli_system_logforward_devicefilter - available versions: >= 6.2.1
  • cli_system_logforward_logfieldexclusion - available versions: >= 6.2.1
  • cli_system_logforward_logfilter - available versions: >= 6.2.1
  • cli_system_logforward_logmaskingcustom - available versions: >= 7.0.0
  • cli_system_logforwardservice - available versions: >= 6.2.1
  • cli_system_mail - available versions: >= 6.2.1
  • cli_system_metadata_admins - available versions: >= 6.2.1
  • cli_system_ntp - available versions: >= 6.2.1
  • cli_system_ntp_ntpserver - available versions: >= 6.2.1
  • cli_system_passwordpolicy - available versions: >= 6.2.1
  • cli_system_performance - available versions: >= 6.2.1
  • cli_system_report_autocache - available versions: >= 6.2.1
  • cli_system_report_estbrowsetime - available versions: >= 6.2.1
  • cli_system_report_group - available versions: >= 6.2.1
  • cli_system_report_group_chartalternative - available versions: >= 6.2.1
  • cli_system_report_group_groupby - available versions: >= 6.2.1
  • cli_system_report_setting - available versions: >= 6.2.1
  • cli_system_route - available versions: >= 6.2.1
  • cli_system_route6 - available versions: >= 6.2.1
  • cli_system_saml - available versions: >= 6.2.1
  • cli_system_saml_fabricidp - available versions: 6.2.1-6.2.1, >= 6.4.1
  • cli_system_saml_serviceproviders - available versions: >= 6.2.1
  • cli_system_sniffer - available versions: >= 6.2.1
  • cli_system_snmp_community - available versions: >= 6.2.1
  • cli_system_snmp_community_hosts - available versions: >= 6.2.1
  • cli_system_snmp_community_hosts6 - available versions: >= 6.2.1
  • cli_system_snmp_sysinfo - available versions: >= 6.2.1
  • cli_system_snmp_user - available versions: >= 6.2.1
  • cli_system_socfabric - available versions: >= 7.0.0
  • cli_system_socfabric_trustedlist - available versions: >= 7.4.0
  • cli_system_sql - available versions: >= 6.2.1
  • cli_system_sql_customindex - available versions: >= 6.2.1
  • cli_system_sql_customskipidx - available versions: 6.2.1-6.2.1, >= 6.2.3
  • cli_system_sql_tsindexfield - available versions: >= 6.2.1
  • cli_system_sslciphersuites - available versions: 6.4.8-6.4.14, >= 7.0.2
  • cli_system_status - available versions: >= 6.2.1
  • cli_system_syslog - available versions: >= 6.2.1
  • cli_system_webproxy - available versions: 6.4.8-6.4.14, >= 7.0.3
  • cli_system_workflow_approvalmatrix - available versions: 6.2.1-6.2.9, 6.4.1-6.4.7, 7.0.0-7.0.2
  • cli_system_workflow_approvalmatrix_approver - available versions: 6.2.1-6.2.9, 6.4.1-6.4.7, 7.0.0-7.0.2
  • dvmdb_adom - available versions: >= 6.2.1
  • dvmdb_device - available versions: >= 6.2.1
  • dvmdb_device_haslave - available versions: >= 6.2.1
  • dvmdb_device_vdom - available versions: >= 6.2.1
  • dvmdb_folder - available versions: >= 6.4.2
  • dvmdb_group - available versions: >= 6.2.1
  • eventmgmt_alertfilter - available versions: >= 6.2.1
  • eventmgmt_alertlogs - available versions: >= 6.2.1
  • eventmgmt_alertlogs_count - available versions: >= 6.2.1
  • eventmgmt_alerts - available versions: >= 6.2.1
  • eventmgmt_alerts_count - available versions: >= 6.2.1
  • eventmgmt_alerts_export - available versions: >= 7.0.0
  • eventmgmt_alerts_extradetails - available versions: 6.2.1-6.2.1, >= 6.4.1
  • eventmgmt_basichandlers_export - available versions: >= 7.2.2
  • eventmgmt_correlationhandlers_export - available versions: >= 7.2.2
  • fazsys_enduseravatar - available versions: >= 6.2.1
  • fazsys_forticare_licinfo - available versions: >= 7.2.1
  • fazsys_language_fonts_export - available versions: >= 6.2.1
  • fazsys_language_fonts_list - available versions: >= 6.2.1
  • fazsys_language_translationfile_export - available versions: >= 6.2.1
  • fazsys_language_translationfile_list - available versions: >= 6.2.1
  • fazsys_monitor_logforwardstatus - available versions: >= 7.2.2
  • fortiview_run - available versions: >= 6.2.1
  • incidentmgmt_attachments - available versions: >= 6.2.1
  • incidentmgmt_attachments_count - available versions: >= 6.2.1
  • incidentmgmt_epeuhistory - available versions: >= 6.4.2
  • incidentmgmt_incidents - available versions: >= 6.2.1
  • incidentmgmt_incidents_count - available versions: >= 6.2.1
  • ioc_license_state - available versions: >= 6.2.1
  • ioc_rescan_history - available versions: >= 6.2.1
  • ioc_rescan_run - available versions: >= 6.2.1
  • logview_logfields - available versions: >= 6.2.1
  • logview_logfiles_data - available versions: >= 6.2.1
  • logview_logfiles_search - available versions: >= 6.2.1
  • logview_logfiles_state - available versions: >= 6.2.1
  • logview_logsearch - available versions: >= 6.2.1
  • logview_logsearch_count - available versions: >= 7.0.1
  • logview_logstats - available versions: 6.2.1-6.2.1, >= 6.4.1
  • logview_pcapfile - available versions: >= 7.0.3
  • report_adom_root_template_language - available versions: >= 6.2.1
  • report_graphfile - available versions: >= 7.2.2
  • report_graphfile_data - available versions: >= 7.2.2
  • report_graphfile_list - available versions: >= 7.2.2
  • report_reports_data - available versions: >= 6.2.1
  • report_reports_state - available versions: >= 6.2.1
  • report_run - available versions: >= 6.2.1
  • report_template_export - available versions: >= 6.2.1
  • report_template_list - available versions: >= 6.2.1
  • soar_config_connectors - available versions: >= 6.4.2
  • soar_config_playbooks - available versions: >= 6.4.2
  • soar_fosconnector_automationrules - available versions: >= 6.4.2
  • soar_playbook_export - available versions: >= 7.0.0
  • soar_playbook_monitor - available versions: 6.4.2-7.2.1
  • soar_playbook_run - available versions: >= 6.4.2
  • soar_subnet_export - available versions: >= 7.0.0
  • soar_task_monitor - available versions: >= 6.4.2
  • sys_ha_status - available versions: >= 6.2.1
  • sys_status - available versions: >= 6.2.1
  • task_task - available versions: >= 6.2.1
  • task_task_history - available versions: 6.2.2-6.2.12
  • task_task_line - available versions: >= 6.2.1
  • task_task_line_history - available versions: 6.2.1-6.2.1, >= 6.4.1
  • ueba_endpoints - available versions: >= 6.2.1
  • ueba_endpoints_stats - available versions: >= 6.2.1
  • ueba_endpoints_vuln - available versions: >= 7.4.1
  • ueba_endusers - available versions: >= 6.2.1
  • ueba_endusers_stats - available versions: >= 6.2.1
  • ueba_otview - available versions: >= 7.4.0
• params - The parameter for each selector type: dict choices:

• More details about parameter: params...

  • params for cli_fmupdate_analyzer_virusreport:
  • params for cli_fmupdate_avips_advancedlog:
  • params for cli_fmupdate_avips_webproxy:
  • params for cli_fmupdate_customurllist:
  • params for cli_fmupdate_diskquota:
  • params for cli_fmupdate_fctservices:
  • params for cli_fmupdate_fdssetting:
  • params for cli_fmupdate_fdssetting_pushoverride:
  • params for cli_fmupdate_fdssetting_pushoverridetoclient:
  • params for cli_fmupdate_fdssetting_pushoverridetoclient_announceip:
  • announce-ip
  • params for cli_fmupdate_fdssetting_serveroverride:
  • params for cli_fmupdate_fdssetting_serveroverride_servlist:
  • servlist
  • params for cli_fmupdate_fdssetting_updateschedule:
  • params for cli_fmupdate_fwmsetting:
  • params for cli_fmupdate_fwmsetting_upgradetimeout:
  • params for cli_fmupdate_multilayer:
  • params for cli_fmupdate_publicnetwork:
  • params for cli_fmupdate_serveraccesspriorities:
  • params for cli_fmupdate_serveraccesspriorities_privateserver:
  • private-server
  • params for cli_fmupdate_serveroverridestatus:
  • params for cli_fmupdate_service:
  • params for cli_fmupdate_webspam_fgdsetting:
  • params for cli_fmupdate_webspam_fgdsetting_serveroverride:
  • params for cli_fmupdate_webspam_fgdsetting_serveroverride_servlist:
  • servlist
  • params for cli_fmupdate_webspam_webproxy:
  • params for cli_metafields_system_admin_user:
  • params for cli_system_admin_group:
  • group
  • params for cli_system_admin_group_member:
  • group
  • member
  • params for cli_system_admin_ldap:
  • ldap
  • params for cli_system_admin_ldap_adom:
  • adom
  • ldap
  • params for cli_system_admin_profile:
  • profile
  • params for cli_system_admin_profile_datamaskcustomfields:
  • datamask-custom-fields
  • profile
  • params for cli_system_admin_profile_writepasswdprofiles:
  • profile
  • write-passwd-profiles
  • params for cli_system_admin_profile_writepasswduserlist:
  • profile
  • write-passwd-user-list
  • params for cli_system_admin_radius:
  • radius
  • params for cli_system_admin_setting:
  • params for cli_system_admin_tacacs:
  • tacacs
  • params for cli_system_admin_user:
  • user
  • params for cli_system_admin_user_adom:
  • adom
  • user
  • params for cli_system_admin_user_adomexclude:
  • adom-exclude
  • user
  • params for cli_system_admin_user_dashboard:
  • dashboard
  • user
  • params for cli_system_admin_user_dashboardtabs:
  • dashboard-tabs
  • user
  • params for cli_system_admin_user_metadata:
  • meta-data
  • user
  • params for cli_system_admin_user_policypackage:
  • policy-package
  • user
  • params for cli_system_admin_user_restrictdevvdom:
  • restrict-dev-vdom
  • user
  • params for cli_system_alertconsole:
  • params for cli_system_alertemail:
  • params for cli_system_alertevent:
  • alert-event
  • params for cli_system_alertevent_alertdestination:
  • alert-destination
  • alert-event
  • params for cli_system_autodelete:
  • params for cli_system_autodelete_dlpfilesautodeletion:
  • params for cli_system_autodelete_logautodeletion:
  • params for cli_system_autodelete_quarantinefilesautodeletion:
  • params for cli_system_autodelete_reportautodeletion:
  • params for cli_system_backup_allsettings:
  • params for cli_system_centralmanagement:
  • params for cli_system_certificate_ca:
  • ca
  • params for cli_system_certificate_crl:
  • crl
  • params for cli_system_certificate_local:
  • local
  • params for cli_system_certificate_oftp:
  • params for cli_system_certificate_remote:
  • remote
  • params for cli_system_certificate_ssh:
  • ssh
  • params for cli_system_connector:
  • params for cli_system_csf:
  • params for cli_system_csf_fabricconnector:
  • fabric-connector
  • params for cli_system_csf_trustedlist:
  • trusted-list
  • params for cli_system_dns:
  • params for cli_system_docker:
  • params for cli_system_fips:
  • params for cli_system_fortiview_autocache:
  • params for cli_system_fortiview_setting:
  • params for cli_system_global:
  • params for cli_system_guiact:
  • params for cli_system_ha:
  • params for cli_system_ha_peer:
  • peer
  • params for cli_system_ha_privatepeer:
  • private-peer
  • params for cli_system_ha_vip:
  • vip
  • params for cli_system_interface:
  • interface
  • params for cli_system_interface_ipv6:
  • interface
  • params for cli_system_interface_member:
  • interface
  • member
  • params for cli_system_localinpolicy:
  • local-in-policy
  • params for cli_system_localinpolicy6:
  • local-in-policy6
  • params for cli_system_locallog_disk_filter:
  • params for cli_system_locallog_disk_setting:
  • params for cli_system_locallog_fortianalyzer2_filter:
  • params for cli_system_locallog_fortianalyzer2_setting:
  • params for cli_system_locallog_fortianalyzer3_filter:
  • params for cli_system_locallog_fortianalyzer3_setting:
  • params for cli_system_locallog_fortianalyzer_filter:
  • params for cli_system_locallog_fortianalyzer_setting:
  • params for cli_system_locallog_memory_filter:
  • params for cli_system_locallog_memory_setting:
  • params for cli_system_locallog_setting:
  • params for cli_system_locallog_syslogd2_filter:
  • params for cli_system_locallog_syslogd2_setting:
  • params for cli_system_locallog_syslogd3_filter:
  • params for cli_system_locallog_syslogd3_setting:
  • params for cli_system_locallog_syslogd_filter:
  • params for cli_system_locallog_syslogd_setting:
  • params for cli_system_log_alert:
  • params for cli_system_log_devicedisable:
  • device-disable
  • params for cli_system_log_fospolicystats:
  • params for cli_system_log_interfacestats:
  • params for cli_system_log_ioc:
  • params for cli_system_log_maildomain:
  • mail-domain
  • params for cli_system_log_pcapfile:
  • params for cli_system_log_ratelimit:
  • params for cli_system_log_ratelimit_device:
  • device
  • params for cli_system_log_ratelimit_ratelimits:
  • ratelimits
  • params for cli_system_log_settings:
  • params for cli_system_log_settings_rollinganalyzer:
  • params for cli_system_log_settings_rollinglocal:
  • params for cli_system_log_settings_rollingregular:
  • params for cli_system_log_topology:
  • params for cli_system_logfetch_clientprofile:
  • client-profile
  • params for cli_system_logfetch_clientprofile_devicefilter:
  • client-profile
  • device-filter
  • params for cli_system_logfetch_clientprofile_logfilter:
  • client-profile
  • log-filter
  • params for cli_system_logfetch_serversettings:
  • params for cli_system_logforward:
  • log-forward
  • params for cli_system_logforward_devicefilter:
  • device-filter
  • log-forward
  • params for cli_system_logforward_logfieldexclusion:
  • log-field-exclusion
  • log-forward
  • params for cli_system_logforward_logfilter:
  • log-filter
  • log-forward
  • params for cli_system_logforward_logmaskingcustom:
  • log-forward
  • log-masking-custom
  • params for cli_system_logforwardservice:
  • params for cli_system_mail:
  • mail
  • params for cli_system_metadata_admins:
  • admins
  • params for cli_system_ntp:
  • params for cli_system_ntp_ntpserver:
  • ntpserver
  • params for cli_system_passwordpolicy:
  • params for cli_system_performance:
  • params for cli_system_report_autocache:
  • params for cli_system_report_estbrowsetime:
  • params for cli_system_report_group:
  • group
  • params for cli_system_report_group_chartalternative:
  • chart-alternative
  • group
  • params for cli_system_report_group_groupby:
  • group
  • group-by
  • params for cli_system_report_setting:
  • params for cli_system_route:
  • route
  • params for cli_system_route6:
  • route6
  • params for cli_system_saml:
  • params for cli_system_saml_fabricidp:
  • fabric-idp
  • params for cli_system_saml_serviceproviders:
  • service-providers
  • params for cli_system_sniffer:
  • sniffer
  • params for cli_system_snmp_community:
  • community
  • params for cli_system_snmp_community_hosts:
  • community
  • hosts
  • params for cli_system_snmp_community_hosts6:
  • community
  • hosts6
  • params for cli_system_snmp_sysinfo:
  • params for cli_system_snmp_user:
  • user
  • params for cli_system_socfabric:
  • params for cli_system_socfabric_trustedlist:
  • trusted-list
  • params for cli_system_sql:
  • params for cli_system_sql_customindex:
  • custom-index
  • params for cli_system_sql_customskipidx:
  • custom-skipidx
  • params for cli_system_sql_tsindexfield:
  • ts-index-field
  • params for cli_system_sslciphersuites:
  • ssl-cipher-suites
  • params for cli_system_status:
  • params for cli_system_syslog:
  • syslog
  • params for cli_system_webproxy:
  • params for cli_system_workflow_approvalmatrix:
  • approval-matrix
  • params for cli_system_workflow_approvalmatrix_approver:
  • approval-matrix
  • approver
  • params for dvmdb_adom:
  • adom
  • params for dvmdb_device:
  • adom
  • device
  • params for dvmdb_device_haslave:
  • adom
  • device
  • ha_slave
  • params for dvmdb_device_vdom:
  • adom
  • device
  • vdom
  • params for dvmdb_folder:
  • adom
  • folder
  • params for dvmdb_group:
  • adom
  • group
  • params for eventmgmt_alertfilter:
  • adom
  • params for eventmgmt_alertlogs:
  • adom
  • params for eventmgmt_alertlogs_count:
  • adom
  • params for eventmgmt_alerts:
  • adom
  • params for eventmgmt_alerts_count:
  • adom
  • params for eventmgmt_alerts_export:
  • adom
  • params for eventmgmt_alerts_extradetails:
  • adom
  • params for eventmgmt_basichandlers_export:
  • adom
  • params for eventmgmt_correlationhandlers_export:
  • adom
  • params for fazsys_enduseravatar:
  • adom
  • params for fazsys_forticare_licinfo:
  • adom
  • params for fazsys_language_fonts_export:
  • params for fazsys_language_fonts_list:
  • params for fazsys_language_translationfile_export:
  • params for fazsys_language_translationfile_list:
  • params for fazsys_monitor_logforwardstatus:
  • params for fortiview_run:
  • adom
  • tid
  • view-name
  • params for incidentmgmt_attachments:
  • adom
  • params for incidentmgmt_attachments_count:
  • adom
  • params for incidentmgmt_epeuhistory:
  • adom
  • params for incidentmgmt_incidents:
  • adom
  • params for incidentmgmt_incidents_count:
  • adom
  • params for ioc_license_state:
  • params for ioc_rescan_history:
  • adom
  • params for ioc_rescan_run:
  • adom
  • params for logview_logfields:
  • adom
  • params for logview_logfiles_data:
  • adom
  • params for logview_logfiles_search:
  • adom
  • params for logview_logfiles_state:
  • adom
  • params for logview_logsearch:
  • adom
  • tid
  • params for logview_logsearch_count:
  • adom
  • tid
  • params for logview_logstats:
  • adom
  • params for logview_pcapfile:
  • params for report_adom_root_template_language:
  • params for report_graphfile:
  • adom
  • params for report_graphfile_data:
  • adom
  • params for report_graphfile_list:
  • adom
  • params for report_reports_data:
  • adom
  • tid
  • params for report_reports_state:
  • adom
  • params for report_run:
  • adom
  • tid
  • params for report_template_export:
  • adom
  • params for report_template_list:
  • adom
  • params for soar_config_connectors:
  • adom
  • connector-uuid
  • params for soar_config_playbooks:
  • adom
  • playbook-uuid
  • params for soar_fosconnector_automationrules:
  • adom
  • params for soar_playbook_export:
  • adom
  • params for soar_playbook_monitor:
  • adom
  • params for soar_playbook_run:
  • adom
  • params for soar_subnet_export:
  • adom
  • params for soar_task_monitor:
  • adom
  • params for sys_ha_status:
  • params for sys_status:
  • params for task_task:
  • task
  • params for task_task_history:
  • history
  • task
  • params for task_task_line:
  • line
  • task
  • params for task_task_line_history:
  • history
  • line
  • task
  • params for ueba_endpoints:
  • adom
  • params for ueba_endpoints_stats:
  • adom
  • params for ueba_endpoints_vuln:
  • adom
  • params for ueba_endusers:
  • adom
  • params for ueba_endusers_stats:
  • adom
  • params for ueba_otview:
  • adom
• extra_params Extra parameters. type: dict required: false

Notes

Note

• Selector is a mandatory parameter for the module, and the params is varying depending on the selector.

• Parameter adom can be null or '' for all administrative domains, global for global domain and any other custom domain strings. and a particular fact may not support all kinds of domains.

• In parameters section, null and '' are identical if you are fetching all objects under that selector category.

• 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: Gathering fortianalyzer facts
  hosts: fortianalyzers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Fetch adom
      fortinet.fortianalyzer.faz_fact:
        facts:
          selector: "dvmdb_adom"
          filter:
            - - "os_ver"
              - "=="
              - "7.0"
            - "&&"
            - - "state"
              - "=="
              - "1"
          fields:
            - "name"
            - "restricted_prds"
          # option: "object member" # "count", "object member" or "syntax"
          sortings:
            - "restricted_prds": -1 # sort based on restricted_prds first (-1, descending)
            - "oid": 1 # if restricted_prds are same, then, sort based on oid (1, ascending)

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)

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.