faz_fact – Gather FortiAnalyzer Facts.

Added 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.16.0

Parameters

• access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
• 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"
• 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
• facts Gathering fortianalyzer facts. type: dict
• fields Limit the output by returning only the attributes specified in the string array. type: list
• filter Filter the result according to a set of criteria. type: list
• 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
• sortings Sorting rules list: items are returned in ascending(1) or descending(-1) order of fields in the list. type: list of dict
• 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_fgdsetting - available versions: >= 7.6.3
  • cli_fmupdate_fwmsetting - available versions: >= 6.2.1
  • cli_fmupdate_fwmsetting_upgradetimeout - available versions: 7.0.5-7.0.14, >= 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-7.6.2
  • cli_fmupdate_webspam_fgdsetting_serveroverride - available versions: 6.2.1-7.6.2
  • cli_fmupdate_webspam_fgdsetting_serveroverride_servlist - available versions: 6.2.1-7.6.2
  • 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_policyblock - available versions: >= 7.6.0
  • 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-7.0.13, 7.2.0-7.2.10, 7.4.0-7.4.7, 7.6.0-7.6.3
  • 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.0.11, 7.2.0-7.2.4, 7.4.0-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_localinpolicy6_dport - available versions: >= 7.6.4
  • cli_system_localinpolicy6_dst - available versions: >= 7.6.4
  • cli_system_localinpolicy6_intf - available versions: >= 7.6.4
  • cli_system_localinpolicy6_src - available versions: >= 7.6.4
  • cli_system_localinpolicy_dport - available versions: >= 7.6.4
  • cli_system_localinpolicy_dst - available versions: >= 7.6.4
  • cli_system_localinpolicy_intf - available versions: >= 7.6.4
  • cli_system_localinpolicy_src - available versions: >= 7.6.4
  • 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-7.4.6, 7.6.0-7.6.2
  • cli_system_log_deviceselector - available versions: 7.4.7-7.4.8, >= 7.6.3
  • 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.15, >= 7.0.2
  • cli_system_log_ueba - available versions: >= 7.4.3
  • 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.15, >= 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.15, >= 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, >= 7.6.0
  • 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, >= 7.6.0
  • 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_alertincident_stats - available versions: >= 7.6.0
  • 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_config_basichandler - available versions: >= 7.2.2
  • eventmgmt_config_correlationhandler - available versions: >= 7.2.2
  • eventmgmt_config_dataselector - available versions: >= 7.2.2
  • eventmgmt_config_notificationprofile - available versions: >= 7.2.2
  • eventmgmt_config_trigger - available versions: 6.2.1-7.2.1
  • eventmgmt_config_trigger_device - available versions: 6.2.1-7.2.1
  • eventmgmt_config_trigger_filter - available versions: 6.2.1-7.2.1
  • eventmgmt_config_trigger_filter_rule - available versions: 6.2.1-7.2.1
  • 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_lograte_history - available versions: >= 7.6.0
  • fazsys_monitor_logforwardstatus - available versions: >= 7.2.2
  • fazsys_monitor_system_performance_status - available versions: >= 7.6.0
  • fazsys_storageinfo - available versions: >= 7.6.0
  • fazsys_storageinfohistory - available versions: >= 7.6.0
  • 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_incident_stats - available versions: >= 7.6.0
  • 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_config_chart - available versions: >= 6.2.1
  • report_config_chart_drilldowntable - available versions: >= 6.2.1
  • report_config_chart_tablecolumns - available versions: >= 6.2.1
  • report_config_chart_variabletemplate - available versions: >= 6.2.1
  • report_config_dataset - available versions: >= 6.2.1
  • report_config_dataset_variable - available versions: >= 6.2.1
  • report_config_layout - available versions: >= 6.2.1
  • report_config_layout_component - available versions: >= 6.2.1
  • report_config_layout_component_variable - available versions: >= 6.2.1
  • report_config_layout_footer - available versions: >= 6.2.1
  • report_config_layout_header - available versions: >= 6.2.1
  • report_config_layoutfolder - available versions: >= 6.2.1
  • report_config_macro - available versions: >= 6.2.1
  • report_config_output - available versions: >= 6.2.1
  • report_config_output_emailrecipients - available versions: >= 6.2.1
  • report_config_schedule - available versions: >= 6.2.1
  • report_config_schedule_addressfilter - available versions: >= 6.4.3
  • report_config_schedule_devices - available versions: >= 6.2.1
  • report_config_schedule_filter - available versions: >= 6.2.1
  • report_config_schedule_reportlayout - available versions: >= 6.2.1
  • report_configfile_export - available versions: >= 7.6.4
  • 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_language - available versions: >= 6.2.1
  • report_template_list - available versions: >= 6.2.1
  • soar_alert_indicator - available versions: >= 7.6.0
  • 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_incident_indicator - available versions: >= 7.6.0
  • soar_indicator - available versions: >= 7.6.0
  • soar_indicator_enrichment - available versions: >= 7.6.0
  • soar_playbook_export - available versions: >= 7.0.0
  • soar_playbook_monitor - available versions: 6.4.2-7.2.1, 7.6.0-7.6.1
  • soar_playbook_run - available versions: >= 6.4.2
  • soar_playbook_runlog - available versions: >= 7.6.0
  • soar_subnet_export - available versions: >= 7.0.0
  • soar_task_monitor - available versions: 6.4.2-7.4.8, >= 7.6.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.13
  • 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.0
  • 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. E.g., some "get" JSON APIs support "loadsub", "meta field", "range"... type: dict choices:

• More details about parameter: params...

  • params for cli_fmupdate_analyzer_virusreport: None
  • params for cli_fmupdate_avips_advancedlog: None
  • params for cli_fmupdate_avips_webproxy: None
  • params for cli_fmupdate_customurllist: None
  • params for cli_fmupdate_diskquota: None
  • params for cli_fmupdate_fctservices: None
  • params for cli_fmupdate_fdssetting: None
  • params for cli_fmupdate_fdssetting_pushoverride: None
  • params for cli_fmupdate_fdssetting_pushoverridetoclient: None
  • params for cli_fmupdate_fdssetting_pushoverridetoclient_announceip:
  • announce-ip (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_fmupdate_fdssetting_serveroverride: None
  • params for cli_fmupdate_fdssetting_serveroverride_servlist:
  • servlist (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_fmupdate_fdssetting_updateschedule: None
  • params for cli_fmupdate_fgdsetting: None
  • params for cli_fmupdate_fwmsetting: None
  • params for cli_fmupdate_fwmsetting_upgradetimeout: None
  • params for cli_fmupdate_multilayer: None
  • params for cli_fmupdate_publicnetwork: None
  • params for cli_fmupdate_serveraccesspriorities: None
  • params for cli_fmupdate_serveraccesspriorities_privateserver:
  • private-server (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_fmupdate_serveroverridestatus: None
  • params for cli_fmupdate_service: None
  • params for cli_fmupdate_webspam_fgdsetting: None
  • params for cli_fmupdate_webspam_fgdsetting_serveroverride: None
  • params for cli_fmupdate_webspam_fgdsetting_serveroverride_servlist:
  • servlist (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_fmupdate_webspam_webproxy: None
  • params for cli_metafields_system_admin_user: None
  • params for cli_system_admin_group:
  • group (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_group_member:
  • group (Required)
  • member (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_ldap:
  • ldap (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_ldap_adom:
  • adom (Required)
  • ldap (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_profile:
  • profile (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_profile_datamaskcustomfields:
  • datamask-custom-fields (Required)
  • profile (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_profile_writepasswdprofiles:
  • profile (Required)
  • write-passwd-profiles (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_profile_writepasswduserlist:
  • profile (Required)
  • write-passwd-user-list (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_radius:
  • radius (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_setting: None
  • params for cli_system_admin_tacacs:
  • tacacs (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user:
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user_adom:
  • adom (Required)
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user_adomexclude:
  • adom-exclude (Required)
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user_dashboard:
  • dashboard (Required)
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user_dashboardtabs:
  • dashboard-tabs (Required)
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user_metadata:
  • meta-data (Required)
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user_policyblock:
  • policy-block (Required)
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user_policypackage:
  • policy-package (Required)
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_admin_user_restrictdevvdom:
  • restrict-dev-vdom (Required)
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_alertconsole: None
  • params for cli_system_alertemail: None
  • params for cli_system_alertevent:
  • alert-event (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_alertevent_alertdestination:
  • alert-destination (Required)
  • alert-event (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_autodelete: None
  • params for cli_system_autodelete_dlpfilesautodeletion: None
  • params for cli_system_autodelete_logautodeletion: None
  • params for cli_system_autodelete_quarantinefilesautodeletion: None
  • params for cli_system_autodelete_reportautodeletion: None
  • params for cli_system_backup_allsettings: None
  • params for cli_system_centralmanagement: None
  • params for cli_system_certificate_ca:
  • ca (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_certificate_crl:
  • crl (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_certificate_local:
  • local (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_certificate_oftp: None
  • params for cli_system_certificate_remote:
  • remote (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_certificate_ssh:
  • ssh (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_connector: None
  • params for cli_system_csf: None
  • params for cli_system_csf_fabricconnector:
  • fabric-connector (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_csf_trustedlist:
  • trusted-list (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_dns: None
  • params for cli_system_docker: None
  • params for cli_system_fips: None
  • params for cli_system_fortiview_autocache: None
  • params for cli_system_fortiview_setting: None
  • params for cli_system_global: None
  • params for cli_system_guiact: None
  • params for cli_system_ha: None
  • params for cli_system_ha_peer:
  • peer (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_ha_privatepeer:
  • private-peer (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_ha_vip:
  • vip (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_interface:
  • interface (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_interface_ipv6:
  • interface (Required)
  • params for cli_system_interface_member:
  • interface (Required)
  • member (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy:
  • local-in-policy (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy6:
  • local-in-policy6 (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy6_dport:
  • dport (Required)
  • local-in-policy6 (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy6_dst:
  • dst (Required)
  • local-in-policy6 (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy6_intf:
  • intf (Required)
  • local-in-policy6 (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy6_src:
  • local-in-policy6 (Required)
  • src (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy_dport:
  • dport (Required)
  • local-in-policy (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy_dst:
  • dst (Required)
  • local-in-policy (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy_intf:
  • intf (Required)
  • local-in-policy (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_localinpolicy_src:
  • local-in-policy (Required)
  • src (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_locallog_disk_filter: None
  • params for cli_system_locallog_disk_setting: None
  • params for cli_system_locallog_fortianalyzer2_filter: None
  • params for cli_system_locallog_fortianalyzer2_setting: None
  • params for cli_system_locallog_fortianalyzer3_filter: None
  • params for cli_system_locallog_fortianalyzer3_setting: None
  • params for cli_system_locallog_fortianalyzer_filter: None
  • params for cli_system_locallog_fortianalyzer_setting: None
  • params for cli_system_locallog_memory_filter: None
  • params for cli_system_locallog_memory_setting: None
  • params for cli_system_locallog_setting: None
  • params for cli_system_locallog_syslogd2_filter: None
  • params for cli_system_locallog_syslogd2_setting: None
  • params for cli_system_locallog_syslogd3_filter: None
  • params for cli_system_locallog_syslogd3_setting: None
  • params for cli_system_locallog_syslogd_filter: None
  • params for cli_system_locallog_syslogd_setting: None
  • params for cli_system_log_alert: None
  • params for cli_system_log_devicedisable:
  • device-disable (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_log_deviceselector:
  • device-selector (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_log_fospolicystats: None
  • params for cli_system_log_interfacestats: None
  • params for cli_system_log_ioc: None
  • params for cli_system_log_maildomain:
  • mail-domain (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_log_pcapfile: None
  • params for cli_system_log_ratelimit: None
  • params for cli_system_log_ratelimit_device:
  • device (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_log_ratelimit_ratelimits:
  • ratelimits (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_log_settings: None
  • params for cli_system_log_settings_rollinganalyzer: None
  • params for cli_system_log_settings_rollinglocal: None
  • params for cli_system_log_settings_rollingregular: None
  • params for cli_system_log_topology: None
  • params for cli_system_log_ueba: None
  • params for cli_system_logfetch_clientprofile:
  • client-profile (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_logfetch_clientprofile_devicefilter:
  • client-profile (Required)
  • device-filter (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_logfetch_clientprofile_logfilter:
  • client-profile (Required)
  • log-filter (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_logfetch_serversettings: None
  • params for cli_system_logforward:
  • log-forward (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_logforward_devicefilter:
  • device-filter (Required)
  • log-forward (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_logforward_logfieldexclusion:
  • log-field-exclusion (Required)
  • log-forward (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_logforward_logfilter:
  • log-filter (Required)
  • log-forward (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_logforward_logmaskingcustom:
  • log-forward (Required)
  • log-masking-custom (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_logforwardservice: None
  • params for cli_system_mail:
  • mail (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_metadata_admins:
  • admins (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_ntp: None
  • params for cli_system_ntp_ntpserver:
  • ntpserver (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_passwordpolicy: None
  • params for cli_system_performance: None
  • params for cli_system_report_autocache: None
  • params for cli_system_report_estbrowsetime: None
  • params for cli_system_report_group:
  • group (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_report_group_chartalternative:
  • chart-alternative (Required)
  • group (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_report_group_groupby:
  • group (Required)
  • group-by (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_report_setting: None
  • params for cli_system_route:
  • route (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_route6:
  • route6 (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_saml: None
  • params for cli_system_saml_fabricidp:
  • fabric-idp (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_saml_serviceproviders:
  • service-providers (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_sniffer:
  • sniffer (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_snmp_community:
  • community (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_snmp_community_hosts:
  • community (Required)
  • hosts (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_snmp_community_hosts6:
  • community (Required)
  • hosts6 (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_snmp_sysinfo: None
  • params for cli_system_snmp_user:
  • user (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_socfabric: None
  • params for cli_system_socfabric_trustedlist:
  • trusted-list (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_sql: None
  • params for cli_system_sql_customindex:
  • custom-index (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_sql_customskipidx:
  • custom-skipidx (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_sql_tsindexfield:
  • ts-index-field (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_sslciphersuites:
  • ssl-cipher-suites (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_status: None
  • params for cli_system_syslog:
  • syslog (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_webproxy: None
  • params for cli_system_workflow_approvalmatrix:
  • approval-matrix (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for cli_system_workflow_approvalmatrix_approver:
  • approval-matrix (Required)
  • approver (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • params for dvmdb_adom:
  • adom (Required)
  • expand member (Optional) Fetch all or selected attributes of object members.
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • meta fields (Optional) Specify the meta field attributes to be returned in the result. If none specified, no meta field attribute will be returned.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. object member - Return a list of object members along with other attributes. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'object member', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for dvmdb_device:
  • adom (Required)
  • device (Required)
  • expand member (Optional) Fetch all or selected attributes of object members.
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • meta fields (Optional) Specify the meta field attributes to be returned in the result. If none specified, no meta field attribute will be returned.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. object member - Return a list of object members along with other attributes. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'object member', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for dvmdb_device_haslave:
  • adom (Required)
  • device (Required)
  • ha_slave (Required)
  • expand member (Optional) Fetch all or selected attributes of object members.
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. object member - Return a list of object members along with other attributes. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'object member', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for dvmdb_device_vdom:
  • adom (Required)
  • device (Required)
  • vdom (Required)
  • expand member (Optional) Fetch all or selected attributes of object members.
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • meta fields (Optional) Specify the meta field attributes to be returned in the result. If none specified, no meta field attribute will be returned.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. object member - Return a list of object members along with other attributes. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'object member', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for dvmdb_folder:
  • adom (Required)
  • folder (Required)
  • expand member (Optional) Fetch all or selected attributes of object members.
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. object member - Return a list of object members along with other attributes. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'object member', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for dvmdb_group:
  • adom (Required)
  • group (Required)
  • expand member (Optional) Fetch all or selected attributes of object members.
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • meta fields (Optional) Specify the meta field attributes to be returned in the result. If none specified, no meta field attribute will be returned.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. object member - Return a list of object members along with other attributes. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'object member', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for eventmgmt_alertfilter:
  • adom (Required)
  • alertid (Optional) Alert IDs.
  • ruleid (Optional) The rule id of the rule configured in correlated typed handler.
  • params for eventmgmt_alertincident_stats:
  • adom (Required)
  • time-range (Optional) Time range for source data selection.
  • timescale (Optional) Time scale. Only valid for type 'severity-timescale'.
  • Enum: ['month', 'hour']
  • Example: "month"
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • params for eventmgmt_alertlogs:
  • adom (Required)
  • alertid (Optional) Alert IDs.
  • limit (Optional) The max number of records to get.
  • Example: 1000
  • offset (Optional) offset of records to get.
  • rulename (Optional) The rule name of the rule configured in correlated typed handler.
  • time-order (Optional) Sort result in descending or ascending order by time
  • Enum: ['desc', 'asc']
  • Example: "desc"
  • params for eventmgmt_alertlogs_count:
  • adom (Required)
  • alertid (Optional) Alert IDs.
  • rulename (Optional) The rule name of the rule configured in correlated typed handler.
  • params for eventmgmt_alerts:
  • adom (Required)
  • filter (Optional) Filter expression. 'event_value', 'severity', 'trigger_name', 'count', 'comment' and 'flags' are supported. i.e.: trigger_name='Local Device Event' and severity >= 3
  • limit (Optional) The max number of records to get.
  • Example: 1000
  • offset (Optional) offset of records to get.
  • time-range (Optional) Time range for data selection.
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • params for eventmgmt_alerts_count:
  • adom (Required)
  • filter (Optional) Filter expression. 'ackflag', 'assigned', 'mgmt_state', 'triggername', 'eventtype', 'severity', 'eventstatus' and 'tag' are supported. i.e.: ackflag = no and triggername='Local Device Event'. Note: the field 'ackflag' supports = yes/no, !=yes/no and <>yes/no , the field 'assigned' only supports = yes/no or !=yes/no, the field 'mgmt_state' only supports (!)= acknowledged/triaged/pending_triage
  • group-by (Optional) Get alert count by group.
  • Enum: ['severity', 'trigger', 'severity_timescale', 'eventtype', 'mgmt_state', 'severity_epdevtype']
  • time-range (Optional) Time range for source data selection.
  • timescale (Optional) Time scale. Only valid for type 'severity-timescale'.
  • Enum: ['month', 'hour']
  • Example: "month"
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • type (Optional) Get alert count by type.
  • Enum: ['severity', 'trigger', 'severity-timescale']
  • params for eventmgmt_alerts_export:
  • adom (Required)
  • attachment (Optional) Objects that will be exported with event handlers.
  • data-format (Optional) The format of the exporting data.
  • Enum: ['zip', 'txt', 'cli']
  • Example: "zip"
  • filter (Optional) A filter for selecting exporting event handlers. Filter Refrence
  • Example: ['id', 'in', 1, 10041]
  • params for eventmgmt_alerts_extradetails:
  • adom (Required)
  • alertids (Optional) Alert IDs.
  • params for eventmgmt_basichandlers_export:
  • adom (Required)
  • attachment (Optional) Objects that will be exported with basic handlers.
  • data-format (Optional) The format of the exporting data.
  • Enum: ['zip', 'txt', 'cli']
  • Example: "zip"
  • filter (Optional) A filter for selecting exporting basic handlers. Filter Refrence
  • Example: ['handler-id', 'in', 1, 10041]
  • params for eventmgmt_config_basichandler:
  • adom (Required)
  • params for eventmgmt_config_correlationhandler:
  • adom (Required)
  • params for eventmgmt_config_dataselector:
  • adom (Required)
  • params for eventmgmt_config_notificationprofile:
  • adom (Required)
  • params for eventmgmt_config_trigger:
  • adom (Required)
  • params for eventmgmt_config_trigger_device:
  • adom (Required)
  • trigger_id (Required)
  • params for eventmgmt_config_trigger_filter:
  • adom (Required)
  • trigger_id (Required)
  • params for eventmgmt_config_trigger_filter_rule:
  • adom (Required)
  • filter_id (Required)
  • trigger_id (Required)
  • params for eventmgmt_correlationhandlers_export:
  • adom (Required)
  • attachment (Optional) Objects that will be exported with correlation handlers.
  • data-format (Optional) The format of the exporting data.
  • Enum: ['zip', 'txt', 'cli']
  • Example: "zip"
  • filter (Optional) A filter for selecting exporting correlation handlers. Filter Refrence
  • Example: ['handler-id', 'in', 1, 10041]
  • params for fazsys_enduseravatar:
  • adom (Required)
  • user (Optional) A structure that hold the users info. One user is identified by ('epid' and 'euid') or ('name' and 'fctuid')
  • params for fazsys_forticare_licinfo:
  • adom (Required)
  • params for fazsys_language_fonts_export:
  • font (Optional) Font name, e.g. 'UnBatang', 'Open Sans', etc, filter for exporting font file.
  • Example: ['UnBatang', 'Open Sans']
  • params for fazsys_language_fonts_list:
  • font (Optional) Font name, e.g. 'UnBatang', 'Open Sans', etc, filter for exporting font file.
  • Example: ['UnBatang', 'Open Sans']
  • params for fazsys_language_translationfile_export:
  • language (Optional) Language code list, e.g. 'en', 'zh', 'ja' etc, filter for exporting language translation file.
  • Example: ['en', 'zh']
  • params for fazsys_language_translationfile_list:
  • language (Optional)
  • params for fazsys_lograte_history:
  • adom (Required)
  • time-range (Optional) Time range for source data selection.
  • params for fazsys_monitor_logforwardstatus:
  • id (Optional) An array of the log forwarding server ID. If the ID array is empty or omitted, status of all log forwarding servers will be returned.
  • params for fazsys_monitor_system_performance_status: None
  • params for fazsys_storageinfo:
  • filter (Optional) The field filter string.
  • params for fazsys_storageinfohistory:
  • adom (Required)
  • time-range (Optional) Time range for source data selection.
  • params for fortiview_run:
  • adom (Required)
  • tid (Required)
  • view-name (Required)
  • params for incidentmgmt_attachments:
  • adom (Required)
  • attachtype (Optional) The attachment type.
  • Enum: ['alertevent', 'note', 'file', 'report', 'log', 'comment', 'logsearchfilter', 'uploadfile', 'history', 'sysnote', 'enrichment']
  • incid (Optional) The incident ID.
  • Example: "IN12345678"
  • limit (Optional) The maximun number of records to get.
  • Example: 50
  • offset (Optional) The offset of records to get.
  • params for incidentmgmt_attachments_count:
  • adom (Required)
  • attachtype (Optional) The attachment type.
  • Enum: ['alertevent', 'log', 'comment', 'logsearchfilter', 'uploadfile', 'report', 'note', 'file', 'history', 'sysnote', 'enrichment']
  • incid (Optional) The incident ID.
  • Example: "IN12345678"
  • params for incidentmgmt_epeuhistory:
  • adom (Required)
  • incid (Optional) The incident ID.
  • Example: "IN12345678"
  • limit (Optional) The maximun number of records to get.
  • Example: 50
  • offset (Optional) The offset of records to get.
  • params for incidentmgmt_incident_stats:
  • adom (Required)
  • filter (Optional) The query filter.
  • stats-item (Optional) The stats item list.
  • time-range (Optional)
  • params for incidentmgmt_incidents:
  • adom (Required)
  • detail-level (Optional) The detail level of return data, basic, standard(default) or extended.
  • filter (Optional) The query filter.
  • incids (Optional) The incident ID list.
  • limit (Optional) The maximun number of records to get.
  • Example: 50
  • offset (Optional) The offset of records to get.
  • sort-by (Optional) Sort by field.
  • params for incidentmgmt_incidents_count:
  • adom (Required)
  • filter (Optional) The query filter.
  • incids (Optional) The incident ID list.
  • params for ioc_license_state: None
  • params for ioc_rescan_history:
  • adom (Required)
  • params for ioc_rescan_run:
  • adom (Required)
  • params for logview_logfields:
  • adom (Required)
  • devtype (Optional) Device type name, such as FortiGate, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiDDos, FortiDeceptor
  • logtype (Optional) Logtype names
  • Enum: ['traffic', 'app-ctrl', 'attack', 'content', 'dlp', 'emailfilter', 'event', 'history', 'virus', 'voip', 'webfilter', 'netscan', 'fct-event', 'fct-traffic', 'waf', 'gtp', 'ztna', 'security']
  • subtype (Optional) Subtype names.
  • params for logview_logfiles_data:
  • adom (Required)
  • data-type (Optional) The type of return data, e.g. 'text/gzip/base64'.
  • Enum: ['base64', 'csv/gzip/base64', 'text/gzip/base64']
  • Example: "base64"
  • devid (Optional) ID of the device hosting the logfile.
  • Enum: ['device-id', 'All_FortiGate', 'All_FortiMail', 'All_FortiWeb', 'All_FortiManager', 'All_Syslog', 'All_FortiClient', 'All_FortiCache', 'All_FortiProxy', 'All_FortiAnalyzer', 'All_FortiSandbox', 'All_FortiAuthenticator', 'All_FortiDDoS']
  • filename (Optional) Name of the file.
  • Example: "filename"
  • length (Optional) Length in byte of the file content to return. Default is 1MB, the maximum is 50MB.
  • Example: 1048576
  • offset (Optional) Offset bytes from the beginning of the file.
  • vdom (Optional) Name of the VDOM. If left empty, all VDOM under the will be considered.
  • Example: "root"
  • params for logview_logfiles_search:
  • adom (Required)
  • case-sensitive (Optional) Case sensitivty.
  • Example: True
  • devid (Optional) ID of the device hosting the logfile.
  • Enum: ['device-id', 'All_FortiGate', 'All_FortiMail', 'All_FortiWeb', 'All_FortiManager', 'All_Syslog', 'All_FortiClient', 'All_FortiCache', 'All_FortiProxy', 'All_FortiAnalyzer', 'All_FortiSandbox', 'All_FortiAuthenticator', 'All_FortiDDoS']
  • filename (Optional) File name to search.
  • filter (Optional) Filter to apply.
  • limit (Optional) Maximum number of log records to fetch.
  • Example: 50
  • logtype (Optional) Name of the logtype.
  • Enum: ['traffic', 'app-ctrl', 'attack', 'content', 'dlp', 'emailfilter', 'event', 'history', 'virus', 'voip', 'webfilter', 'netscan', 'fct-event', 'fct-traffic', 'waf', 'gtp']
  • offset (Optional) Offset number of log records from the beginning of the log file.
  • vdom (Optional) Name of the VDOM hosting the logfile.
  • params for logview_logfiles_state:
  • adom (Required)
  • devid (Optional) ID of the device. If left empty, all devices under the will be considered. See Appendix for available options
  • Enum: ['device-id', 'All_FortiGate', 'All_FortiMail', 'All_FortiWeb', 'All_FortiManager', 'All_Syslog', 'All_FortiClient', 'All_FortiCache', 'All_FortiProxy', 'All_FortiAnalyzer', 'All_FortiSandbox', 'All_FortiAuthenticator', 'All_FortiDDoS']
  • filename (Optional) name of the file. If left empty, all files under the will be considered
  • time-range (Optional) Time range for data selection.
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • vdom (Optional) Name of the VDOM. If left empty, all VDOM under the will be considered.
  • Example: "root"
  • params for logview_logsearch:
  • adom (Required)
  • tid (Required)
  • limit (Optional) Number of records to return.
  • Example: 50
  • offset (Optional) Number of records to offset.
  • params for logview_logsearch_count:
  • adom (Required)
  • tid (Required)
  • params for logview_logstats:
  • adom (Required)
  • device (Optional) Device filter. For all devices in some type please use the All-Device ID. See Appendix
  • params for logview_pcapfile:
  • key-data (Optional) The key for searching pcapfile. It supports three type of data: 1) JSON format log , 2) txt format log and 3) pcapurl. A pcapurl can be found in the logsearch result if the log does have an associated pcap file. e.g. 'pcapfile?ZGV2aWQ9IkZHMjAwRTRRMTc5MTYwNTkiIHZkPSJyb290IiBzdWJ0eXBlPSJhcHAtY3RybCIgY2hlY2tzdW09IiIgZXBvY2g9MCBpbmNpZGVudHNlcmlhbG5vPTM4NjE4Mzg5OSBzZXJ2aWNlPSJTU0wiIHR5cGU9InV0bSIgZXZlbnRpZD0wIGluZGVudGlkeD0wIGZpbGVwYXRoPSIvaXBzX2ZpbGVzL0ZHMjAwRTRRMTc5MTYwNTkvcm9vdC8xNjM0ODUxNTU0LzM4NjE4Mzg5OTowIg==\'. For more details, please click 'Show examples...' .
  • key-type (Optional) The type of the given key-data.
  • Enum: ['log-data', 'pcapurl']
  • params for report_config_chart:
  • adom (Required)
  • params for report_config_chart_drilldowntable:
  • adom (Required)
  • chart_name (Required)
  • params for report_config_chart_tablecolumns:
  • adom (Required)
  • chart_name (Required)
  • params for report_config_chart_variabletemplate:
  • adom (Required)
  • chart_name (Required)
  • params for report_config_dataset:
  • adom (Required)
  • params for report_config_dataset_variable:
  • adom (Required)
  • dataset_name (Required)
  • params for report_config_layout:
  • adom (Required)
  • params for report_config_layout_component:
  • adom (Required)
  • layout-id (Required)
  • params for report_config_layout_component_variable:
  • adom (Required)
  • component-id (Required)
  • layout-id (Required)
  • params for report_config_layout_footer:
  • adom (Required)
  • layout-id (Required)
  • params for report_config_layout_header:
  • adom (Required)
  • layout-id (Required)
  • params for report_config_layoutfolder:
  • adom (Required)
  • params for report_config_macro:
  • adom (Required)
  • params for report_config_output:
  • adom (Required)
  • params for report_config_output_emailrecipients:
  • adom (Required)
  • output-name (Required)
  • params for report_config_schedule:
  • adom (Required)
  • params for report_config_schedule_addressfilter:
  • adom (Required)
  • schedule_name (Required)
  • params for report_config_schedule_devices:
  • adom (Required)
  • schedule_name (Required)
  • params for report_config_schedule_filter:
  • adom (Required)
  • schedule_name (Required)
  • params for report_config_schedule_reportlayout:
  • adom (Required)
  • schedule_name (Required)
  • params for report_configfile_export:
  • adom (Required)
  • layout-id (Optional) ID of the exported layout.
  • name (Optional) Title of the exported layout.
  • params for report_graphfile:
  • adom (Required)
  • file-name (Optional) Graph file name.
  • params for report_graphfile_data:
  • adom (Required)
  • file-name (Optional) Graph file name.
  • params for report_graphfile_list:
  • adom (Required)
  • file-name (Optional) Names of the graph files that will be listed. Without this param, all files in the folder will be listed.
  • params for report_reports_data:
  • adom (Required)
  • tid (Required)
  • data-type (Optional) One option to download the text format of XML or CSV reports, e.g. 'text'.
  • Example: "text"
  • format (Optional) One format got by /report/adom/<adom-name>/reports/state. Such as HTML, PDF, XML, CSV.
  • Example: "PDF"
  • params for report_reports_state:
  • adom (Required)
  • sort-by (Optional) Sort by fields. Only support one field for this API.
  • state (Optional) pending-running, or generated.
  • time-range (Optional) Time range for source data selection.
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • title (Optional) Title of a report.
  • params for report_run:
  • adom (Required)
  • tid (Required)
  • params for report_template_export:
  • adom (Required)
  • dev-type (Optional) Device type abbreviation, e.g. 'fgt', 'fml' etc.
  • Example: "fgt"
  • language (Optional) Language name, e.g. 'en', 'zh', 'ja' etc, filter for exporting report template.
  • Example: "en"
  • title (Optional) Template title, filter for exporting report template.
  • params for report_template_language:
  • adom (Required)
  • params for report_template_list:
  • adom (Required)
  • dev-type (Optional) Device type abbreviation, e.g. 'fgt', 'fml' etc.
  • Example: "fgt"
  • language (Optional) Language name, 'en', 'zh', 'ja' etc, filter for listing report template.
  • Example: "en"
  • params for soar_alert_indicator:
  • adom (Required)
  • alert-id (Optional) The alert ID.
  • filter (Optional) Filter expression. 'indicator-uuid', 'type', 'value', 'status', 'enrichment-uuid', 'enrichment-status' and 'enrichment-reputation' are supported. i.e.: indicator-uuid='8a409a0f-e4b7-4c71-8e42-a03748496b13' and value = '8.8.8.8'
  • params for soar_config_connectors:
  • adom (Required)
  • connector-uuid (Required)
  • params for soar_config_playbooks:
  • adom (Required)
  • playbook-uuid (Required)
  • params for soar_fosconnector_automationrules:
  • adom (Required)
  • params for soar_incident_indicator:
  • adom (Required)
  • filter (Optional) Filter expression. 'indicator-uuid', 'type', 'value', 'status', 'enrichment-uuid', 'enrichment-status' and 'enrichment-reputation' are supported. i.e.: indicator-uuid='8a409a0f-e4b7-4c71-8e42-a03748496b13' and value = '8.8.8.8'
  • incident-id (Optional) The incident ID.
  • params for soar_indicator:
  • adom (Required)
  • filter (Optional) Filter expression. 'indicator-uuid', 'type', 'value', 'status', 'enrichment-uuid', 'enrichment-status' and 'enrichment-reputation' are supported. i.e.: indicator-uuid='8a409a0f-e4b7-4c71-8e42-a03748496b13,2828ad45-82a7-4173-844e-40b2259ab556' and value = '8.8.8.8'
  • limit (Optional) The max number of records to get.
  • Example: 100
  • offset (Optional) offset of records to get.
  • option (Optional) This option defines whether the response should include a array of incident_ids and alert_ids associated with the indicator. Leaving this option empty or omitting it entirely will exclude incident and alert ID data from the response.
  • time-range (Optional) Time range for data selection. If not exist, default time-range is 7 days from current time.
  • params for soar_indicator_enrichment:
  • adom (Required)
  • enrichment_uuid (Required)
  • detail-level (Optional) Specify whether include enrichment-detail in response data. 'standard' not included, 'extended' included. Leaving this parameter empty or omitting it entirely will default to 'standard' details.
  • Enum: ['standard', 'extended']
  • indicator-type (Optional) The indicator type.
  • Enum: ['IP', 'URL', 'Domain']
  • indicator-uuid (Optional) The indicator UUID.
  • indicator-value (Optional) The indicator value.
  • params for soar_playbook_export:
  • adom (Required)
  • attachment (Optional) Objects that will be exported with event handlers.
  • data-format (Optional) The format of the exporting data.
  • Enum: ['zip', 'txt']
  • Example: "zip"
  • filter (Optional) A filter for selecting exporting playbooks. Filter Refrence
  • Example: ['uuid', 'in', '941a1c06-2841-47c5-b45b-ca429d23a332', '2b36d3c6-537f-4671-8280-44549f824e6a']
  • params for soar_playbook_monitor:
  • adom (Required)
  • filter (Optional) Filtering expresion.
  • Example: "trigger-source-id<>'IN00019917' playbook-name~'Shawn - Event trigger-LocalHostConnector'"
  • instance-id (Optional) Instance ID to get.
  • playbook-uuid (Optional) Playbook UUID to get. An unique identifier of a playbook. 32 hexadecimal digits is displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters
  • sort-by (Optional) Sort by field.
  • time-range (Optional) Time range for source data selection.
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • params for soar_playbook_run:
  • adom (Required)
  • filter (Optional) Filtering expresion.
  • Example: "trigger-source-id<>'IN00019917' playbook-name~'Shawn - Event trigger-LocalHostConnector'"
  • instance-id (Optional) Instance ID to get.
  • playbook-uuid (Optional) An unique identifier of a playbook. 32 hexadecimal digits is displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters.
  • Example: "2b36d3c6-537f-4671-8280-44549f824e6a"
  • sort-by (Optional) Sort by field.
  • time-range (Optional) Time range for source data selection.
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • params for soar_playbook_runlog:
  • adom (Required)
  • run-id (Required)
  • detail-on-error (Optional) Specify whether include detail in log if error happened. missing or empty is 'true'
  • Enum: ['true', 'false']
  • params for soar_subnet_export:
  • adom (Required)
  • data-format (Optional) The format of the exporting data.
  • Enum: ['zip', 'txt']
  • Example: "txt"
  • filter (Optional) A filter for selecting exporting subnets and subnet groups
  • params for soar_task_monitor:
  • adom (Required)
  • filter (Optional) Filtering expresion.
  • Example: "state<>'success'"
  • instance-id (Optional) Instance ID to get.
  • playbook-uuid (Optional) Playbook UUID to get. An unique identifier of a playbook. 32 hexadecimal digits is displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters
  • run-id (Optional) Run ID to track specific playbook run
  • sort-by (Optional) Sort by field.
  • time-range (Optional) Time range for source data selection.
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • params for sys_ha_status: None
  • params for sys_status: None
  • params for task_task:
  • task (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for task_task_history:
  • history (Required)
  • task (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for task_task_line:
  • line (Required)
  • task (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for task_task_line_history:
  • history (Required)
  • line (Required)
  • task (Required)
  • fields (Optional) Limit the output by returning only the attributes specified in the string array. If none specified, all attributes will be returned.
  • filter (Optional) Filter the result according to a set of criteria.
  • loadsub (Optional) Enable or disable the return of any sub-objects. If not specified, the default is to return all sub-objects.
  • option (Optional) Set fetch option for the request. If no option is specified, by default the attributes of the objects will be returned. count - Return the number of matching entries instead of the actual entry data. syntax - Return the attribute syntax of a table or an object, instead of the actual entry data. All filter parameters will be ignored.
  • Enum: ['count', 'syntax']
  • range (Optional) Limit the number of output. For a range of [a, n], the output will contain n elements, starting from the a^th matching result.
  • sortings (Optional) Specify the sorting of the returned result.
  • params for ueba_endpoints:
  • adom (Required)
  • detail-level (Optional) The level of details to get.
  • Enum: ['basic', 'standard', 'simple']
  • Example: "basic"
  • epids (Optional) The endpoint ID list.
  • filter (Optional) The query filter.
  • Example: "epname='VAN-201437-PC'"
  • limit (Optional) The maximun number of records to get.
  • Example: 100000
  • offset (Optional) The offset of records to get.
  • sort-by (Optional) Sort by field.
  • time-range (Optional) Time range for endpoints. (required if the epids field is not provided)
  • params for ueba_endpoints_stats:
  • adom (Required)
  • filter (Optional) The query filter.
  • Example: "category=IOT"
  • stats-item (Optional) an array of strings that holds the requested stats type.
  • time-range (Optional) Time range for endpoint stats.
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • params for ueba_endpoints_vuln:
  • adom (Required)
  • detectby (Optional) The vulnerabilities detection source. 'FortiGate' by default.
  • Enum: ['FortiClient', 'FortiGate']
  • epids (Optional) The endpoint ID list.
  • filter (Optional) The query filter.
  • limit (Optional) The maximun number of records to get.
  • Example: 100000
  • offset (Optional) The offset of records to get.
  • sort-by (Optional) Sort by field.
  • params for ueba_endusers:
  • adom (Required)
  • detail-level (Optional) The level of details to get.
  • Enum: ['basic', 'standard', 'extended']
  • Example: "standard"
  • euids (Optional) The enduser ID list.
  • filter (Optional) The query filter.
  • Example: "euname='localhost'"
  • limit (Optional) The maximun number of records to get.
  • Example: 100000
  • offset (Optional) The offset of records to get.
  • sort-by (Optional) Sort by field.
  • params for ueba_endusers_stats:
  • adom (Required)
  • stats-item (Optional) an array of strings that holds the requested stats type.
  • time-range (Optional) Time range for enduser stats.
  • timezone (Optional) The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix
  • params for ueba_otview:
  • adom (Required)
  • filter (Optional) The query filter. (only support devid filtering now)
  • Example: "devid=FGVM02TM23001113"
  • group-by (Optional) Group by field.

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)

• Maxx Liu (@MaxxLiu22)

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)