fortios_configuration_fact – Retrieve Facts of FortiOS Configurable Objects.

New in version 2.10.

Synopsis

  • Collects facts from network devices running the fortios operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. This facts module will only collect those facts which user specified in playbook.

Requirements

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

  • install galaxy collection fortinet.fortios

Parameters

  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str required: False default: root
  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
  • selector - selector of the retrieved fortimanager facts type: str choices:

    • log_gui-display
    • diagnose__tree__.vpn_l2tp
    • execute__tree__.fortiguard-log_try
    • execute__tree__.batch_end
    • execute__tree__.restore.vmlicense_ftp
    • execute__tree__.set.system.session.filter.negate_sport
    • execute__tree__.ping6-options_source
    • diagnose__tree__.ips_urlfilter
    • log.fortianalyzer_override-setting
    • execute__tree__.backup.config-with-forticlient-info_usb
    • execute__tree__.log_list
    • firewall.ssl_setting
    • vpn.ipsec_phase2-interface param: name type: str
    • router_key-chain param: name type: str
    • system_ddns param: ddnsid type: int
    • system_replacemsg-group param: name type: str
    • execute__tree__.set.system.session.filter.negate_duration
    • system_ftm-push
    • system_sms-server param: name type: str
    • firewall_central-snat-map param: policyid type: int
    • firewall_multicast-address6 param: name type: str
    • execute__tree___factoryreset2
    • execute__tree___update-list
    • execute__tree__.wireless-controller_led-blink
    • execute__tree__.revision.list_config
    • system.replacemsg_sslvpn param: msg_type type: str
    • diagnose__tree__.ips.av_stats
    • system_pppoe-interface param: name type: str
    • execute__tree__.wireless-controller.upload-wtp-image_ftp
    • diagnose__tree___wireless-controller
    • execute__tree___update-geo-ip
    • diagnose__tree___lldptx
    • firewall_addrgrp6 param: name type: str
    • log.disk_filter
    • system_affinity-packet-redistribution param: id type: int
    • diagnose__tree__.ip_tcp
    • firewall_proxy-address param: name type: str
    • execute__tree__.restore.config.management-station_normal
    • execute__tree__.dhcp6_lease-list
    • authentication_rule param: name type: str
    • execute__tree__.wireless-controller.hs20-icon_list-hs-icon
    • execute__tree__.switch-controller_set-standalone
    • execute__tree___ping
    • execute__tree___set-next-reboot
    • execute__tree__.backup.memory.log_ftp
    • execute__tree__.ping6-options_interval
    • execute__tree__.firewall.ssh.generate_local-key
    • router_bfd
    • execute__tree__.restore.image_tftp
    • execute__tree__.upload.image_tftp
    • execute__tree__.backup.disk.log_tftp
    • execute__tree__.fortitoken.import_usb
    • switch-controller_custom-command param: command_name type: str
    • system_resource-limits
    • execute__tree__.report_flush-cache
    • system.replacemsg_auth param: msg_type type: str
    • system.autoupdate_schedule
    • execute__tree__.restore.secondary-image_usb
    • execute__tree__.central-mgmt_register-device
    • execute__tree__.backup.config_usb
    • execute__tree__.restore.script_tftp
    • waf_sub-class param: id type: int
    • firewall_local-in-policy6 param: policyid type: int
    • diagnose__tree__.ips_raw
    • log.fortianalyzer_override-filter
    • system.replacemsg_icap param: msg_type type: str
    • system_object-tagging param: category type: str
    • spamfilter_profile param: name type: str
    • execute__tree___update-now
    • execute__tree__.ping-options_tos
    • diagnose__tree___vmware
    • spamfilter_bwl param: id type: int
    • execute__tree__.extender_delete-fortiextender-image
    • execute__tree__.webcache.delete_simple-string
    • execute__tree__.set.system.session.filter.negate_proto
    • web-proxy_profile param: name type: str
    • diagnose__tree__.webfilter_fortiguard
    • execute__tree__.auto-script_delete
    • diagnose__tree___cp
    • diagnose__tree__.ipv6_devconf
    • spamfilter_mheader param: id type: int
    • router_route-map param: name type: str
    • diagnose__tree__.ip_ipip-tunnel
    • user_adgrp param: name type: str
    • system_auto-script param: name type: str
    • switch-controller_quarantine
    • firewall.service_category param: name type: str
    • execute__tree__.router.clear.ospf6_process
    • execute__tree__.switch-controller.get-physical-conn_dot
    • system_link-monitor param: name type: str
    • switch-controller_stp-settings
    • user_security-exempt-list param: name type: str
    • execute__tree__.mrouter.clear_igmp-interface
    • diagnose__tree___antivirus
    • execute__tree__.log.filter_dump
    • firewall_sniffer param: id type: int
    • execute__tree__.vpn.certificate.ca.export_tftp
    • execute__tree__.vpn.sslvpn_del-all
    • execute__tree__.restore.config_flash
    • log.fortiguard_override-setting
    • execute__tree__.mrouter.clear_multicast-routes
    • firewall_internet-service param: id type: int
    • execute__tree__.interface_dhcpclient-renew
    • execute__tree__.tac_report
    • firewall_vipgrp46 param: name type: str
    • log.webtrends_filter
    • webfilter_ips-urlfilter-setting6
    • router_prefix-list6 param: name type: str
    • execute__tree__.extender_list-fortiextender-image
    • log_setting
    • firewall_address6-template param: name type: str
    • wireless-controller.hotspot20_h2qp-wan-metric param: name type: str
    • system_automation-action param: name type: str
    • system.autoupdate_tunneling
    • diagnose__tree__.ip.router_isis
    • execute__tree__.nsx.group_delete
    • webfilter_ips-urlfilter-setting
    • execute__tree__.wireless-controller.hs20-icon.upload-icon_ftp
    • execute__tree__.restore.config_usb-mode
    • execute__tree__.vpn.sslvpn_del-tunnel
    • switch-controller_network-monitor-settings
    • system_alias param: name type: str
    • diagnose__tree___endpoint
    • switch-controller_mac-sync-settings
    • web-proxy_forward-server-group param: name type: str
    • execute__tree__.upload.report-img_ftp
    • execute__tree__.switch-controller.restart-swtp-delayed_all
    • system_session-helper param: id type: int
    • router_community-list param: name type: str
    • wireless-controller_qos-profile param: name type: str
    • firewall_dnstranslation param: id type: int
    • vpn.ssl.web_portal param: name type: str
    • system_vdom-property param: name type: str
    • system.replacemsg_device-detection-portal param: msg_type type: str
    • log.syslogd2_setting
    • firewall_internet-service-custom-group param: name type: str
    • firewall_profile-group param: name type: str
    • execute__tree__.ping-options_adaptive-ping
    • diagnose__tree__.ip_udp
    • diagnose__tree__.vpn_ipsec
    • execute__tree__.backup.disk.log_ftp
    • firewall.service_group param: name type: str
    • system.autoupdate_push-update
    • firewall_address6 param: name type: str
    • endpoint-control_profile param: profile_name type: str
    • execute__tree__.usb-disk_eject
    • execute__tree__.interface_dhcp6client-renew
    • diagnose__tree___traffictest
    • wireless-controller_wids-profile param: name type: str
    • execute__tree__.vpn.certificate.local.generate_default-ssl-ca
    • log.fortiguard_filter
    • firewall_ipv6-eh-filter
    • execute__tree___sync-session
    • execute__tree__.mrouter.clear_igmp-group
    • user_device-category param: name type: str
    • diagnose__tree___wacs
    • execute__tree__.restore.image_ftp
    • firewall_identity-based-route param: name type: str
    • execute__tree__.switch-controller_push-swtp-image
    • system_console
    • diagnose__tree__.vpn_concentrator
    • system_ntp
    • router_bgp
    • system_nat64
    • execute__tree__.ping-options_reset
    • execute__tree__.set.system.session.filter.clear_sport
    • system.3g-modem_custom param: id type: int
    • report_layout param: name type: str
    • wireless-controller_timers
    • diagnose__tree___src-vis
    • execute__tree__.set.system.session.filter_expire
    • execute__tree__.vpn.certificate.local.generate_rsa
    • execute__tree__.router_restart
    • diagnose__tree___wad
    • wireless-controller.hotspot20_icon param: name type: str
    • diagnose__tree___waf
    • execute__tree__.wireless-controller_delete-wtp-image
    • execute__tree__.log_flush-cache
    • execute__tree__.backup.config_management-station
    • log.memory_global-setting
    • router_multicast-flow param: name type: str
    • ssh-filter_profile param: name type: str
    • system_fortisandbox
    • execute__tree__.modem_hangup
    • system_virtual-wan-link
    • ips_sensor param: name type: str
    • firewall.wildcard-fqdn_custom param: name type: str
    • router_static param: seq_num type: int
    • execute__tree___disconnect-admin-session
    • execute__tree__.switch-controller_custom-command
    • alertemail_setting
    • diagnose__tree__.ip.router_command
    • diagnose__tree___alertconsole
    • diagnose__tree___forticare
    • execute__tree__.fortitoken.import_ftp
    • router_policy param: seq_num type: int
    • user_fortitoken param: serial_number type: str
    • execute__tree__.replace-device_fortiap
    • web-proxy_debug-url param: name type: str
    • execute__tree__.switch-controller.restart-swtp-delayed_switch-group
    • execute__tree__.switch-controller_get-conn-status
    • execute__tree__.vpn.sslvpn_rdel-tunnel
    • execute__tree__.vpn.certificate.local.generate_default-ssl-serv-key
    • diagnose__tree___fdsm
    • webfilter_override param: id type: int
    • diagnose__tree__.ipv6_ipv6-tunnel
    • execute__tree__.vpn.certificate.local_verify
    • execute__tree__.log.filter_start-line
    • execute__tree__.ping6-options_view-settings
    • system_fsso-polling
    • user_peer param: name type: str
    • vpn.ssl.web_host-check-software param: name type: str
    • execute__tree___forticarrier-license
    • switch-controller_lldp-profile param: name type: str
    • execute__tree__.policy-packet-capture_delete-all
    • execute__tree__.switch-controller_trigger-config-sync
    • execute__tree__.backup.config_tftp
    • vpn.ssl.web_realm param: url_path type: str
    • system_stp
    • execute__tree__.ha_synchronize
    • execute__tree__.upload.report-img_tftp
    • execute__tree__.ping-options_df-bit
    • execute__tree__.set.system.session.filter.clear_proto
    • execute__tree__.webcache.delete_regular-expression
    • switch-controller.security-policy_captive-portal param: name type: str
    • firewall_shaping-policy param: id type: int
    • execute__tree__.fortiguard-message_add
    • log_custom-field param: id type: str
    • execute__tree__.ping6-options_ttl
    • firewall_address param: name type: str
    • certificate_crl param: name type: str
    • execute__tree__.restore.config.management-station_template
    • execute__tree__.backup.disk.alllogs_tftp
    • execute__tree__.set.system.session.filter.clear_dst
    • firewall.ssh_setting
    • execute__tree__.wireless-controller.upload-wtp-image_tftp
    • diagnose__tree__.ip.router_igmp
    • router_access-list param: name type: str
    • log.memory_setting
    • system_alarm
    • diagnose__tree__.vpn_ike
    • system_ipv6-neighbor-cache param: id type: int
    • diagnose__tree__.test_application
    • execute__tree__.interface_pppoe-reconnect
    • execute__tree__.fortiguard-log_login
    • diagnose__tree__.webfilter_bword
    • execute__tree__.switch-controller_clear-igmp-snoop
    • system_cluster-sync param: sync_id type: int
    • wanopt_settings
    • endpoint-control_registered-forticlient param: uid type: str
    • system_dedicated-mgmt
    • diagnose__tree___disktest
    • execute__tree__.wireless-controller_list-wtp-image
    • execute__tree__.vpn.certificate.ca.import_tftp
    • execute__tree__.usb-disk_list
    • diagnose__tree__.ip_multicast
    • diagnose__tree__.ips.av_timeout
    • firewall_policy46 param: policyid type: int
    • execute__tree__.vpn.sslvpn_rdel-web
    • execute__tree__.vpn.certificate.local.import_tftp
    • diagnose__tree__.ipv6_route
    • execute__tree__.router.clear.bgp_flap-statistics
    • execute__tree__.fortiguard-log_join
    • antivirus_settings
    • execute__tree__.wireless-controller_restart-acd
    • switch-controller_802-1X-settings
    • execute__tree__.switch-controller_restart-swtpd
    • execute__tree__.backup.memory.alllogs_ftp
    • execute__tree__.fortitoken_import-sn-file
    • system_session-ttl
    • execute__tree__.extender.upload-fortiextender-image_tftp
    • diagnose__tree___central-mgmt
    • system_storage param: name type: str
    • execute__tree__.fortiguard-log_create-account
    • execute__tree__.fortiguard-message_update
    • log.memory_filter
    • firewall_auth-portal
    • system_sflow
    • user_ldap param: name type: str
    • diagnose__tree___rsso
    • ips_global
    • wanopt_remote-storage
    • execute__tree__.vpn.certificate.local.generate_default-ssl-key-certs
    • wireless-controller.hotspot20_qos-map param: name type: str
    • vpn_l2tp
    • diagnose__tree___fortiview
    • diagnose__tree__.ip_rtcache
    • firewall_vip46 param: name type: str
    • execute__tree__.usb-disk_delete
    • execute__tree__.wireless-controller.hs20-icon.backup-icon_tftp
    • execute__tree__.wireless-controller.hs20-icon_delete-hs-icon
    • execute__tree__.usb-disk_format
    • authentication_setting
    • vpn.certificate_ocsp-server param: name type: str
    • diagnose__tree___spamfilter
    • execute__tree__.traceroute-options_source
    • antivirus_heuristic
    • spamfilter_bword param: id type: int
    • system_custom-language param: name type: str
    • web-proxy_explicit
    • execute__tree__.disk_format
    • execute__tree__.log_display
    • execute__tree___factory-license
    • wireless-controller_wtp-group param: name type: str
    • execute__tree__.backup.disk.ipsarchives_usb
    • execute__tree__.report_recreate-db
    • execute__tree__.set.system.session.filter.clear_dport
    • system_vdom-sflow
    • switch-controller_igmp-snooping
    • waf_signature param: id type: int
    • execute__tree__.fortitoken-mobile_import
    • log.null-device_setting
    • ips_rule-settings param: id type: int
    • log.syslogd_setting
    • execute__tree__.backup.memory.alllogs_tftp
    • diagnose__tree__.ipv6.router_rip
    • switch-controller.security-policy_802-1X param: name type: str
    • report_setting
    • execute__tree__.set.system.session.filter_policy
    • execute__tree__.set.system.session.filter.negate_expire
    • user_setting
    • diagnose__tree__.test_update
    • icap_profile param: name type: str
    • system_geoip-override param: name type: str
    • vpn.ipsec_phase1 param: name type: str
    • vpn.ipsec_phase2 param: name type: str
    • wireless-controller.hotspot20_anqp-network-auth-type param: name type: str
    • execute__tree__.ping-options_data-size
    • webfilter_ips-urlfilter-cache-setting
    • firewall.ipmacbinding_setting
    • diagnose__tree___autoupdate
    • diagnose__tree__.ipv6_gre-tunnel
    • log.fortianalyzer2_filter
    • diagnose__tree__.netlink_device
    • application_rule-settings param: id type: int
    • execute__tree__.system.custom-language_import
    • diagnose__tree__.ips_share
    • log.syslogd4_filter
    • execute__tree__.mrouter.clear_sparse-mode-bsr
    • execute__tree__.set.system.session.filter_list
    • execute__tree__.restore.script_scp
    • system_proxy-arp param: id type: int
    • webfilter_ftgd-local-rating param: url type: str
    • execute__tree__.extender.upload-fortiextender-image_ftp
    • diagnose__tree___switch-controller
    • execute__tree__.switch-controller.virtual-port-pool_show
    • diagnose__tree__.ips.global_rule
    • ips_custom param: tag type: str
    • vpn_ocvpn
    • execute__tree__.switch-controller.get-sync-status_group
    • execute__tree__.ping6-options_interface
    • execute__tree__.switch-controller_restart-acd
    • switch-controller_switch-interface-tag param: name type: str
    • router_policy6 param: seq_num type: int
    • execute__tree__.restore.other-objects_ftp
    • execute__tree__.system.fortisandbox_test-connectivity
    • switch-controller.qos_ip-dscp-map param: name type: str
    • execute__tree__.upload.config_usb
    • diagnose__tree__.netlink_qlen
    • execute__tree__.backup.config_flash
    • log_eventfilter
    • firewall_internet-service-custom param: name type: str
    • diagnose__tree__.ips_packet
    • execute__tree__.restore.av_ftp
    • diagnose__tree__.ip.router_imi
    • router_auth-path param: name type: str
    • diagnose__tree__.ip.router_bgp
    • diagnose__tree___radiusd
    • system_external-resource param: name type: str
    • execute__tree__.log_backup
    • execute__tree__.set.system.session.filter_sport
    • execute__tree__.ping6-options_reset
    • diagnose__tree__.ip.router_rip
    • diagnose__tree__.vpn_ssl
    • execute__tree__.restore.ipsuserdefsig_ftp
    • execute__tree__.set.system.session.filter.clear_expire
    • system_ips-urlfilter-dns6 param: address6 type: str
    • execute__tree__.extender_restart-fortiextender-daemon
    • diagnose__tree___geoip
    • execute__tree__.vpn.certificate.remote.import_tftp
    • execute__tree__.restore.config_dhcp
    • report_style param: name type: str
    • wireless-controller_wtp param: wtp_id type: str
    • execute__tree__.log_upload-progress
    • execute__tree__.switch-controller.get-physical-conn_standard
    • diagnose__tree__.ips_session
    • execute__tree___shutdown
    • system_ipip-tunnel param: name type: str
    • system.dhcp6_server param: id type: int
    • execute__tree__.restore.script_lastlog
    • execute__tree__.webcache.delete_status
    • execute__tree__.revision.delete_config
    • execute__tree__.switch-controller.get-sync-status_name
    • firewall_multicast-policy param: id type: int
    • execute__tree__.vpn.certificate.local.generate_default-ssl-ca-untrusted
    • system_modem
    • router_rip
    • execute__tree__.vpn.sslvpn_rlist
    • diagnose__tree__.ips_ssl
    • diagnose__tree___fortiguard
    • execute__tree__.set.system.session.filter.negate_dst
    • execute__tree__.vpn.sslvpn_list
    • system_password-policy
    • diagnose__tree___settings
    • switch-controller_virtual-port-pool param: name type: str
    • wireless-controller_setting
    • router_static6 param: seq_num type: int
    • wireless-controller.hotspot20_anqp-ip-address-type param: name type: str
    • firewall_vipgrp param: name type: str
    • switch-controller_switch-profile param: name type: str
    • execute__tree___formatlogdisk
    • system_switch-interface param: name type: str
    • router_isis
    • firewall_policy param: policyid type: int
    • log.syslogd_override-setting
    • execute__tree__.set.system.session.filter_src
    • system_lte-modem
    • execute__tree__.ping6-options_pattern
    • execute__tree___reboot
    • webfilter_content param: id type: int
    • firewall_vipgrp6 param: name type: str
    • execute__tree__.switch-controller.virtual-port-pool_show-by-pool
    • diagnose__tree__.netlink_aggregate
    • execute__tree___telnet
    • execute__tree__.modem_dial
    • firewall.schedule_onetime param: name type: str
    • antivirus_profile param: name type: str
    • log.fortianalyzer_setting
    • execute__tree__.restore.other-objects_tftp
    • execute__tree__.backup.full-config_tftp
    • firewall_ippool6 param: name type: str
    • execute__tree__.ping-options_interface
    • execute__tree__.backup.config-with-forticlient-info_tftp
    • system_central-management
    • execute__tree__.cfg_save
    • system.replacemsg_http param: msg_type type: str
    • execute__tree__.ping6-options_repeat-count
    • diagnose__tree__.ips.debug_disable
    • diagnose__tree__.ips_memory
    • diagnose__tree__.ips.debug_enable
    • system_zone param: name type: str
    • system_vdom-dns
    • execute__tree__.fortiguard-log_domain
    • execute__tree__.batch_start
    • firewall_multicast-address param: name type: str
    • wireless-controller_wtp-profile param: name type: str
    • execute__tree__.vpn.sslvpn_rdel-all-tunnel
    • execute__tree__.log.filter_reset
    • vpn.ssl_settings
    • router_ospf
    • switch-controller.qos_queue-policy param: name type: str
    • execute__tree__.set.system.session.filter.negate_vd
    • execute__tree__.log_detail
    • execute__tree__.restore.config_usb
    • execute__tree__.auto-script_start
    • execute__tree___ping6
    • execute__tree___update-ips
    • execute__tree__.vpn.sslvpn_del-web
    • diagnose__tree__.netlink_redundant
    • diagnose__tree__.vpn_tunnel
    • ftp-proxy_explicit
    • execute__tree__.router.clear.bgp_dampening
    • user_device-group param: name type: str
    • execute__tree__.backup.disk.alllogs_ftp
    • execute__tree__.report_run
    • execute__tree__.set.system.session.filter_vd
    • execute__tree__.extender_push-fortiextender-image
    • vpn.certificate_crl param: name type: str
    • execute__tree__.switch-controller.virtual-port-pool_return
    • execute__tree__.cli_status-msg-only
    • user_local param: name type: str
    • execute__tree__.set.system.session.filter_dport
    • webfilter_profile param: name type: str
    • switch-controller_storm-control
    • execute__tree__.log.filter_ha-member
    • firewall_ssl-ssh-profile param: name type: str
    • execute__tree__.dhcp6_lease-clear
    • execute__tree__.central-mgmt_unregister-device
    • execute__tree__.mrouter.clear_statistics
    • execute__tree__.switch-controller.get-sync-status_all
    • execute__tree__.cfg_reload
    • log.disk_setting
    • dlp_filepattern param: id type: int
    • execute__tree__.ping-options_view-settings
    • firewall_ippool param: name type: str
    • web-proxy_url-match param: name type: str
    • execute__tree__.restore.secondary-image_tftp
    • dlp_fp-sensitivity param: name type: str
    • execute__tree__.fortitoken.import_tftp
    • system_interface param: name type: str
    • diagnose__tree___log
    • execute__tree__.cli_check-template-status
    • system_virtual-wire-pair param: name type: str
    • execute__tree___factoryreset
    • diagnose__tree__.ips.av_cache
    • system.replacemsg_webproxy param: msg_type type: str
    • execute__tree__.restore.ips_ftp
    • diagnose__tree___debug
    • execute__tree__.ping-options_validate-reply
    • execute__tree__.ping-options_timeout
    • user_password-policy param: name type: str
    • switch-controller.qos_qos-policy param: name type: str
    • execute__tree__.extender_dial
    • diagnose__tree__.ips.debug_status
    • wireless-controller_inter-controller
    • execute__tree__.set.system.session.filter.negate_dport
    • diagnose__tree__.vpn_ocvpn
    • execute__tree__.switch-controller.stage-tiered-swtp-image_sn
    • execute__tree__.log_delete
    • log.syslogd4_setting
    • execute__tree__.backup.config_ftp
    • execute__tree__.switch-controller_factory-reset
    • switch-controller_switch-group param: name type: str
    • execute__tree__.log.filter_max-checklines
    • user_fsso param: name type: str
    • diagnose__tree__.ips_dissector
    • firewall_vipgrp64 param: name type: str
    • execute__tree__.restore.config.management-station_script
    • user_quarantine
    • system_ips-urlfilter-dns param: address type: str
    • execute__tree__.restore.image_usb
    • system_fm
    • execute__tree__.firewall.ssh.generate_local-ca
    • system_global
    • wireless-controller.hotspot20_anqp-nai-realm param: name type: str
    • diagnose__tree___extender
    • execute__tree__.auto-script_result
    • execute__tree__.switch-controller_loop-guard-reset
    • system_physical-switch param: name type: str
    • execute__tree__.restore.script_ftp
    • execute__tree__.ping-options_pattern
    • execute__tree__.backup.ipsuserdefsig_tftp
    • execute__tree__.switch-controller_clear-802-1X-interface
    • execute__tree__.log_delete-all
    • log.fortianalyzer3_setting
    • execute__tree__.nsx.group_import
    • firewall_vip param: name type: str
    • system_virtual-switch param: name type: str
    • execute__tree___traceroute
    • diagnose__tree__.ip.router_bfd
    • diagnose__tree__.snmp_ip
    • execute__tree__.router.clear.bgp_ipv6
    • execute__tree__.wireless-controller.hs20-icon.upload-icon_tftp
    • execute__tree__.set.system.session.filter.clear_all
    • wanopt_auth-group param: name type: str
    • wanopt_webcache
    • system.snmp_user param: name type: str
    • firewall_ip-translation param: transid type: int
    • system_settings
    • log.fortianalyzer2_setting
    • execute__tree__.batch_lastlog
    • wireless-controller_vap param: name type: str
    • execute__tree__.router.clear.bfd_session
    • execute__tree__.webfilter_quota-reset
    • diagnose__tree__.ips.config_disable
    • diagnose__tree__.netlink_dstmac
    • wanopt_cache-service
    • execute__tree__.upload.config_tftp
    • execute__tree__.usb-device_disconnect
    • switch-controller_switch-log
    • execute__tree__.vpn.certificate.ca.import_bundle
    • firewall_internet-service-group param: name type: str
    • system.replacemsg_mail param: msg_type type: str
    • execute__tree__.set.system.session.filter.negate_policy
    • system_replacemsg-image param: name type: str
    • execute__tree__.set.system.session.filter.clear_src
    • diagnose__tree__.ips_dac
    • diagnose__tree___sys
    • diagnose__tree___npu
    • execute__tree__.router.clear.bgp_external
    • execute__tree__.upload.image_ftp
    • antivirus_quarantine
    • diagnose__tree___security-rating
    • execute__tree__.fortitoken-mobile_provision
    • vpn.certificate_ca param: name type: str
    • endpoint-control_forticlient-registration-sync param: peer_name type: str
    • system_sdn-connector param: name type: str
    • vpn.ssl.web_user-group-bookmark param: name type: str
    • endpoint-control_settings
    • log.null-device_filter
    • dlp_settings
    • execute__tree__.fortiguard-log_agreement
    • wireless-controller_utm-profile param: name type: str
    • execute__tree__.vpn.certificate.ca.import_auto
    • router_aspath-list param: name type: str
    • firewall.schedule_group param: name type: str
    • execute__tree__.modem_trigger
    • diagnose__tree__.netlink_backlog
    • system_dscp-based-priority param: id type: int
    • icap_server param: name type: str
    • vpn.ipsec_phase1-interface param: name type: str
    • authentication_scheme param: name type: str
    • execute__tree__.fsso_refresh
    • execute__tree__.clear.system.arp_table
    • diagnose__tree__.ip_route
    • log.fortianalyzer3_filter
    • system_email-server
    • diagnose__tree__.test_authserver
    • wireless-controller_ap-status param: id type: int
    • application_list param: name type: str
    • execute__tree__.switch-controller.stage-tiered-swtp-image_switch-group
    • execute__tree__.restore.src-vis_ftp
    • diagnose__tree__.ip_framed-ip
    • diagnose__tree___wadbd
    • vpn.ssl.web_user-bookmark param: name type: str
    • execute__tree__.log_flush-cache-all
    • execute__tree__.set.system.session.filter.negate_src
    • execute__tree___ssh
    • firewall.shaper_traffic-shaper param: name type: str
    • system_management-tunnel
    • system_csf
    • execute__tree__.fortiguard-log_certificate-activation
    • execute__tree__.auto-script.backup_tftp
    • execute__tree__.log_roll
    • firewall.shaper_per-ip-shaper param: name type: str
    • execute__tree__.backup.disk.ipsarchives_tftp
    • execute__tree__.usb-disk_rename
    • execute__tree__.disk_scan
    • execute__tree__.report-config_reset
    • dnsfilter_profile param: name type: str
    • execute__tree__.set.system.session.filter_dst
    • execute__tree__.backup.disk.log_usb
    • user_device-access-list param: name type: str
    • system_ha-monitor
    • execute__tree__.fortitoken-mobile_poll
    • execute__tree__.restore.secondary-image_ftp
    • wireless-controller.hotspot20_anqp-venue-name param: name type: str
    • system.snmp_sysinfo
    • diagnose__tree__.netlink_brctl
    • execute__tree__.traceroute-options_view-settings
    • execute__tree__.restore.av_tftp
    • diagnose__tree___fortitoken
    • application_custom param: tag type: str
    • execute__tree__.wireless-controller_reset-wtp
    • system_api-user param: name type: str
    • ips_rule param: name type: str
    • spamfilter_fortishield
    • system_npu
    • execute__tree__.switch-controller.restart-swtp-delayed_sn
    • system_netflow
    • execute__tree__.set.system.session.filter_duration
    • vpn.ipsec_forticlient param: realm type: str
    • system_automation-trigger param: name type: str
    • firewall_policy64 param: policyid type: int
    • wireless-controller.hotspot20_h2qp-osu-provider param: name type: str
    • application_name param: name type: str
    • diagnose__tree__.ip_gre-tunnel
    • execute__tree__.restore.ipsuserdefsig_tftp
    • firewall.service_custom param: name type: str
    • spamfilter_iptrust param: id type: int
    • system_mobile-tunnel param: name type: str
    • firewall_ttl-policy param: id type: int
    • execute__tree__.central-mgmt_set-mgmt-id
    • system.replacemsg_utm param: msg_type type: str
    • execute__tree__.log.filter_view-lines
    • vpn_pptp
    • execute__tree__.traceroute-options_device
    • diagnose__tree__.ip_address
    • wireless-controller.hotspot20_hs-profile param: name type: str
    • log.webtrends_setting
    • execute__tree__.switch-controller_stage-swtp-image
    • firewall_local-in-policy param: policyid type: int
    • execute__tree__.vpn.sslvpn_rdel-all
    • execute__tree__.restore.image_management-station
    • diagnose__tree__.netlink_interface
    • execute__tree___upd-vd-license
    • switch-controller.qos_dot1p-map param: name type: str
    • firewall_multicast-policy6 param: id type: int
    • execute__tree__.switch-controller.upload-swtp-image_tftp
    • execute__tree__.restore.src-vis_tftp
    • execute__tree__.switch-controller.virtual-port-pool_show-by-property
    • diagnose__tree___firewall
    • wanopt_content-delivery-network-rule param: name type: str
    • execute__tree__.log.filter_category
    • execute__tree__.switch-controller.virtual-port-pool_show-by-tag
    • system_dns-database param: name type: str
    • diagnose__tree__.ip_arp
    • execute__tree__.log.filter_show-utm-ref
    • waf_main-class param: id type: int
    • execute__tree__.switch-controller.restart-swtp_sn
    • system.replacemsg_nac-quar param: msg_type type: str
    • system_vdom-radius-server param: name type: str
    • system_vdom param: name type: str
    • execute__tree__.ping-options_ttl
    • execute__tree__.traceroute-options_queries
    • execute__tree__.auto-script_status
    • user_tacacs+ param: name type: str
    • wanopt_peer param: peer_host_id type: str
    • log.syslogd3_setting
    • execute__tree__.extender_hangup
    • diagnose__tree___web-ui
    • report_dataset param: name type: str
    • execute__tree__.fortitoken-mobile_renew
    • webfilter_ftgd-local-cat param: desc type: str
    • router_multicast6
    • vpn.certificate_remote param: name type: str
    • execute__tree__.backup.config-with-forticlient-info_ftp
    • execute__tree__.vpn.ipsec.tunnel_up
    • diagnose__tree__.ip.router_ospf
    • execute__tree___send-fds-statistics
    • diagnose__tree__.vpn_pptp
    • system_fips-cc
    • execute__tree__.restore.image_flash
    • execute__tree__.log.filter_device
    • system_ha
    • log.syslogd3_filter
    • diagnose__tree___internet-service
    • user_radius param: name type: str
    • execute__tree__.log.fortiguard_test-connectivity
    • firewall_DoS-policy6 param: policyid type: int
    • execute__tree___date
    • execute__tree__.restore.ips_tftp
    • execute__tree__.dhcp_lease-list
    • system_tos-based-priority param: id type: int
    • execute__tree__.api-user_generate-key
    • diagnose__tree__.ipv6_address
    • vpn.certificate_local param: name type: str
    • system_accprofile param: name type: str
    • execute__tree___erase-disk
    • wireless-controller_global
    • log.syslogd_filter
    • execute__tree__.mrouter.clear_sparse-routes
    • execute__tree__.switch-controller.virtual-port-pool_request
    • execute__tree__.ping-options_repeat-count
    • dlp_sensor param: name type: str
    • execute__tree__.fortiguard-log_update
    • log.syslogd2_filter
    • wireless-controller_ble-profile param: name type: str
    • system_password-policy-guest-admin
    • diagnose__tree__.ipv6.router_ospf
    • execute__tree__.vpn.certificate.local.generate_cmp
    • execute__tree__.switch-controller_delete-swtp-image
    • user_pop3 param: name type: str
    • execute__tree__.fortitoken_sync
    • execute__tree__.backup.disk.ipsarchives_ftp
    • execute__tree__.ha_disconnect
    • execute__tree__.switch-controller.restart-swtp_switch-group
    • execute__tree___update-av
    • switch-controller_system
    • execute__tree__.ha_manage
    • voip_profile param: name type: str
    • vpn.ipsec_manualkey-interface param: name type: str
    • execute__tree__.auto-script_stopall
    • diagnose__tree__.ips_filter
    • execute__tree__.batch_status
    • system_vdom-netflow
    • execute__tree__.set.system.session.filter.clear_duration
    • firewall.ipmacbinding_table param: seq_num type: int
    • execute__tree__.usb-device_list
    • system_automation-destination param: name type: str
    • dlp_fp-doc-source param: name type: str
    • execute__tree__.router.clear.bgp_as
    • firewall_ldb-monitor param: name type: str
    • firewall.ssh_host-key param: name type: str
    • system_vdom-link param: name type: str
    • system_admin param: name type: str
    • execute__tree__.vpn.sslvpn_guirlist
    • router_ospf6
    • user_device param: alias type: str
    • log.fortiguard_setting
    • execute__tree__.switch-controller_list-swtp-image
    • system.snmp_community param: id type: int
    • execute__tree__.log.fortianalyzer_test-connectivity
    • execute__tree__.set.system.session.filter.clear_policy
    • ips_settings
    • log.syslogd_override-filter
    • diagnose__tree__.ipv6_multicast
    • system_vdom-exception param: id type: int
    • system_wccp param: service_id type: str
    • system_automation-stitch param: name type: str
    • execute__tree__.log.filter_field
    • firewall_profile-protocol-options param: name type: str
    • report_theme param: name type: str
    • execute__tree__.backup.config-with-forticlient-info_usb-mode
    • diagnose__tree__.ipv6_sit-tunnel
    • firewall.ssh_local-key param: name type: str
    • firewall_vip64 param: name type: str
    • web-proxy_wisp param: name type: str
    • spamfilter_options
    • execute__tree__.forticlient_list
    • endpoint-control_forticlient-ems param: name type: str
    • system_dns-server param: name type: str
    • system.replacemsg_alertmail param: msg_type type: str
    • log.fortiguard_override-filter
    • endpoint-control_client param: id type: int
    • router_access-list6 param: name type: str
    • system_fortiguard
    • web-proxy_global
    • diagnose__tree__.ip.router_pim-dm
    • diagnose__tree__.test_guest
    • wanopt_profile param: name type: str
    • execute__tree__.switch-controller_poe-reset
    • wireless-controller.hotspot20_anqp-3gpp-cellular param: name type: str
    • execute__tree__.auto-script.backup_ftp
    • system.replacemsg_ec param: msg_type type: str
    • switch-controller_vlan param: name type: str
    • system_vxlan param: name type: str
    • webfilter_search-engine param: name type: str
    • system_ipv6-tunnel param: name type: str
    • certificate_local param: name type: str
    • diagnose__tree__.test_analytics-report
    • execute__tree__.ping6-options_tos
    • execute__tree__.backup.full-config_usb-mode
    • execute__tree___update-src-vis
    • execute__tree__.backup.disk.alllogs_usb
    • execute__tree___enter
    • user_fsso-polling param: id type: int
    • system.dhcp_server param: id type: int
    • report_chart param: name type: str
    • vpn.certificate_setting
    • router_bfd6
    • execute__tree__.restore.vmlicense_tftp
    • system.replacemsg_nntp param: msg_type type: str
    • execute__tree__.backup.full-config_ftp
    • execute__tree__.router.clear.bgp_all
    • firewall_proxy-policy param: policyid type: int
    • diagnose__tree__.snmp_trap
    • system_dns
    • user_peergrp param: name type: str
    • execute__tree__.upload.image_usb
    • execute__tree__.router.clear.bgp_ip
    • execute__tree__.set.system.session.filter.clear_vd
    • execute__tree__.ping-options_source
    • vpn.ipsec_concentrator param: name type: str
    • execute__tree__.fortitoken_activate
    • ips_decoder param: name type: str
    • dnsfilter_domain-filter param: id type: int
    • execute__tree__.auto-script_stop
    • wireless-controller_vap-group param: name type: str
    • execute__tree__.forticlient_info
    • diagnose__tree__.ip.router_pim-sm
    • system_affinity-interrupt param: id type: int
    • firewall_shaping-profile param: profile_name type: str
    • firewall_interface-policy6 param: policyid type: int
    • execute__tree__.switch-controller.stage-tiered-swtp-image_all
    • execute__tree__.revision.list_image
    • execute__tree__.vpn.certificate.local.generate_ec
    • vpn.ipsec_manualkey param: name type: str
    • execute__tree__.upload.config_ftp
    • switch-controller_global
    • execute__tree___dsscc
    • router_setting
    • diagnose__tree___sniffer
    • system.replacemsg_admin param: msg_type type: str
    • firewall.schedule_recurring param: name type: str
    • execute__tree__.webcache.delete_wildcard
    • system_sit-tunnel param: name type: str
    • system_arp-table param: id type: int
    • switch-controller_lldp-settings
    • webfilter_content-header param: id type: int
    • system_auto-install
    • execute__tree__.replace-device_fortiswitch
    • user_domain-controller param: name type: str
    • router_multicast
    • firewall_ssl-server param: name type: str
    • execute__tree__.ping6-options_adaptive-ping
    • system.replacemsg_traffic-quota param: msg_type type: str
    • system_fortimanager
    • execute__tree__.restore.config_ftp
    • system_mac-address-table param: mac type: str
    • log.fortianalyzer_filter
    • system_network-visibility
    • diagnose__tree__.ips_anomaly6
    • diagnose__tree__.ips_test
    • execute__tree__.router.clear.ospf_process
    • execute__tree__.backup.ipsuserdefsig_ftp
    • execute__tree__.ha_set-priority
    • execute__tree__.ping-options_interval
    • firewall_interface-policy param: policyid type: int
    • execute__tree__.vpn.certificate.local.export_tftp
    • system.replacemsg_fortiguard-wf param: msg_type type: str
    • execute__tree___time
    • wireless-controller_bonjour-profile param: name type: str
    • execute__tree__.wireless-controller.hs20-icon.backup-icon_ftp
    • webfilter_urlfilter param: id type: int
    • execute__tree__.revision.delete_image
    • execute__tree__.backup.memory.log_tftp
    • execute__tree__.switch-controller_bpdu-guard-reset
    • execute__tree__.ping6-options_timeout
    • diagnose__tree___report
    • system_probe-response
    • execute__tree__.nsx.group_list
    • wireless-controller.hotspot20_h2qp-operator-name param: name type: str
    • diagnose__tree___user
    • switch-controller_sflow
    • execute__tree__.vpn.ipsec.tunnel_down
    • execute__tree__.backup.config_usb-mode
    • webfilter_fortiguard
    • wireless-controller.hotspot20_anqp-roaming-consortium param: name type: str
    • diagnose__tree__.ips.config_enable
    • firewall_DoS-policy param: policyid type: int
    • firewall_proxy-addrgrp param: name type: str
    • firewall_addrgrp param: name type: str
    • firewall_policy6 param: policyid type: int
    • router_ripng
    • firewall_vip6 param: name type: str
    • execute__tree__.restore.config_tftp
    • web-proxy_forward-server param: name type: str
    • system.replacemsg_spam param: msg_type type: str
    • certificate_ca param: name type: str
    • execute__tree__.mrouter.clear_dense-routes
    • execute__tree___tracert6
    • firewall.ssh_local-ca param: name type: str
    • execute__tree__.switch-controller.upload-swtp-image_ftp
    • diagnose__tree___forticlient
    • spamfilter_dnsbl param: id type: int
    • execute__tree__.disk_list
    • execute__tree__.ping6-options_data-size
    • execute__tree__.switch-controller.restart-swtp_all
    • execute__tree__.backup.full-config_usb
    • execute__tree__.fortiguard-message_info
    • waf_profile param: name type: str
    • firewall.wildcard-fqdn_group param: name type: str
    • switch-controller_managed-switch param: switch_id type: str
    • execute__tree__.extender_reset-fortiextender
    • user_group param: name type: str
    • diagnose__tree___hardware
    • execute__tree__.dhcp_lease-clear
    • user_krb-keytab param: name type: str
    • diagnose__tree__.ipv6_neighbor-cache
    • execute__tree__.log_upload
    • execute__tree__.ping6-options_validate-reply
    • execute__tree__.switch-controller.get-sync-status_switch-id
    • diagnose__tree__.ips_signature
    • execute__tree__.vpn.certificate.remote.export_tftp
    • application_group param: name type: str
    • system.replacemsg_ftp param: msg_type type: str
    • execute__tree__.vpn.certificate.crl.import_auto
    • diagnose__tree__.ips_anomaly
    • log_threat-weight
    • extender-controller_extender param: id type: str
    • execute__tree__.set.system.session.filter_proto
    • wireless-controller.hotspot20_h2qp-conn-capability param: name type: str
    • router_prefix-list param: name type: str
    • system_gre-tunnel param: name type: str
  • params - the parameter for each selector, see definition in above list.type: dict

Notes

Note

  • Different selector may have different parameters, users are expected to look up them for a specific selector.
  • For some selectors, the objects are global, no params are allowed to appear.
  • If params is empty a non-unique object, the whole object list is returned.
  • This module has support for all configuration API, excluding any monitor API.
  • The result of API request is stored in results as a list.

Examples

- hosts: fortigateslab
  connection: httpapi
  collections:
    - fortinet.fortios
  vars:
    ansible_httpapi_use_ssl: yes
    ansible_httpapi_validate_certs: no
    ansible_httpapi_port: 443
    vdom: "root"
  tasks:
  - name: get all
    fortios_configuration_fact:
      vdom: ""
      access_token: ""
      selector: log_custom-field

  - name: get single
    fortios_configuration_fact:
      vdom: ""
      access_token: ""
      selector: log_custom-field
      #optionally list or single get
      params:
        id: "3"

  - name: fetch one firewall address
    fortios_configuration_fact:
      selector: firewall_address
      params:
        name: "login.microsoft.com"

  - name: fetch all firewall addresses
    fortios_configuration_fact:
      selector: firewall_address

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: GET
  • name - Name of the table used to fulfill the request returned: always type: str sample: firmware
  • path - Path of the table used to fulfill the request returned: always type: str sample: system
  • results - Object list retrieved from device. returned: always type: list
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3
  • ansible_facts - The list of fact subsets collected from the device returned: always type: dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@fshen01)

Hint

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