Try SpotterCollect the current configurations of the modules and convert then into playbooks.
| "added in version" 2.1.0 of fortinet.fortios"
Authors: Jie Xue (@JieX19), Link Zheng (@chillancezen), Hongbin Lu (@fgtdev-hblu), Frank Shen (@fshen01)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6Collect the current configurations of a module on a running device and convert the returned facts into a playbook that users can apply directly.
More than one playbook will be generated if there are many selectors provided.
- name: Will generate the playbooks for each selector/module.
fortinet.fortios.fortios_export_config_playbook:
selectors:
- selector: firewall_address
params:
name: "gmail.com"
- selector: system.snmp_user
params:
name: "snmp_user_test"
output_path: "./"
vdom:
default: root
description:
- 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.
required: false
type: str
params:
description:
- the parameter for each selector, see definition in above list.
required: false
type: dict
filters:
description:
- A list of expressions to filter the returned results.
- The items of the list are combined as LOGICAL AND with operator ampersand.
- One item itself could be concatenated with a comma as LOGICAL OR.
elements: str
required: false
type: list
sorters:
description:
- A list of expressions to sort the returned results.
- The items of the list are in ascending order with operator ampersand.
- One item itself could be in decending order with a comma inside.
elements: str
required: false
type: list
selector:
choices:
- system_vdom
- system_global
- system_accprofile
- system_vdom-link
- system_switch-interface
- system_object-tagging
- system_interface
- system_password-policy
- system_password-policy-guest-admin
- system_sms-server
- system_custom-language
- system_admin
- system_api-user
- system_sso-admin
- system_sso-forticloud-admin
- system_sso-fortigate-cloud-admin
- system_settings
- system_sit-tunnel
- system_fsso-polling
- system_ha
- system_ha-monitor
- system_storage
- system_dedicated-mgmt
- system_arp-table
- system_ipv6-neighbor-cache
- system_dns
- system_ddns
- system_sflow
- system_vdom-sflow
- system_netflow
- system_vdom-netflow
- system_vdom-dns
- system_replacemsg-image
- system_replacemsg-group
- system.snmp_sysinfo
- system.snmp_mib-view
- system.snmp_community
- system.snmp_user
- system.autoupdate_schedule
- system.autoupdate_tunneling
- system_session-ttl
- system.dhcp_server
- system.dhcp6_server
- system_alias
- system_auto-script
- system_management-tunnel
- system_central-management
- system_zone
- system_sdn-proxy
- system_sdn-connector
- system_ipv6-tunnel
- system_external-resource
- system_ips-urlfilter-dns
- system_ips-urlfilter-dns6
- system_network-visibility
- system_sdwan
- system_evpn
- system_gre-tunnel
- system_ipsec-aggregate
- system_ipip-tunnel
- system_mobile-tunnel
- system_pppoe-interface
- system_vxlan
- system_geneve
- system_virtual-wire-pair
- system_dns-database
- system_dns-server
- system_resource-limits
- system_vdom-property
- system_speed-test-server
- system.lldp_network-policy
- system_pcp-server
- system_speed-test-schedule
- system_speed-test-setting
- system_standalone-cluster
- system_fortiguard
- system_ips
- system_email-server
- system_alarm
- system_mac-address-table
- system_session-helper
- system_proxy-arp
- system_fips-cc
- system_tos-based-priority
- system_dscp-based-priority
- system_probe-response
- system_link-monitor
- system_auto-install
- system_console
- system_ntp
- system_ptp
- system_wccp
- system_dns64
- system_vdom-radius-server
- system_ftm-push
- system_geoip-override
- system_fortisandbox
- system_fortindr
- system_affinity-interrupt
- system_affinity-packet-redistribution
- system_vdom-exception
- system_csf
- system_automation-trigger
- system_automation-action
- system_automation-destination
- system_automation-stitch
- system_nd-proxy
- system_saml
- system_federated-upgrade
- system_device-upgrade
- system_vne-tunnel
- system_ike
- system_acme
- system_ipam
- system_fabric-vpn
- wireless-controller_inter-controller
- wireless-controller_global
- wireless-controller.hotspot20_anqp-venue-name
- wireless-controller.hotspot20_anqp-venue-url
- wireless-controller.hotspot20_anqp-network-auth-type
- wireless-controller.hotspot20_anqp-roaming-consortium
- wireless-controller.hotspot20_anqp-nai-realm
- wireless-controller.hotspot20_anqp-3gpp-cellular
- wireless-controller.hotspot20_anqp-ip-address-type
- wireless-controller.hotspot20_h2qp-operator-name
- wireless-controller.hotspot20_h2qp-wan-metric
- wireless-controller.hotspot20_h2qp-conn-capability
- wireless-controller.hotspot20_icon
- wireless-controller.hotspot20_h2qp-osu-provider
- wireless-controller.hotspot20_qos-map
- wireless-controller.hotspot20_h2qp-advice-of-charge
- wireless-controller.hotspot20_h2qp-osu-provider-nai
- wireless-controller.hotspot20_h2qp-terms-and-conditions
- wireless-controller.hotspot20_hs-profile
- wireless-controller_vap
- wireless-controller_timers
- wireless-controller_setting
- wireless-controller_log
- wireless-controller_apcfg-profile
- wireless-controller_bonjour-profile
- wireless-controller_arrp-profile
- wireless-controller_region
- wireless-controller_vap-group
- wireless-controller_wids-profile
- wireless-controller_ble-profile
- wireless-controller_syslog-profile
- wireless-controller_wtp-profile
- wireless-controller_wtp
- wireless-controller_wtp-group
- wireless-controller_qos-profile
- wireless-controller_wag-profile
- wireless-controller_utm-profile
- wireless-controller_snmp
- wireless-controller_mpsk-profile
- wireless-controller_nac-profile
- wireless-controller_ssid-policy
- wireless-controller_access-control-list
- wireless-controller_ap-status
- switch-controller_traffic-policy
- switch-controller_fortilink-settings
- switch-controller_switch-interface-tag
- switch-controller_802-1X-settings
- switch-controller.security-policy_802-1X
- switch-controller.security-policy_local-access
- switch-controller_location
- switch-controller_lldp-settings
- switch-controller_lldp-profile
- switch-controller.qos_dot1p-map
- switch-controller.qos_ip-dscp-map
- switch-controller.qos_queue-policy
- switch-controller.qos_qos-policy
- switch-controller_storm-control-policy
- switch-controller.auto-config_policy
- switch-controller.auto-config_default
- switch-controller.auto-config_custom
- switch-controller.initial-config_template
- switch-controller.initial-config_vlans
- switch-controller_switch-profile
- switch-controller_custom-command
- switch-controller_virtual-port-pool
- switch-controller.ptp_profile
- switch-controller.ptp_interface-policy
- switch-controller_vlan-policy
- switch-controller.acl_ingress
- switch-controller.acl_group
- switch-controller_dynamic-port-policy
- switch-controller_managed-switch
- switch-controller_switch-group
- switch-controller_stp-settings
- switch-controller_stp-instance
- switch-controller_storm-control
- switch-controller_global
- switch-controller_system
- switch-controller_switch-log
- switch-controller_igmp-snooping
- switch-controller_sflow
- switch-controller_quarantine
- switch-controller_network-monitor-settings
- switch-controller_flow-tracking
- switch-controller_snmp-sysinfo
- switch-controller_snmp-trap-threshold
- switch-controller_snmp-community
- switch-controller_snmp-user
- switch-controller_traffic-sniffer
- switch-controller_remote-log
- switch-controller_mac-policy
- firewall_address
- firewall_multicast-address
- firewall_address6-template
- firewall_address6
- firewall_multicast-address6
- firewall_addrgrp
- firewall_addrgrp6
- firewall.wildcard-fqdn_custom
- firewall.wildcard-fqdn_group
- firewall_traffic-class
- firewall.service_category
- firewall.service_custom
- firewall.service_group
- firewall_internet-service-name
- firewall_internet-service-group
- firewall_internet-service-extension
- firewall_internet-service-custom
- firewall_internet-service-addition
- firewall_internet-service-append
- firewall_internet-service-custom-group
- firewall_internet-service-definition
- firewall_network-service-dynamic
- firewall.shaper_traffic-shaper
- firewall.shaper_per-ip-shaper
- firewall_proxy-address
- firewall_proxy-addrgrp
- firewall.schedule_onetime
- firewall.schedule_recurring
- firewall.schedule_group
- firewall_ippool
- firewall_ippool6
- firewall_ldb-monitor
- firewall_vip
- firewall_vip6
- firewall_vipgrp
- firewall_vipgrp6
- firewall.ssh_local-key
- firewall.ssh_local-ca
- firewall.ssh_setting
- firewall.ssh_host-key
- firewall_decrypted-traffic-mirror
- firewall_access-proxy-virtual-host
- firewall_access-proxy-ssh-client-cert
- firewall_access-proxy
- firewall_access-proxy6
- firewall.ipmacbinding_setting
- firewall.ipmacbinding_table
- firewall_profile-protocol-options
- firewall_ssl-ssh-profile
- firewall_ssl-server
- firewall_profile-group
- firewall_identity-based-route
- firewall_auth-portal
- firewall_security-policy
- firewall_policy
- firewall_shaping-policy
- firewall_shaping-profile
- firewall_local-in-policy
- firewall_local-in-policy6
- firewall_ttl-policy
- firewall_proxy-policy
- firewall_dnstranslation
- firewall_multicast-policy
- firewall_multicast-policy6
- firewall_interface-policy
- firewall_interface-policy6
- firewall_DoS-policy
- firewall_DoS-policy6
- firewall_sniffer
- firewall_central-snat-map
- firewall.ssl_setting
- firewall_ip-translation
- firewall_ipv6-eh-filter
- firewall_global
- vpn.certificate_ca
- vpn.certificate_remote
- vpn.certificate_local
- vpn.certificate_crl
- vpn.certificate_ocsp-server
- vpn.certificate_setting
- vpn_qkd
- vpn.ssl.web_realm
- vpn.ssl.web_host-check-software
- vpn.ssl.web_portal
- vpn.ssl.web_user-group-bookmark
- vpn.ssl.web_user-bookmark
- vpn.ssl_settings
- vpn.ssl_client
- vpn.ipsec_fec
- vpn.ipsec_phase1
- vpn.ipsec_phase2
- vpn.ipsec_manualkey
- vpn.ipsec_concentrator
- vpn.ipsec_phase1-interface
- vpn.ipsec_phase2-interface
- vpn.ipsec_manualkey-interface
- vpn.ipsec_forticlient
- vpn_kmip-server
- vpn_pptp
- vpn_l2tp
- certificate_ca
- certificate_remote
- certificate_local
- certificate_crl
- webfilter_ftgd-local-cat
- webfilter_content
- webfilter_content-header
- webfilter_urlfilter
- webfilter_ips-urlfilter-setting
- webfilter_ips-urlfilter-setting6
- webfilter_ips-urlfilter-cache-setting
- webfilter_profile
- webfilter_fortiguard
- webfilter_override
- webfilter_ftgd-local-rating
- webfilter_search-engine
- ips_sensor
- ips_custom
- ips_global
- ips_settings
- sctp-filter_profile
- diameter-filter_profile
- web-proxy_profile
- web-proxy_global
- web-proxy_explicit
- web-proxy_forward-server
- web-proxy_forward-server-group
- web-proxy_debug-url
- web-proxy_wisp
- web-proxy_fast-fallback
- web-proxy_url-match
- wanopt_webcache
- wanopt_settings
- wanopt_peer
- wanopt_auth-group
- wanopt_profile
- wanopt_content-delivery-network-rule
- wanopt_cache-service
- wanopt_remote-storage
- ftp-proxy_explicit
- application_custom
- application_list
- application_group
- dlp_data-type
- dlp_dictionary
- dlp_exact-data-match
- dlp_sensor
- dlp_filepattern
- dlp_sensitivity
- dlp_fp-doc-source
- dlp_profile
- dlp_settings
- videofilter_youtube-key
- videofilter_keyword
- videofilter_profile
- emailfilter_bword
- emailfilter_block-allow-list
- emailfilter_mheader
- emailfilter_dnsbl
- emailfilter_iptrust
- emailfilter_profile
- emailfilter_fortishield
- emailfilter_options
- log_threat-weight
- log_custom-field
- log.syslogd_setting
- log.syslogd_override-setting
- log.syslogd_filter
- log.syslogd_override-filter
- log.syslogd2_setting
- log.syslogd2_override-setting
- log.syslogd2_filter
- log.syslogd2_override-filter
- log.syslogd3_setting
- log.syslogd3_override-setting
- log.syslogd3_filter
- log.syslogd3_override-filter
- log.syslogd4_setting
- log.syslogd4_override-setting
- log.syslogd4_filter
- log.syslogd4_override-filter
- log.webtrends_setting
- log.webtrends_filter
- log.memory_global-setting
- log.memory_setting
- log.memory_filter
- log.disk_setting
- log.disk_filter
- log_eventfilter
- log.fortiguard_setting
- log.fortiguard_override-setting
- log.fortiguard_filter
- log.fortiguard_override-filter
- log.tacacs+accounting_setting
- log.tacacs+accounting_filter
- log.tacacs+accounting2_setting
- log.tacacs+accounting2_filter
- log.tacacs+accounting3_setting
- log.tacacs+accounting3_filter
- log.null-device_setting
- log.null-device_filter
- log_setting
- log_gui-display
- log.fortianalyzer_setting
- log.fortianalyzer_override-setting
- log.fortianalyzer_filter
- log.fortianalyzer_override-filter
- log.fortianalyzer2_setting
- log.fortianalyzer2_override-setting
- log.fortianalyzer2_filter
- log.fortianalyzer2_override-filter
- log.fortianalyzer3_setting
- log.fortianalyzer3_override-setting
- log.fortianalyzer3_filter
- log.fortianalyzer3_override-filter
- log.fortianalyzer-cloud_setting
- log.fortianalyzer-cloud_override-setting
- log.fortianalyzer-cloud_filter
- log.fortianalyzer-cloud_override-filter
- icap_server
- icap_server-group
- icap_profile
- user_peer
- user_peergrp
- user_certificate
- user_radius
- user_tacacs+
- user_exchange
- user_ldap
- user_krb-keytab
- user_domain-controller
- user_pop3
- user_saml
- user_external-identity-provider
- user_fsso
- user_adgrp
- user_fsso-polling
- user_fortitoken
- user_password-policy
- user_local
- user_setting
- user_quarantine
- user_group
- user_security-exempt-list
- user_nac-policy
- voip_profile
- dnsfilter_domain-filter
- dnsfilter_profile
- nsxt_setting
- nsxt_service-chain
- antivirus_settings
- antivirus_quarantine
- antivirus_exempt-list
- antivirus_profile
- ssh-filter_profile
- file-filter_profile
- virtual-patch_profile
- report_layout
- report_setting
- waf_main-class
- waf_sub-class
- waf_signature
- waf_profile
- casb_saas-application
- casb_user-activity
- casb_profile
- authentication_scheme
- authentication_rule
- authentication_setting
- extension-controller_dataplan
- extension-controller_extender-profile
- extension-controller_extender
- extension-controller_fortigate-profile
- extension-controller_fortigate
- endpoint-control_fctems
- endpoint-control_settings
- endpoint-control_fctems-override
- alertemail_setting
- router_access-list
- router_access-list6
- router_aspath-list
- router_prefix-list
- router_prefix-list6
- router_key-chain
- router_community-list
- router_extcommunity-list
- router_route-map
- router_rip
- router_ripng
- router_static
- router_policy
- router_policy6
- router_static6
- router_ospf
- router_ospf6
- router_bgp
- router_isis
- router_multicast-flow
- router_multicast
- router_multicast6
- router_auth-path
- router_setting
- router_bfd
- router_bfd6
- automation_setting
- dpdk_global
- dpdk_cpus
- system_isf-queue-profile
- system_npu
- system_np6
- system_gi-gk
- system_modem
- system.3g-modem_custom
- system_lte-modem
- firewall_gtp
- firewall_pfcp
- firewall_acl
- firewall_acl6
- gtp_apn
- gtp_apngrp
- gtp_message-filter-v0v1
- gtp_message-filter-v2
- gtp_rat-timeout-profile
- gtp_ie-allow-list
- gtp_tunnel-limit
- gtp_apn-shaper
- pfcp_message-filter
- monitoring_np6-ipsec-engine
- monitoring_npu-hpe
- system_npu-vlink
- system_physical-switch
- system_virtual-switch
- system_stp
- system_smc-ntp
- videofilter_youtube-channel-filter
- switch-controller.ptp_settings
- switch-controller.ptp_policy
- vpn_ocvpn
- system.replacemsg_mail
- system.replacemsg_http
- system.replacemsg_webproxy
- system.replacemsg_ftp
- system.replacemsg_fortiguard-wf
- system.replacemsg_spam
- system.replacemsg_alertmail
- system.replacemsg_admin
- system.replacemsg_auth
- system.replacemsg_sslvpn
- system.replacemsg_nac-quar
- system.replacemsg_traffic-quota
- system.replacemsg_utm
- system.replacemsg_icap
- system.replacemsg_automation
- system_status
- system.performance_status
- system.performance_top
- system.performance.firewall_packet-distribution
- system.performance.firewall_statistics
- system_session
- system_session6
- system_cmdb
- system_fortiguard-service
- system_fortianalyzer-connectivity
- system.checksum_status
- system_mgmt-csum
- system_ha-nonsync-csum
- system_fortiguard-log-service
- system_central-mgmt
- system.info.admin_status
- system.info.admin_ssh
- system_geoip-country
- system_cluster-sync
- system_arp
- system_startup-error-log
- system.source-ip_status
- system.auto-update_status
- system.auto-update_versions
- system.session-info_list
- system.session-info_expectation
- system.session-info_full-stat
- system.session-info_statistics
- system.session-info_ttl
- system.session-helper-info_list
- system.ip-conflict_status
- wireless-controller_scan
- wireless-controller_wlchanlistlic
- wireless-controller_status
- wireless-controller_wtp-status
- wireless-controller_client-info
- wireless-controller_vap-status
- wireless-controller_rf-analysis
- wireless-controller_spectral-info
- ipsec_tunnel
- firewall_city
- firewall_region
- firewall_country
- firewall_internet-service
- firewall_internet-service-reputation
- firewall_internet-service-sld
- firewall_internet-service-ipbl-vendor
- firewall_internet-service-ipbl-reason
- firewall_internet-service-owner
- firewall_internet-service-list
- firewall_internet-service-botnet
- firewall_vendor-mac
- firewall_vendor-mac-summary
- firewall.shaper_traffic
- firewall.shaper_per-ip
- firewall.iprope_list
- firewall.iprope.appctrl_list
- firewall.iprope.appctrl_status
- firewall_proute
- firewall_proute6
- vpn.ssl_monitor
- vpn.ipsec.stats_crypto
- vpn.ipsec.stats_tunnel
- vpn.ipsec.tunnel_details
- vpn.ipsec.tunnel_summary
- vpn.ipsec.tunnel_name
- vpn.ike_gateway
- vpn.status_l2tp
- vpn.status_pptp
- vpn.status.ssl_list
- vpn.status.ssl_hw-acceleration-status
- webfilter_categories
- webfilter_ftgd-statistics
- webfilter_status
- webfilter_override-usr
- ips_view-map
- ips_decoder
- ips_rule
- ips_rule-settings
- ips_session
- application_name
- application_rule-settings
- report.sql_status
- extender-controller_dataplan
- extender-controller_extender-profile
- extender-controller_extender
- router_info
- router_info6
- hardware_status
- hardware_cpu
- hardware_memory
- hardware_nic
- hardware.npu.np6_port-list
- hardware.npu.np6_dce
- hardware.npu.np6_session-stats
- hardware.npu.np6_sse-stats
- hardware.npu.np6_ipsec-stats
- hardware.npu.np6_synproxy-stats
- mgmt-data_status
- extender_sys-info
- extender_extender-info
- extender_session-info
- extender_datachannel-info
- extender_fexwan
- extender_modem-status
- extender_lte-carrier-list
- extender_lte-carrier-by-mcc-mnc
- wireless-controller_address
- wireless-controller_addrgrp
- system_fortiai
- system_fortimanager
- system_fm
- system_nat64
- firewall_vip46
- firewall_vip64
- firewall_vipgrp46
- firewall_vipgrp64
- firewall_policy64
- firewall_policy46
- system.autoupdate_push-update
- switch-controller_nac-settings
- switch-controller_port-policy
- switch-controller_nac-device
- emailfilter_bwl
- antivirus_heuristic
- credential-store_domain-controller
- report_dataset
- report_chart
- report_style
- report_theme
- gtp_ie-white-list
- system.replacemsg_nntp
- system.replacemsg_device-detection-portal
- switch-controller_poe
- cifs_domain-controller
- cifs_profile
- system.replacemsg_mms
- system.replacemsg_mm1
- system.replacemsg_mm3
- system.replacemsg_mm4
- system.replacemsg_mm7
- system_virtual-wan-link
- system_mem-mgr
- firewall_carrier-endpoint-bwl
- firewall_mms-profile
- firewall.consolidated_policy
- firewall_policy6
- antivirus_notification
- antivirus_mms-checksum
- switch-controller_vlan
- switch-controller.security-policy_captive-portal
- user_device
- user_device-group
- endpoint-control_client
- system.replacemsg_ec
- dlp_fp-sensitivity
- spamfilter_bword
- spamfilter_bwl
- spamfilter_mheader
- spamfilter_dnsbl
- spamfilter_iptrust
- spamfilter_profile
- spamfilter_fortishield
- spamfilter_options
- user_device-category
- user_device-access-list
- switch-controller_mac-sync-settings
- endpoint-control_forticlient-ems
- endpoint-control_profile
- endpoint-control_forticlient-registration-sync
- endpoint-control_registered-forticlient
description:
- Module name that used to fetch the current configurations and export the playbook.
required: false
type: str
selectors:
description:
- A list of selectors used to fetch the current configurations and export the playbook.
elements: dict
required: false
suboptions:
filters:
description:
- A list of expressions to filter the returned results.
- The items of the list are combined as LOGICAL AND with operator ampersand.
- One item itself could be concatenated with a comma as LOGICAL OR.
elements: str
required: false
type: list
formatters:
description:
- A list of fields to display for returned results.
elements: str
required: false
type: list
params:
description:
- the parameter for each selector, see definition in above list.
required: false
type: dict
selector:
choices:
- system_vdom
- system_global
- system_accprofile
- system_vdom-link
- system_switch-interface
- system_object-tagging
- system_interface
- system_password-policy
- system_password-policy-guest-admin
- system_sms-server
- system_custom-language
- system_admin
- system_api-user
- system_sso-admin
- system_sso-forticloud-admin
- system_sso-fortigate-cloud-admin
- system_settings
- system_sit-tunnel
- system_fsso-polling
- system_ha
- system_ha-monitor
- system_storage
- system_dedicated-mgmt
- system_arp-table
- system_ipv6-neighbor-cache
- system_dns
- system_ddns
- system_sflow
- system_vdom-sflow
- system_netflow
- system_vdom-netflow
- system_vdom-dns
- system_replacemsg-image
- system_replacemsg-group
- system.snmp_sysinfo
- system.snmp_mib-view
- system.snmp_community
- system.snmp_user
- system.autoupdate_schedule
- system.autoupdate_tunneling
- system_session-ttl
- system.dhcp_server
- system.dhcp6_server
- system_alias
- system_auto-script
- system_management-tunnel
- system_central-management
- system_zone
- system_sdn-proxy
- system_sdn-connector
- system_ipv6-tunnel
- system_external-resource
- system_ips-urlfilter-dns
- system_ips-urlfilter-dns6
- system_network-visibility
- system_sdwan
- system_evpn
- system_gre-tunnel
- system_ipsec-aggregate
- system_ipip-tunnel
- system_mobile-tunnel
- system_pppoe-interface
- system_vxlan
- system_geneve
- system_virtual-wire-pair
- system_dns-database
- system_dns-server
- system_resource-limits
- system_vdom-property
- system_speed-test-server
- system.lldp_network-policy
- system_pcp-server
- system_speed-test-schedule
- system_speed-test-setting
- system_standalone-cluster
- system_fortiguard
- system_ips
- system_email-server
- system_alarm
- system_mac-address-table
- system_session-helper
- system_proxy-arp
- system_fips-cc
- system_tos-based-priority
- system_dscp-based-priority
- system_probe-response
- system_link-monitor
- system_auto-install
- system_console
- system_ntp
- system_ptp
- system_wccp
- system_dns64
- system_vdom-radius-server
- system_ftm-push
- system_geoip-override
- system_fortisandbox
- system_fortindr
- system_affinity-interrupt
- system_affinity-packet-redistribution
- system_vdom-exception
- system_csf
- system_automation-trigger
- system_automation-action
- system_automation-destination
- system_automation-stitch
- system_nd-proxy
- system_saml
- system_federated-upgrade
- system_device-upgrade
- system_vne-tunnel
- system_ike
- system_acme
- system_ipam
- system_fabric-vpn
- wireless-controller_inter-controller
- wireless-controller_global
- wireless-controller.hotspot20_anqp-venue-name
- wireless-controller.hotspot20_anqp-venue-url
- wireless-controller.hotspot20_anqp-network-auth-type
- wireless-controller.hotspot20_anqp-roaming-consortium
- wireless-controller.hotspot20_anqp-nai-realm
- wireless-controller.hotspot20_anqp-3gpp-cellular
- wireless-controller.hotspot20_anqp-ip-address-type
- wireless-controller.hotspot20_h2qp-operator-name
- wireless-controller.hotspot20_h2qp-wan-metric
- wireless-controller.hotspot20_h2qp-conn-capability
- wireless-controller.hotspot20_icon
- wireless-controller.hotspot20_h2qp-osu-provider
- wireless-controller.hotspot20_qos-map
- wireless-controller.hotspot20_h2qp-advice-of-charge
- wireless-controller.hotspot20_h2qp-osu-provider-nai
- wireless-controller.hotspot20_h2qp-terms-and-conditions
- wireless-controller.hotspot20_hs-profile
- wireless-controller_vap
- wireless-controller_timers
- wireless-controller_setting
- wireless-controller_log
- wireless-controller_apcfg-profile
- wireless-controller_bonjour-profile
- wireless-controller_arrp-profile
- wireless-controller_region
- wireless-controller_vap-group
- wireless-controller_wids-profile
- wireless-controller_ble-profile
- wireless-controller_syslog-profile
- wireless-controller_wtp-profile
- wireless-controller_wtp
- wireless-controller_wtp-group
- wireless-controller_qos-profile
- wireless-controller_wag-profile
- wireless-controller_utm-profile
- wireless-controller_snmp
- wireless-controller_mpsk-profile
- wireless-controller_nac-profile
- wireless-controller_ssid-policy
- wireless-controller_access-control-list
- wireless-controller_ap-status
- switch-controller_traffic-policy
- switch-controller_fortilink-settings
- switch-controller_switch-interface-tag
- switch-controller_802-1X-settings
- switch-controller.security-policy_802-1X
- switch-controller.security-policy_local-access
- switch-controller_location
- switch-controller_lldp-settings
- switch-controller_lldp-profile
- switch-controller.qos_dot1p-map
- switch-controller.qos_ip-dscp-map
- switch-controller.qos_queue-policy
- switch-controller.qos_qos-policy
- switch-controller_storm-control-policy
- switch-controller.auto-config_policy
- switch-controller.auto-config_default
- switch-controller.auto-config_custom
- switch-controller.initial-config_template
- switch-controller.initial-config_vlans
- switch-controller_switch-profile
- switch-controller_custom-command
- switch-controller_virtual-port-pool
- switch-controller.ptp_profile
- switch-controller.ptp_interface-policy
- switch-controller_vlan-policy
- switch-controller.acl_ingress
- switch-controller.acl_group
- switch-controller_dynamic-port-policy
- switch-controller_managed-switch
- switch-controller_switch-group
- switch-controller_stp-settings
- switch-controller_stp-instance
- switch-controller_storm-control
- switch-controller_global
- switch-controller_system
- switch-controller_switch-log
- switch-controller_igmp-snooping
- switch-controller_sflow
- switch-controller_quarantine
- switch-controller_network-monitor-settings
- switch-controller_flow-tracking
- switch-controller_snmp-sysinfo
- switch-controller_snmp-trap-threshold
- switch-controller_snmp-community
- switch-controller_snmp-user
- switch-controller_traffic-sniffer
- switch-controller_remote-log
- switch-controller_mac-policy
- firewall_address
- firewall_multicast-address
- firewall_address6-template
- firewall_address6
- firewall_multicast-address6
- firewall_addrgrp
- firewall_addrgrp6
- firewall.wildcard-fqdn_custom
- firewall.wildcard-fqdn_group
- firewall_traffic-class
- firewall.service_category
- firewall.service_custom
- firewall.service_group
- firewall_internet-service-name
- firewall_internet-service-group
- firewall_internet-service-extension
- firewall_internet-service-custom
- firewall_internet-service-addition
- firewall_internet-service-append
- firewall_internet-service-custom-group
- firewall_internet-service-definition
- firewall_network-service-dynamic
- firewall.shaper_traffic-shaper
- firewall.shaper_per-ip-shaper
- firewall_proxy-address
- firewall_proxy-addrgrp
- firewall.schedule_onetime
- firewall.schedule_recurring
- firewall.schedule_group
- firewall_ippool
- firewall_ippool6
- firewall_ldb-monitor
- firewall_vip
- firewall_vip6
- firewall_vipgrp
- firewall_vipgrp6
- firewall.ssh_local-key
- firewall.ssh_local-ca
- firewall.ssh_setting
- firewall.ssh_host-key
- firewall_decrypted-traffic-mirror
- firewall_access-proxy-virtual-host
- firewall_access-proxy-ssh-client-cert
- firewall_access-proxy
- firewall_access-proxy6
- firewall.ipmacbinding_setting
- firewall.ipmacbinding_table
- firewall_profile-protocol-options
- firewall_ssl-ssh-profile
- firewall_ssl-server
- firewall_profile-group
- firewall_identity-based-route
- firewall_auth-portal
- firewall_security-policy
- firewall_policy
- firewall_shaping-policy
- firewall_shaping-profile
- firewall_local-in-policy
- firewall_local-in-policy6
- firewall_ttl-policy
- firewall_proxy-policy
- firewall_dnstranslation
- firewall_multicast-policy
- firewall_multicast-policy6
- firewall_interface-policy
- firewall_interface-policy6
- firewall_DoS-policy
- firewall_DoS-policy6
- firewall_sniffer
- firewall_central-snat-map
- firewall.ssl_setting
- firewall_ip-translation
- firewall_ipv6-eh-filter
- firewall_global
- vpn.certificate_ca
- vpn.certificate_remote
- vpn.certificate_local
- vpn.certificate_crl
- vpn.certificate_ocsp-server
- vpn.certificate_setting
- vpn_qkd
- vpn.ssl.web_realm
- vpn.ssl.web_host-check-software
- vpn.ssl.web_portal
- vpn.ssl.web_user-group-bookmark
- vpn.ssl.web_user-bookmark
- vpn.ssl_settings
- vpn.ssl_client
- vpn.ipsec_fec
- vpn.ipsec_phase1
- vpn.ipsec_phase2
- vpn.ipsec_manualkey
- vpn.ipsec_concentrator
- vpn.ipsec_phase1-interface
- vpn.ipsec_phase2-interface
- vpn.ipsec_manualkey-interface
- vpn.ipsec_forticlient
- vpn_kmip-server
- vpn_pptp
- vpn_l2tp
- certificate_ca
- certificate_remote
- certificate_local
- certificate_crl
- webfilter_ftgd-local-cat
- webfilter_content
- webfilter_content-header
- webfilter_urlfilter
- webfilter_ips-urlfilter-setting
- webfilter_ips-urlfilter-setting6
- webfilter_ips-urlfilter-cache-setting
- webfilter_profile
- webfilter_fortiguard
- webfilter_override
- webfilter_ftgd-local-rating
- webfilter_search-engine
- ips_sensor
- ips_custom
- ips_global
- ips_settings
- sctp-filter_profile
- diameter-filter_profile
- web-proxy_profile
- web-proxy_global
- web-proxy_explicit
- web-proxy_forward-server
- web-proxy_forward-server-group
- web-proxy_debug-url
- web-proxy_wisp
- web-proxy_fast-fallback
- web-proxy_url-match
- wanopt_webcache
- wanopt_settings
- wanopt_peer
- wanopt_auth-group
- wanopt_profile
- wanopt_content-delivery-network-rule
- wanopt_cache-service
- wanopt_remote-storage
- ftp-proxy_explicit
- application_custom
- application_list
- application_group
- dlp_data-type
- dlp_dictionary
- dlp_exact-data-match
- dlp_sensor
- dlp_filepattern
- dlp_sensitivity
- dlp_fp-doc-source
- dlp_profile
- dlp_settings
- videofilter_youtube-key
- videofilter_keyword
- videofilter_profile
- emailfilter_bword
- emailfilter_block-allow-list
- emailfilter_mheader
- emailfilter_dnsbl
- emailfilter_iptrust
- emailfilter_profile
- emailfilter_fortishield
- emailfilter_options
- log_threat-weight
- log_custom-field
- log.syslogd_setting
- log.syslogd_override-setting
- log.syslogd_filter
- log.syslogd_override-filter
- log.syslogd2_setting
- log.syslogd2_override-setting
- log.syslogd2_filter
- log.syslogd2_override-filter
- log.syslogd3_setting
- log.syslogd3_override-setting
- log.syslogd3_filter
- log.syslogd3_override-filter
- log.syslogd4_setting
- log.syslogd4_override-setting
- log.syslogd4_filter
- log.syslogd4_override-filter
- log.webtrends_setting
- log.webtrends_filter
- log.memory_global-setting
- log.memory_setting
- log.memory_filter
- log.disk_setting
- log.disk_filter
- log_eventfilter
- log.fortiguard_setting
- log.fortiguard_override-setting
- log.fortiguard_filter
- log.fortiguard_override-filter
- log.tacacs+accounting_setting
- log.tacacs+accounting_filter
- log.tacacs+accounting2_setting
- log.tacacs+accounting2_filter
- log.tacacs+accounting3_setting
- log.tacacs+accounting3_filter
- log.null-device_setting
- log.null-device_filter
- log_setting
- log_gui-display
- log.fortianalyzer_setting
- log.fortianalyzer_override-setting
- log.fortianalyzer_filter
- log.fortianalyzer_override-filter
- log.fortianalyzer2_setting
- log.fortianalyzer2_override-setting
- log.fortianalyzer2_filter
- log.fortianalyzer2_override-filter
- log.fortianalyzer3_setting
- log.fortianalyzer3_override-setting
- log.fortianalyzer3_filter
- log.fortianalyzer3_override-filter
- log.fortianalyzer-cloud_setting
- log.fortianalyzer-cloud_override-setting
- log.fortianalyzer-cloud_filter
- log.fortianalyzer-cloud_override-filter
- icap_server
- icap_server-group
- icap_profile
- user_peer
- user_peergrp
- user_certificate
- user_radius
- user_tacacs+
- user_exchange
- user_ldap
- user_krb-keytab
- user_domain-controller
- user_pop3
- user_saml
- user_external-identity-provider
- user_fsso
- user_adgrp
- user_fsso-polling
- user_fortitoken
- user_password-policy
- user_local
- user_setting
- user_quarantine
- user_group
- user_security-exempt-list
- user_nac-policy
- voip_profile
- dnsfilter_domain-filter
- dnsfilter_profile
- nsxt_setting
- nsxt_service-chain
- antivirus_settings
- antivirus_quarantine
- antivirus_exempt-list
- antivirus_profile
- ssh-filter_profile
- file-filter_profile
- virtual-patch_profile
- report_layout
- report_setting
- waf_main-class
- waf_sub-class
- waf_signature
- waf_profile
- casb_saas-application
- casb_user-activity
- casb_profile
- authentication_scheme
- authentication_rule
- authentication_setting
- extension-controller_dataplan
- extension-controller_extender-profile
- extension-controller_extender
- extension-controller_fortigate-profile
- extension-controller_fortigate
- endpoint-control_fctems
- endpoint-control_settings
- endpoint-control_fctems-override
- alertemail_setting
- router_access-list
- router_access-list6
- router_aspath-list
- router_prefix-list
- router_prefix-list6
- router_key-chain
- router_community-list
- router_extcommunity-list
- router_route-map
- router_rip
- router_ripng
- router_static
- router_policy
- router_policy6
- router_static6
- router_ospf
- router_ospf6
- router_bgp
- router_isis
- router_multicast-flow
- router_multicast
- router_multicast6
- router_auth-path
- router_setting
- router_bfd
- router_bfd6
- automation_setting
- dpdk_global
- dpdk_cpus
- system_isf-queue-profile
- system_npu
- system_np6
- system_gi-gk
- system_modem
- system.3g-modem_custom
- system_lte-modem
- firewall_gtp
- firewall_pfcp
- firewall_acl
- firewall_acl6
- gtp_apn
- gtp_apngrp
- gtp_message-filter-v0v1
- gtp_message-filter-v2
- gtp_rat-timeout-profile
- gtp_ie-allow-list
- gtp_tunnel-limit
- gtp_apn-shaper
- pfcp_message-filter
- monitoring_np6-ipsec-engine
- monitoring_npu-hpe
- system_npu-vlink
- system_physical-switch
- system_virtual-switch
- system_stp
- system_smc-ntp
- videofilter_youtube-channel-filter
- switch-controller.ptp_settings
- switch-controller.ptp_policy
- vpn_ocvpn
- system.replacemsg_mail
- system.replacemsg_http
- system.replacemsg_webproxy
- system.replacemsg_ftp
- system.replacemsg_fortiguard-wf
- system.replacemsg_spam
- system.replacemsg_alertmail
- system.replacemsg_admin
- system.replacemsg_auth
- system.replacemsg_sslvpn
- system.replacemsg_nac-quar
- system.replacemsg_traffic-quota
- system.replacemsg_utm
- system.replacemsg_icap
- system.replacemsg_automation
- system_status
- system.performance_status
- system.performance_top
- system.performance.firewall_packet-distribution
- system.performance.firewall_statistics
- system_session
- system_session6
- system_cmdb
- system_fortiguard-service
- system_fortianalyzer-connectivity
- system.checksum_status
- system_mgmt-csum
- system_ha-nonsync-csum
- system_fortiguard-log-service
- system_central-mgmt
- system.info.admin_status
- system.info.admin_ssh
- system_geoip-country
- system_cluster-sync
- system_arp
- system_startup-error-log
- system.source-ip_status
- system.auto-update_status
- system.auto-update_versions
- system.session-info_list
- system.session-info_expectation
- system.session-info_full-stat
- system.session-info_statistics
- system.session-info_ttl
- system.session-helper-info_list
- system.ip-conflict_status
- wireless-controller_scan
- wireless-controller_wlchanlistlic
- wireless-controller_status
- wireless-controller_wtp-status
- wireless-controller_client-info
- wireless-controller_vap-status
- wireless-controller_rf-analysis
- wireless-controller_spectral-info
- ipsec_tunnel
- firewall_city
- firewall_region
- firewall_country
- firewall_internet-service
- firewall_internet-service-reputation
- firewall_internet-service-sld
- firewall_internet-service-ipbl-vendor
- firewall_internet-service-ipbl-reason
- firewall_internet-service-owner
- firewall_internet-service-list
- firewall_internet-service-botnet
- firewall_vendor-mac
- firewall_vendor-mac-summary
- firewall.shaper_traffic
- firewall.shaper_per-ip
- firewall.iprope_list
- firewall.iprope.appctrl_list
- firewall.iprope.appctrl_status
- firewall_proute
- firewall_proute6
- vpn.ssl_monitor
- vpn.ipsec.stats_crypto
- vpn.ipsec.stats_tunnel
- vpn.ipsec.tunnel_details
- vpn.ipsec.tunnel_summary
- vpn.ipsec.tunnel_name
- vpn.ike_gateway
- vpn.status_l2tp
- vpn.status_pptp
- vpn.status.ssl_list
- vpn.status.ssl_hw-acceleration-status
- webfilter_categories
- webfilter_ftgd-statistics
- webfilter_status
- webfilter_override-usr
- ips_view-map
- ips_decoder
- ips_rule
- ips_rule-settings
- ips_session
- application_name
- application_rule-settings
- report.sql_status
- extender-controller_dataplan
- extender-controller_extender-profile
- extender-controller_extender
- router_info
- router_info6
- hardware_status
- hardware_cpu
- hardware_memory
- hardware_nic
- hardware.npu.np6_port-list
- hardware.npu.np6_dce
- hardware.npu.np6_session-stats
- hardware.npu.np6_sse-stats
- hardware.npu.np6_ipsec-stats
- hardware.npu.np6_synproxy-stats
- mgmt-data_status
- extender_sys-info
- extender_extender-info
- extender_session-info
- extender_datachannel-info
- extender_fexwan
- extender_modem-status
- extender_lte-carrier-list
- extender_lte-carrier-by-mcc-mnc
- wireless-controller_address
- wireless-controller_addrgrp
- system_fortiai
- system_fortimanager
- system_fm
- system_nat64
- firewall_vip46
- firewall_vip64
- firewall_vipgrp46
- firewall_vipgrp64
- firewall_policy64
- firewall_policy46
- system.autoupdate_push-update
- switch-controller_nac-settings
- switch-controller_port-policy
- switch-controller_nac-device
- emailfilter_bwl
- antivirus_heuristic
- credential-store_domain-controller
- report_dataset
- report_chart
- report_style
- report_theme
- gtp_ie-white-list
- system.replacemsg_nntp
- system.replacemsg_device-detection-portal
- switch-controller_poe
- cifs_domain-controller
- cifs_profile
- system.replacemsg_mms
- system.replacemsg_mm1
- system.replacemsg_mm3
- system.replacemsg_mm4
- system.replacemsg_mm7
- system_virtual-wan-link
- system_mem-mgr
- firewall_carrier-endpoint-bwl
- firewall_mms-profile
- firewall.consolidated_policy
- firewall_policy6
- antivirus_notification
- antivirus_mms-checksum
- switch-controller_vlan
- switch-controller.security-policy_captive-portal
- user_device
- user_device-group
- endpoint-control_client
- system.replacemsg_ec
- dlp_fp-sensitivity
- spamfilter_bword
- spamfilter_bwl
- spamfilter_mheader
- spamfilter_dnsbl
- spamfilter_iptrust
- spamfilter_profile
- spamfilter_fortishield
- spamfilter_options
- user_device-category
- user_device-access-list
- switch-controller_mac-sync-settings
- endpoint-control_forticlient-ems
- endpoint-control_profile
- endpoint-control_forticlient-registration-sync
- endpoint-control_registered-forticlient
description:
- Module name that used to fetch the current configurations and export the playbook.
required: true
type: str
sorters:
description:
- A list of expressions to sort the returned results.
- The items of the list are in ascending order with operator ampersand.
- One item itself could be in decending order with a comma inside.
elements: str
required: false
type: list
type: list
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
formatters:
description:
- A list of fields to display for returned results.
elements: str
required: false
type: list
output_path:
description:
- the path used for saving the playbook.
required: true
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
ansible_facts: description: The list of fact subsets collected from the device returned: always type: dict build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: GET type: str name: description: Name of the table used to fulfill the request returned: always sample: firmware type: str path: description: Path of the table used to fulfill the request returned: always sample: system type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str