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 >= 2.0.0.

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
• enable_log - Enable/Disable logging for task. type: bool required: False default: False
• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
• selector - selector of the retrieved fortimanager facts type: str choices:

• Show full selector list...

  • alertemail_setting
  • antivirus_heuristic
  • antivirus_mms-checksum param: id type: int
  • antivirus_notification param: id type: int
  • antivirus_profile param: name type: str
  • antivirus_quarantine
  • antivirus_settings
  • application_custom param: tag type: str
  • application_group param: name type: str
  • application_list param: name type: str
  • application_name param: name type: str
  • application_rule-settings param: id type: int
  • authentication_rule param: name type: str
  • authentication_scheme param: name type: str
  • authentication_setting
  • certificate_ca param: name type: str
  • certificate_crl param: name type: str
  • certificate_local param: name type: str
  • certificate_remote param: name type: str
  • cifs_domain-controller param: server_name type: str
  • cifs_profile param: name type: str
  • credential-store_domain-controller param: server_name type: str
  • dlp_filepattern param: id type: int
  • dlp_fp-doc-source param: name type: str
  • dlp_fp-sensitivity param: name type: str
  • dlp_sensitivity param: name type: str
  • dlp_sensor param: name type: str
  • dlp_settings
  • dnsfilter_domain-filter param: id type: int
  • dnsfilter_profile param: name type: str
  • emailfilter_bwl param: id type: int
  • emailfilter_bword param: id type: int
  • emailfilter_dnsbl param: id type: int
  • emailfilter_fortishield
  • emailfilter_iptrust param: id type: int
  • emailfilter_mheader param: id type: int
  • emailfilter_options
  • emailfilter_profile param: name type: str
  • endpoint-control_client param: id type: int
  • endpoint-control_fctems param: name type: str
  • endpoint-control_forticlient-ems param: name type: str
  • endpoint-control_forticlient-registration-sync param: peer_name type: str
  • endpoint-control_profile param: profile_name type: str
  • endpoint-control_registered-forticlient param: uid type: str
  • endpoint-control_settings
  • extender-controller_dataplan param: name type: str
  • extender-controller_extender param: id type: str
  • extender_extender-info
  • extender_lte-carrier-by-mcc-mnc
  • extender_lte-carrier-list
  • extender_modem-status
  • extender_sys-info
  • file-filter_profile param: name type: str
  • firewall.consolidated_policy param: policyid type: int
  • firewall.ipmacbinding_setting
  • firewall.ipmacbinding_table param: seq_num type: int
  • firewall.iprope.appctrl_list
  • firewall.iprope.appctrl_status
  • firewall.iprope_list
  • firewall.schedule_group param: name type: str
  • firewall.schedule_onetime param: name type: str
  • firewall.schedule_recurring param: name type: str
  • firewall.service_category param: name type: str
  • firewall.service_custom param: name type: str
  • firewall.service_group param: name type: str
  • firewall.shaper_per-ip
  • firewall.shaper_per-ip-shaper param: name type: str
  • firewall.shaper_traffic
  • firewall.shaper_traffic-shaper param: name type: str
  • firewall.ssh_host-key param: name type: str
  • firewall.ssh_local-ca param: name type: str
  • firewall.ssh_local-key param: name type: str
  • firewall.ssh_setting
  • firewall.ssl_setting
  • firewall.wildcard-fqdn_custom param: name type: str
  • firewall.wildcard-fqdn_group param: name type: str
  • firewall_acl param: policyid type: int
  • firewall_acl6 param: policyid type: int
  • firewall_address param: name type: str
  • firewall_address6 param: name type: str
  • firewall_address6-template param: name type: str
  • firewall_addrgrp param: name type: str
  • firewall_addrgrp6 param: name type: str
  • firewall_auth-portal
  • firewall_carrier-endpoint-bwl param: id type: int
  • firewall_central-snat-map param: policyid type: int
  • firewall_city param: id type: int
  • firewall_country param: id type: int
  • firewall_decrypted-traffic-mirror param: name type: str
  • firewall_dnstranslation param: id type: int
  • firewall_DoS-policy param: policyid type: int
  • firewall_DoS-policy6 param: policyid type: int
  • firewall_gtp param: name type: str
  • firewall_identity-based-route param: name type: str
  • firewall_interface-policy param: policyid type: int
  • firewall_interface-policy6 param: policyid type: int
  • firewall_internet-service param: id type: int
  • firewall_internet-service-addition param: id type: int
  • firewall_internet-service-append
  • firewall_internet-service-botnet param: id type: int
  • firewall_internet-service-custom param: name type: str
  • firewall_internet-service-custom-group param: name type: str
  • firewall_internet-service-definition param: id type: int
  • firewall_internet-service-extension param: id type: int
  • firewall_internet-service-group param: name type: str
  • firewall_internet-service-ipbl-reason param: id type: int
  • firewall_internet-service-ipbl-vendor param: id type: int
  • firewall_internet-service-list param: id type: int
  • firewall_internet-service-name param: name type: str
  • firewall_internet-service-owner param: id type: int
  • firewall_internet-service-reputation param: id type: int
  • firewall_internet-service-sld param: id type: int
  • firewall_ip-translation param: transid type: int
  • firewall_ippool param: name type: str
  • firewall_ippool6 param: name type: str
  • firewall_ipv6-eh-filter
  • firewall_ldb-monitor param: name type: str
  • firewall_local-in-policy param: policyid type: int
  • firewall_local-in-policy6 param: policyid type: int
  • firewall_mms-profile param: name type: str
  • firewall_multicast-address param: name type: str
  • firewall_multicast-address6 param: name type: str
  • firewall_multicast-policy param: id type: int
  • firewall_multicast-policy6 param: id type: int
  • firewall_policy param: policyid type: int
  • firewall_policy46 param: policyid type: int
  • firewall_policy6 param: policyid type: int
  • firewall_policy64 param: policyid type: int
  • firewall_profile-group param: name type: str
  • firewall_profile-protocol-options param: name type: str
  • firewall_proute
  • firewall_proute6
  • firewall_proxy-address param: name type: str
  • firewall_proxy-addrgrp param: name type: str
  • firewall_proxy-policy param: policyid type: int
  • firewall_region param: id type: int
  • firewall_security-policy param: policyid type: int
  • firewall_shaping-policy param: id type: int
  • firewall_shaping-profile param: profile_name type: str
  • firewall_sniffer param: id type: int
  • firewall_ssl-server param: name type: str
  • firewall_ssl-ssh-profile param: name type: str
  • firewall_traffic-class param: class_id type: int
  • firewall_ttl-policy param: id type: int
  • firewall_vendor-mac param: id type: int
  • firewall_vendor-mac-summary
  • firewall_vip param: name type: str
  • firewall_vip46 param: name type: str
  • firewall_vip6 param: name type: str
  • firewall_vip64 param: name type: str
  • firewall_vipgrp param: name type: str
  • firewall_vipgrp46 param: name type: str
  • firewall_vipgrp6 param: name type: str
  • firewall_vipgrp64 param: name type: str
  • ftp-proxy_explicit
  • gtp_apn param: name type: str
  • gtp_apn-shaper param: id type: int
  • gtp_apngrp param: name type: str
  • gtp_ie-white-list param: name type: str
  • gtp_message-filter-v0v1 param: name type: str
  • gtp_message-filter-v2 param: name type: str
  • gtp_tunnel-limit param: name type: str
  • hardware.npu.np6_dce
  • hardware.npu.np6_ipsec-stats
  • hardware.npu.np6_port-list
  • hardware.npu.np6_session-stats
  • hardware.npu.np6_sse-stats
  • hardware.npu.np6_synproxy-stats
  • hardware_cpu
  • hardware_memory
  • hardware_nic
  • hardware_status
  • icap_profile param: name type: str
  • icap_server param: name type: str
  • ips_custom param: tag type: str
  • ips_decoder param: name type: str
  • ips_global
  • ips_rule param: name type: str
  • ips_rule-settings param: id type: int
  • ips_sensor param: name type: str
  • ips_session
  • ips_settings
  • ips_view-map param: id type: int
  • ipsec_tunnel
  • log.disk_filter
  • log.disk_setting
  • log.fortianalyzer-cloud_filter
  • log.fortianalyzer-cloud_override-filter
  • log.fortianalyzer-cloud_override-setting
  • log.fortianalyzer-cloud_setting
  • log.fortianalyzer2_filter
  • log.fortianalyzer2_override-filter
  • log.fortianalyzer2_override-setting
  • log.fortianalyzer2_setting
  • log.fortianalyzer3_filter
  • log.fortianalyzer3_override-filter
  • log.fortianalyzer3_override-setting
  • log.fortianalyzer3_setting
  • log.fortianalyzer_filter
  • log.fortianalyzer_override-filter
  • log.fortianalyzer_override-setting
  • log.fortianalyzer_setting
  • log.fortiguard_filter
  • log.fortiguard_override-filter
  • log.fortiguard_override-setting
  • log.fortiguard_setting
  • log.memory_filter
  • log.memory_global-setting
  • log.memory_setting
  • log.null-device_filter
  • log.null-device_setting
  • log.syslogd2_filter
  • log.syslogd2_override-filter
  • log.syslogd2_override-setting
  • log.syslogd2_setting
  • log.syslogd3_filter
  • log.syslogd3_override-filter
  • log.syslogd3_override-setting
  • log.syslogd3_setting
  • log.syslogd4_filter
  • log.syslogd4_override-filter
  • log.syslogd4_override-setting
  • log.syslogd4_setting
  • log.syslogd_filter
  • log.syslogd_override-filter
  • log.syslogd_override-setting
  • log.syslogd_setting
  • log.webtrends_filter
  • log.webtrends_setting
  • log_custom-field param: id type: str
  • log_eventfilter
  • log_gui-display
  • log_setting
  • log_threat-weight
  • mgmt-data_status
  • monitoring_np6-ipsec-engine
  • report.sql_status
  • report_chart param: name type: str
  • report_dataset param: name type: str
  • report_layout param: name type: str
  • report_setting
  • report_style param: name type: str
  • report_theme param: name type: str
  • router_access-list param: name type: str
  • router_access-list6 param: name type: str
  • router_aspath-list param: name type: str
  • router_auth-path param: name type: str
  • router_bfd
  • router_bfd6
  • router_bgp
  • router_community-list param: name type: str
  • router_info
  • router_info6
  • router_isis
  • router_key-chain param: name type: str
  • router_multicast
  • router_multicast-flow param: name type: str
  • router_multicast6
  • router_ospf
  • router_ospf6
  • router_policy param: seq_num type: int
  • router_policy6 param: seq_num type: int
  • router_prefix-list param: name type: str
  • router_prefix-list6 param: name type: str
  • router_rip
  • router_ripng
  • router_route-map param: name type: str
  • router_setting
  • router_static param: seq_num type: int
  • router_static6 param: seq_num type: int
  • spamfilter_bwl param: id type: int
  • spamfilter_bword param: id type: int
  • spamfilter_dnsbl param: id type: int
  • spamfilter_fortishield
  • spamfilter_iptrust param: id type: int
  • spamfilter_mheader param: id type: int
  • spamfilter_options
  • spamfilter_profile param: name type: str
  • ssh-filter_profile param: name type: str
  • switch-controller.auto-config_custom param: name type: str
  • switch-controller.auto-config_default
  • switch-controller.auto-config_policy param: name type: str
  • switch-controller.initial-config_template param: name type: str
  • switch-controller.initial-config_vlans
  • switch-controller.ptp_policy param: name type: str
  • switch-controller.ptp_settings
  • switch-controller.qos_dot1p-map param: name type: str
  • switch-controller.qos_ip-dscp-map param: name type: str
  • switch-controller.qos_qos-policy param: name type: str
  • switch-controller.qos_queue-policy param: name type: str
  • switch-controller.security-policy_802-1X param: name type: str
  • switch-controller.security-policy_captive-portal param: name type: str
  • switch-controller.security-policy_local-access param: name type: str
  • switch-controller_802-1X-settings
  • switch-controller_custom-command param: command_name type: str
  • switch-controller_flow-tracking
  • switch-controller_global
  • switch-controller_igmp-snooping
  • switch-controller_lldp-profile param: name type: str
  • switch-controller_lldp-settings
  • switch-controller_location param: name type: str
  • switch-controller_mac-policy param: name type: str
  • switch-controller_mac-sync-settings
  • switch-controller_managed-switch param: switch_id type: str
  • switch-controller_nac-device param: id type: int
  • switch-controller_nac-settings param: name type: str
  • switch-controller_network-monitor-settings
  • switch-controller_poe
  • switch-controller_port-policy param: name type: str
  • switch-controller_quarantine
  • switch-controller_remote-log param: name type: str
  • switch-controller_sflow
  • switch-controller_snmp-community param: id type: int
  • switch-controller_snmp-sysinfo
  • switch-controller_snmp-trap-threshold
  • switch-controller_snmp-user param: name type: str
  • switch-controller_storm-control
  • switch-controller_storm-control-policy param: name type: str
  • switch-controller_stp-instance param: id type: str
  • switch-controller_stp-settings
  • switch-controller_switch-group param: name type: str
  • switch-controller_switch-interface-tag param: name type: str
  • switch-controller_switch-log
  • switch-controller_switch-profile param: name type: str
  • switch-controller_system
  • switch-controller_traffic-policy param: name type: str
  • switch-controller_traffic-sniffer
  • switch-controller_virtual-port-pool param: name type: str
  • switch-controller_vlan param: name type: str
  • switch-controller_vlan-policy param: name type: str
  • system.3g-modem_custom param: id type: int
  • system.auto-update_status
  • system.auto-update_versions
  • system.autoupdate_push-update
  • system.autoupdate_schedule
  • system.autoupdate_tunneling
  • system.checksum_status
  • system.dhcp6_server param: id type: int
  • system.dhcp_server param: id type: int
  • system.info.admin_ssh
  • system.info.admin_status
  • system.ip-conflict_status
  • system.lldp_network-policy param: name type: str
  • system.performance.firewall_packet-distribution
  • system.performance.firewall_statistics
  • system.performance_status
  • system.performance_top
  • system.replacemsg_admin param: msg_type type: str
  • system.replacemsg_alertmail param: msg_type type: str
  • system.replacemsg_auth param: msg_type type: str
  • system.replacemsg_device-detection-portal param: msg_type type: str
  • system.replacemsg_ec param: msg_type type: str
  • system.replacemsg_fortiguard-wf param: msg_type type: str
  • system.replacemsg_ftp param: msg_type type: str
  • system.replacemsg_http param: msg_type type: str
  • system.replacemsg_icap param: msg_type type: str
  • system.replacemsg_mail param: msg_type type: str
  • system.replacemsg_mm1 param: msg_type type: str
  • system.replacemsg_mm3 param: msg_type type: str
  • system.replacemsg_mm4 param: msg_type type: str
  • system.replacemsg_mm7 param: msg_type type: str
  • system.replacemsg_mms param: msg_type type: str
  • system.replacemsg_nac-quar param: msg_type type: str
  • system.replacemsg_nntp param: msg_type type: str
  • system.replacemsg_spam param: msg_type type: str
  • system.replacemsg_sslvpn param: msg_type type: str
  • system.replacemsg_traffic-quota param: msg_type type: str
  • system.replacemsg_utm param: msg_type type: str
  • system.replacemsg_webproxy param: msg_type type: str
  • system.session-helper-info_list
  • system.session-info_expectation
  • system.session-info_full-stat
  • system.session-info_list
  • system.session-info_statistics
  • system.session-info_ttl
  • system.snmp_community param: id type: int
  • system.snmp_sysinfo
  • system.snmp_user param: name type: str
  • system.source-ip_status
  • system_accprofile param: name type: str
  • system_admin param: name type: str
  • system_alarm
  • system_alias param: name type: str
  • system_api-user param: name type: str
  • system_arp
  • system_arp-table param: id type: int
  • system_auto-install
  • system_auto-script param: name type: str
  • system_automation-action param: name type: str
  • system_automation-destination param: name type: str
  • system_automation-stitch param: name type: str
  • system_automation-trigger param: name type: str
  • system_central-management
  • system_central-mgmt
  • system_cluster-sync param: sync_id type: int
  • system_cmdb
  • system_console
  • system_csf
  • system_custom-language param: name type: str
  • system_ddns param: ddnsid type: int
  • system_dedicated-mgmt
  • system_dns
  • system_dns-database param: name type: str
  • system_dns-server param: name type: str
  • system_dscp-based-priority param: id type: int
  • system_email-server
  • system_external-resource param: name type: str
  • system_fips-cc
  • system_fm
  • system_fortianalyzer-connectivity
  • system_fortiguard
  • system_fortiguard-log-service
  • system_fortiguard-service
  • system_fortimanager
  • system_fortisandbox
  • system_fsso-polling
  • system_ftm-push
  • system_geneve param: name type: str
  • system_geoip-country param: id type: str
  • system_geoip-override param: name type: str
  • system_gi-gk
  • system_global
  • system_gre-tunnel param: name type: str
  • system_ha
  • system_ha-monitor
  • system_ha-nonsync-csum
  • system_interface param: name type: str
  • system_ipip-tunnel param: name type: str
  • system_ips
  • system_ips-urlfilter-dns param: address type: str
  • system_ips-urlfilter-dns6 param: address6 type: str
  • system_ipsec-aggregate param: name type: str
  • system_ipv6-neighbor-cache param: id type: int
  • system_ipv6-tunnel param: name type: str
  • system_isf-queue-profile param: name type: str
  • system_link-monitor param: name type: str
  • system_lte-modem
  • system_mac-address-table param: mac type: str
  • system_management-tunnel
  • system_mem-mgr
  • system_mgmt-csum
  • system_mobile-tunnel param: name type: str
  • system_modem
  • system_nat64
  • system_nd-proxy
  • system_netflow
  • system_network-visibility
  • system_np6 param: name type: str
  • system_npu
  • system_ntp
  • system_object-tagging param: category type: str
  • system_password-policy
  • system_password-policy-guest-admin
  • system_physical-switch param: name type: str
  • system_pppoe-interface param: name type: str
  • system_probe-response
  • system_proxy-arp param: id type: int
  • system_ptp
  • system_replacemsg-group param: name type: str
  • system_replacemsg-image param: name type: str
  • system_resource-limits
  • system_saml
  • system_sdn-connector param: name type: str
  • system_sdwan
  • system_session
  • system_session-helper param: id type: int
  • system_session-ttl
  • system_session6
  • system_settings
  • system_sflow
  • system_sit-tunnel param: name type: str
  • system_smc-ntp
  • system_sms-server param: name type: str
  • system_speed-test-server param: name type: str
  • system_sso-admin param: name type: str
  • system_standalone-cluster
  • system_startup-error-log
  • system_status
  • system_storage param: name type: str
  • system_stp
  • system_switch-interface param: name type: str
  • system_tos-based-priority param: id type: int
  • system_vdom param: name type: str
  • system_vdom-dns
  • system_vdom-exception param: id type: int
  • system_vdom-link param: name type: str
  • system_vdom-netflow
  • system_vdom-property param: name type: str
  • system_vdom-radius-server param: name type: str
  • system_vdom-sflow
  • system_virtual-switch param: name type: str
  • system_virtual-wan-link
  • system_virtual-wire-pair param: name type: str
  • system_vne-tunnel
  • system_vxlan param: name type: str
  • system_wccp param: service_id type: str
  • system_zone param: name type: str
  • user_adgrp param: name type: str
  • user_device param: alias type: str
  • user_device-access-list param: name type: str
  • user_device-category param: name type: str
  • user_device-group param: name type: str
  • user_domain-controller param: name type: str
  • user_exchange param: name type: str
  • user_fortitoken param: serial_number type: str
  • user_fsso param: name type: str
  • user_fsso-polling param: id type: int
  • user_group param: name type: str
  • user_krb-keytab param: name type: str
  • user_ldap param: name type: str
  • user_local param: name type: str
  • user_nac-policy param: name type: str
  • user_password-policy param: name type: str
  • user_peer param: name type: str
  • user_peergrp param: name type: str
  • user_pop3 param: name type: str
  • user_quarantine
  • user_radius param: name type: str
  • user_saml param: name type: str
  • user_security-exempt-list param: name type: str
  • user_setting
  • user_tacacs+ param: name type: str
  • voip_profile param: name type: str
  • vpn.certificate_ca param: name type: str
  • vpn.certificate_crl param: name type: str
  • vpn.certificate_local param: name type: str
  • vpn.certificate_ocsp-server param: name type: str
  • vpn.certificate_remote param: name type: str
  • vpn.certificate_setting
  • vpn.ike_gateway
  • vpn.ipsec.stats_crypto
  • vpn.ipsec.stats_tunnel
  • vpn.ipsec.tunnel_details
  • vpn.ipsec.tunnel_name
  • vpn.ipsec.tunnel_summary
  • vpn.ipsec_concentrator param: name type: str
  • vpn.ipsec_forticlient param: realm type: str
  • vpn.ipsec_manualkey param: name type: str
  • vpn.ipsec_manualkey-interface param: name type: str
  • vpn.ipsec_phase1 param: name type: str
  • vpn.ipsec_phase1-interface param: name type: str
  • vpn.ipsec_phase2 param: name type: str
  • vpn.ipsec_phase2-interface param: name type: str
  • vpn.ssl.web_host-check-software param: name type: str
  • vpn.ssl.web_portal param: name type: str
  • vpn.ssl.web_realm param: url_path type: str
  • vpn.ssl.web_user-bookmark param: name type: str
  • vpn.ssl.web_user-group-bookmark param: name type: str
  • vpn.ssl_monitor
  • vpn.ssl_settings
  • vpn.status.ssl_hw-acceleration-status
  • vpn.status.ssl_list
  • vpn.status_l2tp
  • vpn.status_pptp
  • vpn_l2tp
  • vpn_ocvpn
  • vpn_pptp
  • waf_main-class param: id type: int
  • waf_profile param: name type: str
  • waf_signature param: id type: int
  • waf_sub-class param: id type: int
  • wanopt_auth-group param: name type: str
  • wanopt_cache-service
  • wanopt_content-delivery-network-rule param: name type: str
  • wanopt_peer param: peer_host_id type: str
  • wanopt_profile param: name type: str
  • wanopt_remote-storage
  • wanopt_settings
  • wanopt_webcache
  • web-proxy_debug-url param: name type: str
  • web-proxy_explicit
  • web-proxy_forward-server param: name type: str
  • web-proxy_forward-server-group param: name type: str
  • web-proxy_global
  • web-proxy_profile param: name type: str
  • web-proxy_url-match param: name type: str
  • web-proxy_wisp param: name type: str
  • webfilter_categories
  • webfilter_content param: id type: int
  • webfilter_content-header param: id type: int
  • webfilter_fortiguard
  • webfilter_ftgd-local-cat param: desc type: str
  • webfilter_ftgd-local-rating param: url type: str
  • webfilter_ftgd-statistics
  • webfilter_ips-urlfilter-cache-setting
  • webfilter_ips-urlfilter-setting
  • webfilter_ips-urlfilter-setting6
  • webfilter_override param: id type: int
  • webfilter_override-usr
  • webfilter_profile param: name type: str
  • webfilter_search-engine param: name type: str
  • webfilter_status
  • webfilter_urlfilter param: id type: int
  • wireless-controller.hotspot20_anqp-3gpp-cellular param: name type: str
  • wireless-controller.hotspot20_anqp-ip-address-type param: name type: str
  • wireless-controller.hotspot20_anqp-nai-realm param: name type: str
  • wireless-controller.hotspot20_anqp-network-auth-type param: name type: str
  • wireless-controller.hotspot20_anqp-roaming-consortium param: name type: str
  • wireless-controller.hotspot20_anqp-venue-name param: name type: str
  • wireless-controller.hotspot20_h2qp-conn-capability param: name type: str
  • wireless-controller.hotspot20_h2qp-operator-name param: name type: str
  • wireless-controller.hotspot20_h2qp-osu-provider param: name type: str
  • wireless-controller.hotspot20_h2qp-wan-metric param: name type: str
  • wireless-controller.hotspot20_hs-profile param: name type: str
  • wireless-controller.hotspot20_icon param: name type: str
  • wireless-controller.hotspot20_qos-map param: name type: str
  • wireless-controller_access-control-list param: name type: str
  • wireless-controller_address param: id type: str
  • wireless-controller_addrgrp param: id type: str
  • wireless-controller_ap-status param: id type: int
  • wireless-controller_apcfg-profile param: name type: str
  • wireless-controller_arrp-profile param: name type: str
  • wireless-controller_ble-profile param: name type: str
  • wireless-controller_bonjour-profile param: name type: str
  • wireless-controller_client-info
  • wireless-controller_global
  • wireless-controller_inter-controller
  • wireless-controller_log
  • wireless-controller_mpsk-profile param: name type: str
  • wireless-controller_qos-profile param: name type: str
  • wireless-controller_region param: name type: str
  • wireless-controller_rf-analysis
  • wireless-controller_scan
  • wireless-controller_setting
  • wireless-controller_snmp
  • wireless-controller_spectral-info
  • wireless-controller_status
  • wireless-controller_timers
  • wireless-controller_utm-profile param: name type: str
  • wireless-controller_vap param: name type: str
  • wireless-controller_vap-group param: name type: str
  • wireless-controller_vap-status
  • wireless-controller_wag-profile param: name type: str
  • wireless-controller_wids-profile param: name type: str
  • wireless-controller_wlchanlistlic
  • wireless-controller_wtp param: wtp_id type: str
  • wireless-controller_wtp-group param: name type: str
  • wireless-controller_wtp-profile param: name type: str
  • wireless-controller_wtp-status
• 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.