fortios_export_config_playbook – Convert the returned facts into a playbook.

New in version 2.11.

Synopsis

• Collect the current configurations of a module on a running device and converts the returned facts into a playbook that users can apply directly. More than one playbook will be generated if there are many selectors provided.

Requirements

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

• install galaxy collection fortinet.fortios >= 2.1.3.

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
• filters - A list of expressions to filter the returned results. type: list required: False more...
  Filter item must be in the following format: [key][operator][pattern], operators could be found in the table:

  Operator	Case sensitive	Description
  ==	Yes	Pattern must be identical to the value.
  =*	No	Pattern must be identical to the value.
  !=	Yes	Pattern does not match the value.
  !*	No	Pattern does not match the value.
  =@	No	Pattern found within value.
  !@	No	Pattern not found within value.
  <=	n/a	Value must be less than or equal to pattern.
  <	n/a	Value must be less than pattern.
  >=	n/a	Value must be greater than or equal to pattern.
  >	n/a	Value must be greater than pattern.

• sorters - A list of expressions to sort the returned results. type: list required: False more...
  Sorter item must be a [key] followed by a ,asc or ,dsc order derective.
  examples: name,asc to sort the result by name in ascending order; vlanid,asc to sort the result by vlanid in descending order.
• formatters - A list of fields to display for returned results. type: list required: False
• selector - selector that used to collect the current configurations of the module and convert to a playbook. type: str choices:

• Show full selector list...

  • alertemail_setting
  • antivirus_heuristic
  • antivirus_mms-checksum param: id type: int required: True
  • antivirus_notification param: id type: int required: True
  • antivirus_profile param: name type: str required: True
  • antivirus_quarantine
  • antivirus_settings
  • application_custom param: tag type: str required: True
  • application_group param: name type: str required: True
  • application_list param: name type: str required: True
  • application_name param: name type: str required: True
  • application_rule-settings param: id type: int required: True
  • authentication_rule param: name type: str required: True
  • authentication_scheme param: name type: str required: True
  • authentication_setting
  • automation_setting
  • certificate_ca param: name type: str required: True
  • certificate_crl param: name type: str required: True
  • certificate_local param: name type: str required: True
  • certificate_remote param: name type: str required: True
  • cifs_domain-controller param: server_name type: str required: True
  • cifs_profile param: name type: str required: True
  • credential-store_domain-controller param: server_name type: str required: True
  • dlp_data-type param: name type: str required: True
  • dlp_dictionary param: name type: str required: True
  • dlp_filepattern param: id type: int required: True
  • dlp_fp-doc-source param: name type: str required: True
  • dlp_fp-sensitivity param: name type: str required: True
  • dlp_profile param: name type: str required: True
  • dlp_sensitivity param: name type: str required: True
  • dlp_sensor param: name type: str required: True
  • dlp_settings
  • dnsfilter_domain-filter param: id type: int required: True
  • dnsfilter_profile param: name type: str required: True
  • dpdk_cpus
  • dpdk_global
  • emailfilter_block-allow-list param: id type: int required: True
  • emailfilter_bwl param: id type: int required: True
  • emailfilter_bword param: id type: int required: True
  • emailfilter_dnsbl param: id type: int required: True
  • emailfilter_fortishield
  • emailfilter_iptrust param: id type: int required: True
  • emailfilter_mheader param: id type: int required: True
  • emailfilter_options
  • emailfilter_profile param: name type: str required: True
  • endpoint-control_client param: id type: int required: True
  • endpoint-control_fctems param: ems_id type: int required: True
  • endpoint-control_forticlient-ems param: name type: str required: True
  • endpoint-control_forticlient-registration-sync param: peer_name type: str required: True
  • endpoint-control_profile param: profile_name type: str required: True
  • endpoint-control_registered-forticlient param: uid type: str required: True
  • endpoint-control_settings
  • extender-controller_dataplan param: name type: str required: True
  • extender-controller_extender param: name type: str required: True
  • extender-controller_extender-profile param: name type: str required: True
  • extender_datachannel-info
  • extender_extender-info
  • extender_fexwan
  • extender_lte-carrier-by-mcc-mnc
  • extender_lte-carrier-list
  • extender_modem-status
  • extender_session-info
  • extender_sys-info
  • extension-controller_dataplan param: name type: str required: True
  • extension-controller_extender param: name type: str required: True
  • extension-controller_extender-profile param: name type: str required: True
  • extension-controller_fortigate param: name type: str required: True
  • extension-controller_fortigate-profile param: name type: str required: True
  • file-filter_profile param: name type: str required: True
  • firewall.consolidated_policy param: policyid type: int required: True
  • firewall.ipmacbinding_setting
  • firewall.ipmacbinding_table param: seq_num type: int required: True
  • firewall.iprope.appctrl_list
  • firewall.iprope.appctrl_status
  • firewall.iprope_list
  • firewall.schedule_group param: name type: str required: True
  • firewall.schedule_onetime param: name type: str required: True
  • firewall.schedule_recurring param: name type: str required: True
  • firewall.service_category param: name type: str required: True
  • firewall.service_custom param: name type: str required: True
  • firewall.service_group param: name type: str required: True
  • firewall.shaper_per-ip
  • firewall.shaper_per-ip-shaper param: name type: str required: True
  • firewall.shaper_traffic
  • firewall.shaper_traffic-shaper param: name type: str required: True
  • firewall.ssh_host-key param: name type: str required: True
  • firewall.ssh_local-ca param: name type: str required: True
  • firewall.ssh_local-key param: name type: str required: True
  • firewall.ssh_setting
  • firewall.ssl_setting
  • firewall.wildcard-fqdn_custom param: name type: str required: True
  • firewall.wildcard-fqdn_group param: name type: str required: True
  • firewall_access-proxy param: name type: str required: True
  • firewall_access-proxy-ssh-client-cert param: name type: str required: True
  • firewall_access-proxy-virtual-host param: name type: str required: True
  • firewall_access-proxy6 param: name type: str required: True
  • firewall_acl param: policyid type: int required: True
  • firewall_acl6 param: policyid type: int required: True
  • firewall_address param: name type: str required: True
  • firewall_address6 param: name type: str required: True
  • firewall_address6-template param: name type: str required: True
  • firewall_addrgrp param: name type: str required: True
  • firewall_addrgrp6 param: name type: str required: True
  • firewall_auth-portal
  • firewall_carrier-endpoint-bwl param: id type: int required: True
  • firewall_central-snat-map param: policyid type: int required: True
  • firewall_city param: id type: int required: True
  • firewall_country param: id type: int required: True
  • firewall_decrypted-traffic-mirror param: name type: str required: True
  • firewall_dnstranslation param: id type: int required: True
  • firewall_DoS-policy param: policyid type: int required: True
  • firewall_DoS-policy6 param: policyid type: int required: True
  • firewall_global
  • firewall_gtp param: name type: str required: True
  • firewall_identity-based-route param: name type: str required: True
  • firewall_interface-policy param: policyid type: int required: True
  • firewall_interface-policy6 param: policyid type: int required: True
  • firewall_internet-service param: id type: int required: True
  • firewall_internet-service-addition param: id type: int required: True
  • firewall_internet-service-append
  • firewall_internet-service-botnet param: id type: int required: True
  • firewall_internet-service-custom param: name type: str required: True
  • firewall_internet-service-custom-group param: name type: str required: True
  • firewall_internet-service-definition param: id type: int required: True
  • firewall_internet-service-extension param: id type: int required: True
  • firewall_internet-service-group param: name type: str required: True
  • firewall_internet-service-ipbl-reason param: id type: int required: True
  • firewall_internet-service-ipbl-vendor param: id type: int required: True
  • firewall_internet-service-list param: id type: int required: True
  • firewall_internet-service-name param: name type: str required: True
  • firewall_internet-service-owner param: id type: int required: True
  • firewall_internet-service-reputation param: id type: int required: True
  • firewall_internet-service-sld param: id type: int required: True
  • firewall_ip-translation param: transid type: int required: True
  • firewall_ippool param: name type: str required: True
  • firewall_ippool6 param: name type: str required: True
  • firewall_ipv6-eh-filter
  • firewall_ldb-monitor param: name type: str required: True
  • firewall_local-in-policy param: policyid type: int required: True
  • firewall_local-in-policy6 param: policyid type: int required: True
  • firewall_mms-profile param: name type: str required: True
  • firewall_multicast-address param: name type: str required: True
  • firewall_multicast-address6 param: name type: str required: True
  • firewall_multicast-policy param: id type: int required: True
  • firewall_multicast-policy6 param: id type: int required: True
  • firewall_network-service-dynamic param: name type: str required: True
  • firewall_pfcp param: name type: str required: True
  • firewall_policy param: policyid type: int required: True
  • firewall_policy46 param: policyid type: int required: True
  • firewall_policy6 param: policyid type: int required: True
  • firewall_policy64 param: policyid type: int required: True
  • firewall_profile-group param: name type: str required: True
  • firewall_profile-protocol-options param: name type: str required: True
  • firewall_proute
  • firewall_proute6
  • firewall_proxy-address param: name type: str required: True
  • firewall_proxy-addrgrp param: name type: str required: True
  • firewall_proxy-policy param: policyid type: int required: True
  • firewall_region param: id type: int required: True
  • firewall_security-policy param: policyid type: int required: True
  • firewall_shaping-policy param: id type: int required: True
  • firewall_shaping-profile param: profile_name type: str required: True
  • firewall_sniffer param: id type: int required: True
  • firewall_ssl-server param: name type: str required: True
  • firewall_ssl-ssh-profile param: name type: str required: True
  • firewall_traffic-class param: class_id type: int required: True
  • firewall_ttl-policy param: id type: int required: True
  • firewall_vendor-mac param: id type: int required: True
  • firewall_vendor-mac-summary
  • firewall_vip param: name type: str required: True
  • firewall_vip46 param: name type: str required: True
  • firewall_vip6 param: name type: str required: True
  • firewall_vip64 param: name type: str required: True
  • firewall_vipgrp param: name type: str required: True
  • firewall_vipgrp46 param: name type: str required: True
  • firewall_vipgrp6 param: name type: str required: True
  • firewall_vipgrp64 param: name type: str required: True
  • ftp-proxy_explicit
  • gtp_apn param: name type: str required: True
  • gtp_apn-shaper param: id type: int required: True
  • gtp_apngrp param: name type: str required: True
  • gtp_ie-allow-list param: name type: str required: True
  • gtp_ie-white-list param: name type: str required: True
  • gtp_message-filter-v0v1 param: name type: str required: True
  • gtp_message-filter-v2 param: name type: str required: True
  • gtp_rat-timeout-profile param: name type: str required: True
  • gtp_tunnel-limit param: name type: str required: True
  • 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 required: True
  • icap_server param: name type: str required: True
  • icap_server-group param: name type: str required: True
  • ips_custom param: tag type: str required: True
  • ips_decoder param: name type: str required: True
  • ips_global
  • ips_rule param: name type: str required: True
  • ips_rule-settings param: id type: int required: True
  • ips_sensor param: name type: str required: True
  • ips_session
  • ips_settings
  • ips_view-map param: id type: int required: True
  • 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.tacacs+accounting2_filter
  • log.tacacs+accounting2_setting
  • log.tacacs+accounting3_filter
  • log.tacacs+accounting3_setting
  • log.tacacs+accounting_filter
  • log.tacacs+accounting_setting
  • log.webtrends_filter
  • log.webtrends_setting
  • log_custom-field param: id type: str required: True
  • log_eventfilter
  • log_gui-display
  • log_setting
  • log_threat-weight
  • mgmt-data_status
  • monitoring_np6-ipsec-engine
  • monitoring_npu-hpe
  • nsxt_service-chain param: id type: int required: True
  • nsxt_setting
  • pfcp_message-filter param: name type: str required: True
  • report.sql_status
  • report_chart param: name type: str required: True
  • report_dataset param: name type: str required: True
  • report_layout param: name type: str required: True
  • report_setting
  • report_style param: name type: str required: True
  • report_theme param: name type: str required: True
  • router_access-list param: name type: str required: True
  • router_access-list6 param: name type: str required: True
  • router_aspath-list param: name type: str required: True
  • router_auth-path param: name type: str required: True
  • router_bfd
  • router_bfd6
  • router_bgp
  • router_community-list param: name type: str required: True
  • router_info
  • router_info6
  • router_isis
  • router_key-chain param: name type: str required: True
  • router_multicast
  • router_multicast-flow param: name type: str required: True
  • router_multicast6
  • router_ospf
  • router_ospf6
  • router_policy param: seq_num type: int required: True
  • router_policy6 param: seq_num type: int required: True
  • router_prefix-list param: name type: str required: True
  • router_prefix-list6 param: name type: str required: True
  • router_rip
  • router_ripng
  • router_route-map param: name type: str required: True
  • router_setting
  • router_static param: seq_num type: int required: True
  • router_static6 param: seq_num type: int required: True
  • sctp-filter_profile param: name type: str required: True
  • spamfilter_bwl param: id type: int required: True
  • spamfilter_bword param: id type: int required: True
  • spamfilter_dnsbl param: id type: int required: True
  • spamfilter_fortishield
  • spamfilter_iptrust param: id type: int required: True
  • spamfilter_mheader param: id type: int required: True
  • spamfilter_options
  • spamfilter_profile param: name type: str required: True
  • ssh-filter_profile param: name type: str required: True
  • switch-controller.auto-config_custom param: name type: str required: True
  • switch-controller.auto-config_default
  • switch-controller.auto-config_policy param: name type: str required: True
  • switch-controller.initial-config_template param: name type: str required: True
  • switch-controller.initial-config_vlans
  • switch-controller.ptp_policy param: name type: str required: True
  • switch-controller.ptp_settings
  • switch-controller.qos_dot1p-map param: name type: str required: True
  • switch-controller.qos_ip-dscp-map param: name type: str required: True
  • switch-controller.qos_qos-policy param: name type: str required: True
  • switch-controller.qos_queue-policy param: name type: str required: True
  • switch-controller.security-policy_802-1X param: name type: str required: True
  • switch-controller.security-policy_captive-portal param: name type: str required: True
  • switch-controller.security-policy_local-access param: name type: str required: True
  • switch-controller_802-1X-settings
  • switch-controller_custom-command param: command_name type: str required: True
  • switch-controller_dynamic-port-policy param: name type: str required: True
  • switch-controller_flow-tracking
  • switch-controller_fortilink-settings param: name type: str required: True
  • switch-controller_global
  • switch-controller_igmp-snooping
  • switch-controller_lldp-profile param: name type: str required: True
  • switch-controller_lldp-settings
  • switch-controller_location param: name type: str required: True
  • switch-controller_mac-policy param: name type: str required: True
  • switch-controller_mac-sync-settings
  • switch-controller_managed-switch param: switch_id type: str required: True
  • switch-controller_nac-device param: id type: int required: True
  • switch-controller_nac-settings param: name type: str required: True
  • switch-controller_network-monitor-settings
  • switch-controller_poe
  • switch-controller_port-policy param: name type: str required: True
  • switch-controller_quarantine
  • switch-controller_remote-log param: name type: str required: True
  • switch-controller_sflow
  • switch-controller_snmp-community param: id type: int required: True
  • switch-controller_snmp-sysinfo
  • switch-controller_snmp-trap-threshold
  • switch-controller_snmp-user param: name type: str required: True
  • switch-controller_storm-control
  • switch-controller_storm-control-policy param: name type: str required: True
  • switch-controller_stp-instance param: id type: str required: True
  • switch-controller_stp-settings
  • switch-controller_switch-group param: name type: str required: True
  • switch-controller_switch-interface-tag param: name type: str required: True
  • switch-controller_switch-log
  • switch-controller_switch-profile param: name type: str required: True
  • switch-controller_system
  • switch-controller_traffic-policy param: name type: str required: True
  • switch-controller_traffic-sniffer
  • switch-controller_virtual-port-pool param: name type: str required: True
  • switch-controller_vlan param: name type: str required: True
  • switch-controller_vlan-policy param: name type: str required: True
  • system.3g-modem_custom param: id type: int required: True
  • 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 required: True
  • system.dhcp_server param: id type: int required: True
  • system.info.admin_ssh
  • system.info.admin_status
  • system.ip-conflict_status
  • system.lldp_network-policy param: name type: str required: True
  • system.performance.firewall_packet-distribution
  • system.performance.firewall_statistics
  • system.performance_status
  • system.performance_top
  • system.replacemsg_admin param: msg_type type: str required: True
  • system.replacemsg_alertmail param: msg_type type: str required: True
  • system.replacemsg_auth param: msg_type type: str required: True
  • system.replacemsg_automation param: msg_type type: str required: True
  • system.replacemsg_device-detection-portal param: msg_type type: str required: True
  • system.replacemsg_ec param: msg_type type: str required: True
  • system.replacemsg_fortiguard-wf param: msg_type type: str required: True
  • system.replacemsg_ftp param: msg_type type: str required: True
  • system.replacemsg_http param: msg_type type: str required: True
  • system.replacemsg_icap param: msg_type type: str required: True
  • system.replacemsg_mail param: msg_type type: str required: True
  • system.replacemsg_mm1 param: msg_type type: str required: True
  • system.replacemsg_mm3 param: msg_type type: str required: True
  • system.replacemsg_mm4 param: msg_type type: str required: True
  • system.replacemsg_mm7 param: msg_type type: str required: True
  • system.replacemsg_mms param: msg_type type: str required: True
  • system.replacemsg_nac-quar param: msg_type type: str required: True
  • system.replacemsg_nntp param: msg_type type: str required: True
  • system.replacemsg_spam param: msg_type type: str required: True
  • system.replacemsg_sslvpn param: msg_type type: str required: True
  • system.replacemsg_traffic-quota param: msg_type type: str required: True
  • system.replacemsg_utm param: msg_type type: str required: True
  • system.replacemsg_webproxy param: msg_type type: str required: True
  • 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 required: True
  • system.snmp_mib-view param: name type: str required: True
  • system.snmp_sysinfo
  • system.snmp_user param: name type: str required: True
  • system.source-ip_status
  • system_accprofile param: name type: str required: True
  • system_acme
  • system_admin param: name type: str required: True
  • system_affinity-interrupt param: id type: int required: True
  • system_affinity-packet-redistribution param: id type: int required: True
  • system_alarm
  • system_alias param: name type: str required: True
  • system_api-user param: name type: str required: True
  • system_arp
  • system_arp-table param: id type: int required: True
  • system_auto-install
  • system_auto-script param: name type: str required: True
  • system_automation-action param: name type: str required: True
  • system_automation-destination param: name type: str required: True
  • system_automation-stitch param: name type: str required: True
  • system_automation-trigger param: name type: str required: True
  • system_central-management
  • system_central-mgmt
  • system_cluster-sync param: sync_id type: int required: True
  • system_cmdb
  • system_console
  • system_csf
  • system_custom-language param: name type: str required: True
  • system_ddns param: ddnsid type: int required: True
  • system_dedicated-mgmt
  • system_dns
  • system_dns-database param: name type: str required: True
  • system_dns-server param: name type: str required: True
  • system_dns64
  • system_dscp-based-priority param: id type: int required: True
  • system_email-server
  • system_external-resource param: name type: str required: True
  • system_federated-upgrade
  • system_fips-cc
  • system_fm
  • system_fortiai
  • system_fortianalyzer-connectivity
  • system_fortiguard
  • system_fortiguard-log-service
  • system_fortiguard-service
  • system_fortimanager
  • system_fortindr
  • system_fortisandbox
  • system_fsso-polling
  • system_ftm-push
  • system_geneve param: name type: str required: True
  • system_geoip-country param: id type: str required: True
  • system_geoip-override param: name type: str required: True
  • system_gi-gk
  • system_global
  • system_gre-tunnel param: name type: str required: True
  • system_ha
  • system_ha-monitor
  • system_ha-nonsync-csum
  • system_ike
  • system_interface param: name type: str required: True
  • system_ipam
  • system_ipip-tunnel param: name type: str required: True
  • system_ips
  • system_ips-urlfilter-dns param: address type: str required: True
  • system_ips-urlfilter-dns6 param: address6 type: str required: True
  • system_ipsec-aggregate param: name type: str required: True
  • system_ipv6-neighbor-cache param: id type: int required: True
  • system_ipv6-tunnel param: name type: str required: True
  • system_isf-queue-profile param: name type: str required: True
  • system_link-monitor param: name type: str required: True
  • system_lte-modem
  • system_mac-address-table param: mac type: str required: True
  • system_management-tunnel
  • system_mem-mgr
  • system_mgmt-csum
  • system_mobile-tunnel param: name type: str required: True
  • system_modem
  • system_nat64
  • system_nd-proxy
  • system_netflow
  • system_network-visibility
  • system_np6 param: name type: str required: True
  • system_npu
  • system_ntp
  • system_object-tagging param: category type: str required: True
  • system_password-policy
  • system_password-policy-guest-admin
  • system_physical-switch param: name type: str required: True
  • system_pppoe-interface param: name type: str required: True
  • system_probe-response
  • system_proxy-arp param: id type: int required: True
  • system_ptp
  • system_replacemsg-group param: name type: str required: True
  • system_replacemsg-image param: name type: str required: True
  • system_resource-limits
  • system_saml
  • system_sdn-connector param: name type: str required: True
  • system_sdwan
  • system_session
  • system_session-helper param: id type: int required: True
  • system_session-ttl
  • system_session6
  • system_settings
  • system_sflow
  • system_sit-tunnel param: name type: str required: True
  • system_smc-ntp
  • system_sms-server param: name type: str required: True
  • system_speed-test-schedule param: interface type: str required: True
  • system_speed-test-server param: name type: str required: True
  • system_sso-admin param: name type: str required: True
  • system_sso-forticloud-admin param: name type: str required: True
  • system_standalone-cluster
  • system_startup-error-log
  • system_status
  • system_storage param: name type: str required: True
  • system_stp
  • system_switch-interface param: name type: str required: True
  • system_tos-based-priority param: id type: int required: True
  • system_vdom param: name type: str required: True
  • system_vdom-dns
  • system_vdom-exception param: id type: int required: True
  • system_vdom-link param: name type: str required: True
  • system_vdom-netflow
  • system_vdom-property param: name type: str required: True
  • system_vdom-radius-server param: name type: str required: True
  • system_vdom-sflow
  • system_virtual-switch param: name type: str required: True
  • system_virtual-wan-link
  • system_virtual-wire-pair param: name type: str required: True
  • system_vne-tunnel
  • system_vxlan param: name type: str required: True
  • system_wccp param: service_id type: str required: True
  • system_zone param: name type: str required: True
  • user_adgrp param: name type: str required: True
  • user_certificate param: name type: str required: True
  • user_device param: alias type: str required: True
  • user_device-access-list param: name type: str required: True
  • user_device-category param: name type: str required: True
  • user_device-group param: name type: str required: True
  • user_domain-controller param: name type: str required: True
  • user_exchange param: name type: str required: True
  • user_fortitoken param: serial_number type: str required: True
  • user_fsso param: name type: str required: True
  • user_fsso-polling param: id type: int required: True
  • user_group param: name type: str required: True
  • user_krb-keytab param: name type: str required: True
  • user_ldap param: name type: str required: True
  • user_local param: name type: str required: True
  • user_nac-policy param: name type: str required: True
  • user_password-policy param: name type: str required: True
  • user_peer param: name type: str required: True
  • user_peergrp param: name type: str required: True
  • user_pop3 param: name type: str required: True
  • user_quarantine
  • user_radius param: name type: str required: True
  • user_saml param: name type: str required: True
  • user_security-exempt-list param: name type: str required: True
  • user_setting
  • user_tacacs+ param: name type: str required: True
  • videofilter_profile param: name type: str required: True
  • videofilter_youtube-channel-filter param: id type: int required: True
  • videofilter_youtube-key param: id type: int required: True
  • voip_profile param: name type: str required: True
  • vpn.certificate_ca param: name type: str required: True
  • vpn.certificate_crl param: name type: str required: True
  • vpn.certificate_local param: name type: str required: True
  • vpn.certificate_ocsp-server param: name type: str required: True
  • vpn.certificate_remote param: name type: str required: True
  • 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: id type: int required: True
  • vpn.ipsec_fec param: name type: str required: True
  • vpn.ipsec_forticlient param: realm type: str required: True
  • vpn.ipsec_manualkey param: name type: str required: True
  • vpn.ipsec_manualkey-interface param: name type: str required: True
  • vpn.ipsec_phase1 param: name type: str required: True
  • vpn.ipsec_phase1-interface param: name type: str required: True
  • vpn.ipsec_phase2 param: name type: str required: True
  • vpn.ipsec_phase2-interface param: name type: str required: True
  • vpn.ssl.web_host-check-software param: name type: str required: True
  • vpn.ssl.web_portal param: name type: str required: True
  • vpn.ssl.web_realm param: url_path type: str required: True
  • vpn.ssl.web_user-bookmark param: name type: str required: True
  • vpn.ssl.web_user-group-bookmark param: name type: str required: True
  • vpn.ssl_client param: name type: str required: True
  • 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 required: True
  • waf_profile param: name type: str required: True
  • waf_signature param: id type: int required: True
  • waf_sub-class param: id type: int required: True
  • wanopt_auth-group param: name type: str required: True
  • wanopt_cache-service
  • wanopt_content-delivery-network-rule param: name type: str required: True
  • wanopt_peer param: peer_host_id type: str required: True
  • wanopt_profile param: name type: str required: True
  • wanopt_remote-storage
  • wanopt_settings
  • wanopt_webcache
  • web-proxy_debug-url param: name type: str required: True
  • web-proxy_explicit
  • web-proxy_forward-server param: name type: str required: True
  • web-proxy_forward-server-group param: name type: str required: True
  • web-proxy_global
  • web-proxy_profile param: name type: str required: True
  • web-proxy_url-match param: name type: str required: True
  • web-proxy_wisp param: name type: str required: True
  • webfilter_categories
  • webfilter_content param: id type: int required: True
  • webfilter_content-header param: id type: int required: True
  • webfilter_fortiguard
  • webfilter_ftgd-local-cat param: desc type: str required: True
  • webfilter_ftgd-local-rating param: url type: str required: True
  • webfilter_ftgd-statistics
  • webfilter_ips-urlfilter-cache-setting
  • webfilter_ips-urlfilter-setting
  • webfilter_ips-urlfilter-setting6
  • webfilter_override param: id type: int required: True
  • webfilter_override-usr
  • webfilter_profile param: name type: str required: True
  • webfilter_search-engine param: name type: str required: True
  • webfilter_status
  • webfilter_urlfilter param: id type: int required: True
  • wireless-controller.hotspot20_anqp-3gpp-cellular param: name type: str required: True
  • wireless-controller.hotspot20_anqp-ip-address-type param: name type: str required: True
  • wireless-controller.hotspot20_anqp-nai-realm param: name type: str required: True
  • wireless-controller.hotspot20_anqp-network-auth-type param: name type: str required: True
  • wireless-controller.hotspot20_anqp-roaming-consortium param: name type: str required: True
  • wireless-controller.hotspot20_anqp-venue-name param: name type: str required: True
  • wireless-controller.hotspot20_anqp-venue-url param: name type: str required: True
  • wireless-controller.hotspot20_h2qp-advice-of-charge param: name type: str required: True
  • wireless-controller.hotspot20_h2qp-conn-capability param: name type: str required: True
  • wireless-controller.hotspot20_h2qp-operator-name param: name type: str required: True
  • wireless-controller.hotspot20_h2qp-osu-provider param: name type: str required: True
  • wireless-controller.hotspot20_h2qp-osu-provider-nai param: name type: str required: True
  • wireless-controller.hotspot20_h2qp-terms-and-conditions param: name type: str required: True
  • wireless-controller.hotspot20_h2qp-wan-metric param: name type: str required: True
  • wireless-controller.hotspot20_hs-profile param: name type: str required: True
  • wireless-controller.hotspot20_icon param: name type: str required: True
  • wireless-controller.hotspot20_qos-map param: name type: str required: True
  • wireless-controller_access-control-list param: name type: str required: True
  • wireless-controller_address param: id type: str required: True
  • wireless-controller_addrgrp param: id type: str required: True
  • wireless-controller_ap-status param: id type: int required: True
  • wireless-controller_apcfg-profile param: name type: str required: True
  • wireless-controller_arrp-profile param: name type: str required: True
  • wireless-controller_ble-profile param: name type: str required: True
  • wireless-controller_bonjour-profile param: name type: str required: True
  • wireless-controller_client-info
  • wireless-controller_global
  • wireless-controller_inter-controller
  • wireless-controller_log
  • wireless-controller_mpsk-profile param: name type: str required: True
  • wireless-controller_nac-profile param: name type: str required: True
  • wireless-controller_qos-profile param: name type: str required: True
  • wireless-controller_region param: name type: str required: True
  • wireless-controller_rf-analysis
  • wireless-controller_scan
  • wireless-controller_setting
  • wireless-controller_snmp
  • wireless-controller_spectral-info
  • wireless-controller_ssid-policy param: name type: str required: True
  • wireless-controller_status
  • wireless-controller_syslog-profile param: name type: str required: True
  • wireless-controller_timers
  • wireless-controller_utm-profile param: name type: str required: True
  • wireless-controller_vap param: name type: str required: True
  • wireless-controller_vap-group param: name type: str required: True
  • wireless-controller_vap-status
  • wireless-controller_wag-profile param: name type: str required: True
  • wireless-controller_wids-profile param: name type: str required: True
  • wireless-controller_wlchanlistlic
  • wireless-controller_wtp param: wtp_id type: str required: True
  • wireless-controller_wtp-group param: name type: str required: True
  • wireless-controller_wtp-profile param: name type: str required: True
  • wireless-controller_wtp-status
• params - the parameter for each selector, see definition in above list.type: dict
• selectors - selectors list allows to pass more than one selector and its parameters in a task.type: list
• output_path - The path that is used to save the generated playbooks.type: str

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 generated playbooks will be stored at the specified output path.
• The default value for state is present, please set the value to absent if needed.

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: Export multiple palybooks
    fortios_export_config_playbook:
      selectors:
      - selector: firewall_address
        params:
          name: "gmail.com"
      - selector: system.snmp_user
        params:
          name: "snmp_user_test"
      output_path: "./"

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.