Fortinet FortiManager Ansible Collection
galaxy/2.0.0

User's Guide

  • Install FortiManager Ansible Galaxy
  • Run Your First Playbook
  • Migrate Legacy Playbooks
  • Error Handling
  • Get Help

Playbook Examples

  • Search Playbooks

Modules Digest

  • Modules Digest

Modules Index

  • Object Oriented Modules
    • fmgr_adom_options
    • fmgr_antivirus_mmschecksum – Configure MMS content checksum list.
    • fmgr_antivirus_mmschecksum_entries – modify this MMS content checksum list
    • fmgr_antivirus_notification – Configure AntiVirus notification lists.
    • fmgr_antivirus_notification_entries – modify this antivirus notification list
    • fmgr_antivirus_profile – Configure AntiVirus profiles.
    • fmgr_antivirus_profile_contentdisarm – AV Content Disarm and Reconstruction settings.
    • fmgr_antivirus_profile_ftp – Configure FTP AntiVirus options.
    • fmgr_antivirus_profile_http – Configure HTTP AntiVirus options.
    • fmgr_antivirus_profile_imap – Configure IMAP AntiVirus options.
    • fmgr_antivirus_profile_mapi – Configure MAPI AntiVirus options.
    • fmgr_antivirus_profile_nacquar – Configure AntiVirus quarantine settings.
    • fmgr_antivirus_profile_nntp – Configure NNTP AntiVirus options.
    • fmgr_antivirus_profile_pop3 – Configure POP3 AntiVirus options.
    • fmgr_antivirus_profile_smb – Configure SMB AntiVirus options.
    • fmgr_antivirus_profile_smtp – Configure SMTP AntiVirus options.
    • fmgr_application_categories
    • fmgr_application_custom – Configure custom application signatures.
    • fmgr_application_group – Configure firewall application groups.
    • fmgr_application_list – Configure application control lists.
    • fmgr_application_list_entries – Application list entries.
    • fmgr_application_list_entries_parameters – Application parameters.
    • fmgr_bleprofile – Configure Bluetooth Low Energy profile.
    • fmgr_bonjourprofile – Configure Bonjour profiles.
    • fmgr_bonjourprofile_policylist – Bonjour policy list.
    • fmgr_certificate_template
    • fmgr_devprof_device_profile_fortianalyzer
    • fmgr_devprof_device_profile_fortiguard
    • fmgr_devprof_log_fortianalyzer_setting – Global FortiAnalyzer settings.
    • fmgr_devprof_log_syslogd_filter – Filters for remote system server.
    • fmgr_devprof_log_syslogd_setting – Global settings for remote syslog server.
    • fmgr_devprof_system_centralmanagement – Configure central management.
    • fmgr_devprof_system_centralmanagement_serverlist – Additional severs that the FortiGate can use for updates (for AV, IPS, updates) and ratings (for web filter and antispam ratings) servers.
    • fmgr_devprof_system_dns – Configure DNS.
    • fmgr_devprof_system_emailserver – Configure the email server used by the FortiGate various things.
    • fmgr_devprof_system_global – Configure global attributes.
    • fmgr_devprof_system_ntp – Configure system NTP information.
    • fmgr_devprof_system_ntp_ntpserver – Configure the FortiGate to connect to any available third-party NTP server.
    • fmgr_devprof_system_replacemsg_admin – Replacement messages.
    • fmgr_devprof_system_replacemsg_alertmail – Replacement messages.
    • fmgr_devprof_system_replacemsg_auth – Replacement messages.
    • fmgr_devprof_system_replacemsg_devicedetectionportal – Replacement messages.
    • fmgr_devprof_system_replacemsg_ec – Replacement messages.
    • fmgr_devprof_system_replacemsg_fortiguardwf – Replacement messages.
    • fmgr_devprof_system_replacemsg_ftp – Replacement messages.
    • fmgr_devprof_system_replacemsg_http – Replacement messages.
    • fmgr_devprof_system_replacemsg_mail – Replacement messages.
    • fmgr_devprof_system_replacemsg_mms – Replacement messages.
    • fmgr_devprof_system_replacemsg_nacquar – Replacement messages.
    • fmgr_devprof_system_replacemsg_nntp – Replacement messages.
    • fmgr_devprof_system_replacemsg_spam – Replacement messages.
    • fmgr_devprof_system_replacemsg_sslvpn – Replacement messages.
    • fmgr_devprof_system_replacemsg_trafficquota – Replacement messages.
    • fmgr_devprof_system_replacemsg_utm – Replacement messages.
    • fmgr_devprof_system_replacemsg_webproxy – Replacement messages.
    • fmgr_devprof_system_snmp_community – SNMP community configuration.
    • fmgr_devprof_system_snmp_community_hosts – Configure IPv4 SNMP managers (hosts).
    • fmgr_devprof_system_snmp_community_hosts6 – Configure IPv6 SNMP managers.
    • fmgr_devprof_system_snmp_sysinfo – SNMP system info configuration.
    • fmgr_devprof_system_snmp_user – SNMP user configuration.
    • fmgr_dlp_filepattern – Configure file patterns used by DLP blocking.
    • fmgr_dlp_filepattern_entries – Configure file patterns used by DLP blocking.
    • fmgr_dlp_fpsensitivity – Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source.
    • fmgr_dlp_sensor – Configure DLP sensors.
    • fmgr_dlp_sensor_filter – Set up DLP filters for this sensor.
    • fmgr_dnsfilter_domainfilter – Configure DNS domain filters.
    • fmgr_dnsfilter_domainfilter_entries – DNS domain filter entries.
    • fmgr_dnsfilter_profile – Configure DNS domain filter profiles.
    • fmgr_dnsfilter_profile_domainfilter – Domain filter settings.
    • fmgr_dnsfilter_profile_ftgddns – FortiGuard DNS Filter settings.
    • fmgr_dnsfilter_profile_ftgddns_filters – FortiGuard DNS domain filters.
    • fmgr_dvmdb_adom – ADOM table, most attributes are read-only and can only be changed internally.
    • fmgr_dvmdb_adom_objectmember – ADOM table, most attributes are read-only and can only be changed internally.
    • fmgr_dvmdb_device – Device table, most attributes are read-only and can only be changed internally.
    • fmgr_dvmdb_device_vdom – Device VDOM table.
    • fmgr_dvmdb_group – Device group table.
    • fmgr_dvmdb_group_objectmember – Device group table.
    • fmgr_dvmdb_metafields_adom
    • fmgr_dvmdb_metafields_device
    • fmgr_dvmdb_metafields_group
    • fmgr_dvmdb_revision – ADOM revision table.
    • fmgr_dvmdb_script – Script table.
    • fmgr_dvmdb_script_objectmember – Script table.
    • fmgr_dvmdb_script_scriptschedule – Script schedule table.
    • fmgr_dynamic_address
    • fmgr_dynamic_address_dynamicaddrmapping
    • fmgr_dynamic_certificate_local
    • fmgr_dynamic_certificate_local_dynamicmapping
    • fmgr_dynamic_interface
    • fmgr_dynamic_interface_dynamicmapping
    • fmgr_dynamic_ippool
    • fmgr_dynamic_multicast_interface
    • fmgr_dynamic_multicast_interface_dynamicmapping
    • fmgr_dynamic_vip
    • fmgr_dynamic_virtualwanlink_members
    • fmgr_dynamic_virtualwanlink_members_dynamicmapping
    • fmgr_dynamic_virtualwanlink_server
    • fmgr_dynamic_virtualwanlink_server_dynamicmapping
    • fmgr_dynamic_vpntunnel
    • fmgr_dynamic_vpntunnel_dynamicmapping
    • fmgr_firewall_address – Configure IPv4 addresses.
    • fmgr_firewall_address6 – Configure IPv6 firewall addresses.
    • fmgr_firewall_address6_dynamicmapping
    • fmgr_firewall_address6_list – IP address list.
    • fmgr_firewall_address6_subnetsegment – IPv6 subnet segments.
    • fmgr_firewall_address6_tagging – Config object tagging
    • fmgr_firewall_address6template – Configure IPv6 address templates.
    • fmgr_firewall_address6template_subnetsegment – IPv6 subnet segments.
    • fmgr_firewall_address6template_subnetsegment_values – Subnet segment values.
    • fmgr_firewall_address_dynamicmapping
    • fmgr_firewall_address_list – IP address list.
    • fmgr_firewall_address_tagging – Config object tagging.
    • fmgr_firewall_addrgrp – Configure IPv4 address groups.
    • fmgr_firewall_addrgrp6 – Configure IPv6 address groups.
    • fmgr_firewall_addrgrp6_dynamicmapping
    • fmgr_firewall_addrgrp6_tagging – Config object tagging.
    • fmgr_firewall_addrgrp_dynamicmapping
    • fmgr_firewall_addrgrp_tagging – Config object tagging.
    • fmgr_firewall_carrierendpointbwl – Carrier end point black/white list tables.
    • fmgr_firewall_carrierendpointbwl_entries – Carrier end point black/white list.
    • fmgr_firewall_gtp – Configure GTP.
    • fmgr_firewall_gtp_apn – APN.
    • fmgr_firewall_gtp_ieremovepolicy – IE remove policy.
    • fmgr_firewall_gtp_ievalidation – IE validation.
    • fmgr_firewall_gtp_imsi – IMSI.
    • fmgr_firewall_gtp_ippolicy – IP policy.
    • fmgr_firewall_gtp_messageratelimit – Message rate limiting.
    • fmgr_firewall_gtp_messageratelimitv0 – Message rate limiting for GTP version 0.
    • fmgr_firewall_gtp_messageratelimitv1 – Message rate limiting for GTP version 1.
    • fmgr_firewall_gtp_messageratelimitv2 – Message rate limiting for GTP version 2.
    • fmgr_firewall_gtp_noippolicy – No IP policy.
    • fmgr_firewall_gtp_perapnshaper – Per APN shaper.
    • fmgr_firewall_gtp_policy – Policy.
    • fmgr_firewall_identitybasedroute – Configure identity based routing.
    • fmgr_firewall_identitybasedroute_rule – Rule.
    • fmgr_firewall_internetservice – Show Internet Service application.
    • fmgr_firewall_internetservice_entry – Entries in the Internet Service database.
    • fmgr_firewall_internetservicecustom – Configure custom Internet Services.
    • fmgr_firewall_internetservicecustom_disableentry – Disable entries in the Internet Service database.
    • fmgr_firewall_internetservicecustom_disableentry_iprange – IP ranges in the disable entry.
    • fmgr_firewall_internetservicecustom_entry – Entries added to the Internet Service database and custom database.
    • fmgr_firewall_internetservicecustom_entry_portrange – Port ranges in the custom entry.
    • fmgr_firewall_internetservicecustomgroup – Configure custom Internet Service group.
    • fmgr_firewall_internetservicegroup – Configure group of Internet Service.
    • fmgr_firewall_ippool – Configure IPv4 IP pools.
    • fmgr_firewall_ippool6 – Configure IPv6 IP pools.
    • fmgr_firewall_ippool6_dynamicmapping
    • fmgr_firewall_ippool_dynamicmapping
    • fmgr_firewall_ldbmonitor – Configure server load balancing health monitors.
    • fmgr_firewall_mmsprofile – Configure MMS profiles.
    • fmgr_firewall_mmsprofile_dupe – Duplicate configuration.
    • fmgr_firewall_mmsprofile_flood – Flood configuration.
    • fmgr_firewall_mmsprofile_notification – Notification configuration.
    • fmgr_firewall_mmsprofile_notifmsisdn – Notification for MSISDNs.
    • fmgr_firewall_multicastaddress – Configure multicast addresses.
    • fmgr_firewall_multicastaddress6 – Configure IPv6 multicast address.
    • fmgr_firewall_multicastaddress6_tagging – Config object tagging.
    • fmgr_firewall_multicastaddress_tagging – Config object tagging.
    • fmgr_firewall_profilegroup – Configure profile groups.
    • fmgr_firewall_profileprotocoloptions – Configure protocol options.
    • fmgr_firewall_profileprotocoloptions_dns – Configure DNS protocol options.
    • fmgr_firewall_profileprotocoloptions_ftp – Configure FTP protocol options.
    • fmgr_firewall_profileprotocoloptions_http – Configure HTTP protocol options.
    • fmgr_firewall_profileprotocoloptions_imap – Configure IMAP protocol options.
    • fmgr_firewall_profileprotocoloptions_mailsignature – Configure Mail signature.
    • fmgr_firewall_profileprotocoloptions_mapi – Configure MAPI protocol options.
    • fmgr_firewall_profileprotocoloptions_nntp – Configure NNTP protocol options.
    • fmgr_firewall_profileprotocoloptions_pop3 – Configure POP3 protocol options.
    • fmgr_firewall_profileprotocoloptions_smtp – Configure SMTP protocol options.
    • fmgr_firewall_proxyaddress – Web proxy address configuration.
    • fmgr_firewall_proxyaddress_headergroup – HTTP header group.
    • fmgr_firewall_proxyaddress_tagging – Config object tagging.
    • fmgr_firewall_proxyaddrgrp – Web proxy address group configuration.
    • fmgr_firewall_proxyaddrgrp_tagging – Config object tagging.
    • fmgr_firewall_schedule_group – Schedule group configuration.
    • fmgr_firewall_schedule_onetime – Onetime schedule configuration.
    • fmgr_firewall_schedule_recurring – Recurring schedule configuration.
    • fmgr_firewall_service_category – Configure service categories.
    • fmgr_firewall_service_custom – Configure custom services.
    • fmgr_firewall_service_group – Configure service groups.
    • fmgr_firewall_shaper_peripshaper – Configure per-IP traffic shaper.
    • fmgr_firewall_shaper_trafficshaper – Configure shared traffic shaper.
    • fmgr_firewall_shapingprofile – Configure shaping profiles.
    • fmgr_firewall_shapingprofile_shapingentries – Define shaping entries of this shaping profile.
    • fmgr_firewall_sslsshprofile – Configure SSL/SSH protocol options.
    • fmgr_firewall_sslsshprofile_ftps – Configure FTPS options.
    • fmgr_firewall_sslsshprofile_https – Configure HTTPS options.
    • fmgr_firewall_sslsshprofile_imaps – Configure IMAPS options.
    • fmgr_firewall_sslsshprofile_pop3s – Configure POP3S options.
    • fmgr_firewall_sslsshprofile_smtps – Configure SMTPS options.
    • fmgr_firewall_sslsshprofile_ssh – Configure SSH options.
    • fmgr_firewall_sslsshprofile_ssl – Configure SSL options.
    • fmgr_firewall_sslsshprofile_sslexempt – Servers to exempt from SSL inspection.
    • fmgr_firewall_sslsshprofile_sslserver – SSL servers.
    • fmgr_firewall_vip – Configure virtual IP for IPv4.
    • fmgr_firewall_vip46 – Configure IPv4 to IPv6 virtual IPs.
    • fmgr_firewall_vip46_dynamicmapping
    • fmgr_firewall_vip46_realservers – Real servers.
    • fmgr_firewall_vip6 – Configure virtual IP for IPv6.
    • fmgr_firewall_vip64 – Configure IPv6 to IPv4 virtual IPs.
    • fmgr_firewall_vip64_dynamicmapping
    • fmgr_firewall_vip64_realservers – Real servers.
    • fmgr_firewall_vip6_dynamicmapping
    • fmgr_firewall_vip6_realservers – Select the real servers that this server load balancing VIP will distribute traffic to.
    • fmgr_firewall_vip6_sslciphersuites – SSL/TLS cipher suites acceptable from a client, ordered by priority.
    • fmgr_firewall_vip6_sslserverciphersuites – SSL/TLS cipher suites to offer to a server, ordered by priority.
    • fmgr_firewall_vip_dynamicmapping
    • fmgr_firewall_vip_dynamicmapping_realservers
    • fmgr_firewall_vip_dynamicmapping_sslciphersuites
    • fmgr_firewall_vip_realservers – Select the real servers that this server load balancing VIP will distribute traffic to.
    • fmgr_firewall_vip_sslciphersuites – SSL/TLS cipher suites acceptable from a client, ordered by priority.
    • fmgr_firewall_vip_sslserverciphersuites – SSL/TLS cipher suites to offer to a server, ordered by priority.
    • fmgr_firewall_vipgrp – Configure IPv4 virtual IP groups.
    • fmgr_firewall_vipgrp46 – Configure IPv4 to IPv6 virtual IP groups.
    • fmgr_firewall_vipgrp6 – Configure IPv6 virtual IP groups.
    • fmgr_firewall_vipgrp64 – Configure IPv6 to IPv4 virtual IP groups.
    • fmgr_firewall_vipgrp_dynamicmapping
    • fmgr_firewall_wildcardfqdn_custom – Config global/VDOM Wildcard FQDN address.
    • fmgr_firewall_wildcardfqdn_group – Config global Wildcard FQDN address groups.
    • fmgr_fmupdate_analyzer_virusreport – Send virus detection notification to FortiGuard.
    • fmgr_fmupdate_avips_advancedlog – Enable/disable logging of FortiGuard antivirus and IPS update packages received by FortiManager’s built-in FortiGuard.
    • fmgr_fmupdate_avips_webproxy – Configure the web proxy for use with FortiGuard antivirus and IPS updates.
    • fmgr_fmupdate_customurllist – Configure the URL database for rating and filtering.
    • fmgr_fmupdate_diskquota – Configure disk space available for use by the Upgrade Manager.
    • fmgr_fmupdate_fctservices – Configure FortiGuard to provide services to FortiClient installations.
    • fmgr_fmupdate_fdssetting – Configure FortiGuard settings.
    • fmgr_fmupdate_fdssetting_pushoverride – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for clients.
    • fmgr_fmupdate_fdssetting_pushoverridetoclient – Enable/disable push updates, and override the default IP address and port used by FortiGuard to send antivirus and IPS push messages for clients.
    • fmgr_fmupdate_fdssetting_pushoverridetoclient_announceip – Announce IP addresses for the device.
    • fmgr_fmupdate_fdssetting_serveroverride – Server override configure.
    • fmgr_fmupdate_fdssetting_serveroverride_servlist – Override server.
    • fmgr_fmupdate_fdssetting_updateschedule – Configure the schedule when built-in FortiGuard retrieves antivirus and IPS updates.
    • fmgr_fmupdate_multilayer – Configure multilayer mode.
    • fmgr_fmupdate_publicnetwork – Enable/disable access to the public FortiGuard.
    • fmgr_fmupdate_serveraccesspriorities – Configure priorities for FortiGate units accessing antivirus updates and web filtering services.
    • fmgr_fmupdate_serveraccesspriorities_privateserver – Configure multiple FortiManager units and private servers.
    • fmgr_fmupdate_serveroverridestatus – Configure strict/loose server override.
    • fmgr_fmupdate_service – Enable/disable services provided by the built-in FortiGuard.
    • fmgr_fmupdate_webspam_fgdsetting – Configure the FortiGuard run parameters.
    • fmgr_fmupdate_webspam_fgdsetting_serveroverride – Server override configure.
    • fmgr_fmupdate_webspam_fgdsetting_serveroverride_servlist – Override server.
    • fmgr_fmupdate_webspam_webproxy – Configure the web proxy for use with FortiGuard antivirus and IPS updates.
    • fmgr_fsp_vlan
    • fmgr_fsp_vlan_dhcpserver
    • fmgr_fsp_vlan_dhcpserver_excluderange
    • fmgr_fsp_vlan_dhcpserver_iprange
    • fmgr_fsp_vlan_dhcpserver_options
    • fmgr_fsp_vlan_dhcpserver_reservedaddress
    • fmgr_fsp_vlan_dynamicmapping
    • fmgr_fsp_vlan_dynamicmapping_dhcpserver
    • fmgr_fsp_vlan_dynamicmapping_dhcpserver_excluderange
    • fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange
    • fmgr_fsp_vlan_dynamicmapping_dhcpserver_options
    • fmgr_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress
    • fmgr_fsp_vlan_dynamicmapping_interface
    • fmgr_fsp_vlan_interface
    • fmgr_fsp_vlan_interface_ipv6
    • fmgr_fsp_vlan_interface_secondaryip
    • fmgr_fsp_vlan_interface_vrrp
    • fmgr_gtp_apn – Configure APN for GTP.
    • fmgr_gtp_apngrp – Configure APN groups for GTP.
    • fmgr_gtp_iewhitelist – IE white list.
    • fmgr_gtp_iewhitelist_entries – Entries of white list (to allow) for unknown or out-of-state IEs.
    • fmgr_gtp_messagefilterv0v1 – Message filter for GTPv0/v1 messages.
    • fmgr_gtp_messagefilterv2 – Message filter for GTPv2 messages.
    • fmgr_gtp_tunnellimit – GTP tunnel limiter.
    • fmgr_hotspot20_anqp3gppcellular – Configure 3GPP public land mobile network (PLMN).
    • fmgr_hotspot20_anqp3gppcellular_mccmnclist – Mobile Country Code and Mobile Network Code configuration.
    • fmgr_hotspot20_anqpipaddresstype – Configure IP address type availability.
    • fmgr_hotspot20_anqpnairealm – Configure network access identifier (NAI) realm.
    • fmgr_hotspot20_anqpnairealm_nailist – NAI list.
    • fmgr_hotspot20_anqpnairealm_nailist_eapmethod – EAP Methods.
    • fmgr_hotspot20_anqpnairealm_nailist_eapmethod_authparam – EAP auth param.
    • fmgr_hotspot20_anqpnetworkauthtype – Configure network authentication type.
    • fmgr_hotspot20_anqproamingconsortium – Configure roaming consortium.
    • fmgr_hotspot20_anqproamingconsortium_oilist – Organization identifier list.
    • fmgr_hotspot20_anqpvenuename – Configure venue name duple.
    • fmgr_hotspot20_anqpvenuename_valuelist – Name list.
    • fmgr_hotspot20_h2qpconncapability – Configure connection capability.
    • fmgr_hotspot20_h2qpoperatorname – Configure operator friendly name.
    • fmgr_hotspot20_h2qpoperatorname_valuelist – Name list.
    • fmgr_hotspot20_h2qposuprovider – Configure online sign up (OSU) provider list.
    • fmgr_hotspot20_h2qposuprovider_friendlyname – OSU provider friendly name.
    • fmgr_hotspot20_h2qposuprovider_servicedescription – OSU service name.
    • fmgr_hotspot20_h2qpwanmetric – Configure WAN metrics.
    • fmgr_hotspot20_hsprofile – Configure hotspot profile.
    • fmgr_hotspot20_qosmap – Configure QoS map set.
    • fmgr_hotspot20_qosmap_dscpexcept – Differentiated Services Code Point (DSCP) exceptions.
    • fmgr_hotspot20_qosmap_dscprange – Differentiated Services Code Point (DSCP) ranges.
    • fmgr_icap_profile – Configure ICAP profiles.
    • fmgr_icap_server – Configure ICAP servers.
    • fmgr_ips_custom – Configure IPS custom signature.
    • fmgr_ips_sensor – Configure IPS sensor.
    • fmgr_ips_sensor_entries – IPS sensor filter.
    • fmgr_ips_sensor_entries_exemptip – Traffic from selected source or destination IP addresses is exempt from this signature.
    • fmgr_log_customfield – Configure custom log fields.
    • fmgr_metafields_system_admin_user
    • fmgr_pkg_central_dnat
    • fmgr_pkg_firewall_centralsnatmap – Configure central SNAT policies.
    • fmgr_pkg_firewall_dospolicy – Configure IPv4 DoS policies.
    • fmgr_pkg_firewall_dospolicy6 – Configure IPv6 DoS policies.
    • fmgr_pkg_firewall_dospolicy6_anomaly – Anomaly name.
    • fmgr_pkg_firewall_dospolicy_anomaly – Anomaly name.
    • fmgr_pkg_firewall_interfacepolicy – Configure IPv4 interface policies.
    • fmgr_pkg_firewall_interfacepolicy6 – Configure IPv6 interface policies.
    • fmgr_pkg_firewall_interfacepolicy6_sectionvalue – Configure IPv6 interface policies.
    • fmgr_pkg_firewall_interfacepolicy_sectionvalue – Configure IPv4 interface policies.
    • fmgr_pkg_firewall_localinpolicy – Configure user defined IPv4 local-in policies.
    • fmgr_pkg_firewall_localinpolicy6 – Configure user defined IPv6 local-in policies.
    • fmgr_pkg_firewall_multicastpolicy – Configure multicast NAT policies.
    • fmgr_pkg_firewall_multicastpolicy6 – Configure IPv6 multicast NAT policies.
    • fmgr_pkg_firewall_policy – Configure IPv4 policies.
    • fmgr_pkg_firewall_policy46 – Configure IPv4 to IPv6 policies.
    • fmgr_pkg_firewall_policy6 – Configure IPv6 policies.
    • fmgr_pkg_firewall_policy64 – Configure IPv6 to IPv4 policies.
    • fmgr_pkg_firewall_policy6_sectionvalue – Configure IPv6 policies.
    • fmgr_pkg_firewall_policy_sectionvalue – Configure IPv4 policies.
    • fmgr_pkg_firewall_policy_vpndstnode
    • fmgr_pkg_firewall_policy_vpnsrcnode
    • fmgr_pkg_firewall_proxypolicy – Configure proxy policies.
    • fmgr_pkg_firewall_proxypolicy_sectionvalue – Configure proxy policies.
    • fmgr_pkg_firewall_shapingpolicy – Configure shaping policies.
    • fmgr_pkg_footer_policy
      • Synopsis
      • Requirements
      • Parameters
      • Notes
      • Examples
      • Return Values
      • Status
      • Authors
    • fmgr_pkg_footer_policy6
    • fmgr_pkg_footer_shapingpolicy
    • fmgr_pkg_header_policy
    • fmgr_pkg_header_policy6
    • fmgr_pkg_header_shapingpolicy
    • fmgr_pm_devprof_adom
    • fmgr_pm_devprof_pkg
    • fmgr_pm_pkg
    • fmgr_pm_pkg_adom
    • fmgr_pm_pkg_global
    • fmgr_pm_wanprof_adom
    • fmgr_pm_wanprof_pkg
    • fmgr_qosprofile – Configure WiFi quality of service (QoS) profiles.
    • fmgr_spamfilter_bwl – Configure anti-spam black/white list.
    • fmgr_spamfilter_bwl_entries – Anti-spam black/white list entries.
    • fmgr_spamfilter_bword – Configure AntiSpam banned word list.
    • fmgr_spamfilter_bword_entries – Spam filter banned word.
    • fmgr_spamfilter_dnsbl – Configure AntiSpam DNSBL/ORBL.
    • fmgr_spamfilter_dnsbl_entries – Spam filter DNSBL and ORBL server.
    • fmgr_spamfilter_iptrust – Configure AntiSpam IP trust.
    • fmgr_spamfilter_iptrust_entries – Spam filter trusted IP addresses.
    • fmgr_spamfilter_mheader – Configure AntiSpam MIME header.
    • fmgr_spamfilter_mheader_entries – Spam filter mime header content.
    • fmgr_spamfilter_profile – Configure AntiSpam profiles.
    • fmgr_spamfilter_profile_gmail – Gmail.
    • fmgr_spamfilter_profile_imap – IMAP.
    • fmgr_spamfilter_profile_mapi – MAPI.
    • fmgr_spamfilter_profile_msnhotmail – MSN Hotmail.
    • fmgr_spamfilter_profile_pop3 – POP3.
    • fmgr_spamfilter_profile_smtp – SMTP.
    • fmgr_spamfilter_profile_yahoomail – Yahoo! Mail.
    • fmgr_sshfilter_profile – SSH filter profile.
    • fmgr_sshfilter_profile_shellcommands – SSH command filter.
    • fmgr_switchcontroller_lldpprofile – Configure FortiSwitch LLDP profiles.
    • fmgr_switchcontroller_lldpprofile_customtlvs – Configuration method to edit custom TLV entries.
    • fmgr_switchcontroller_lldpprofile_mednetworkpolicy – Configuration method to edit Media Endpoint Discovery (MED) network policy type-length-value (TLV) categories.
    • fmgr_switchcontroller_managedswitch – Configure FortiSwitch devices that are managed by this FortiGate.
    • fmgr_switchcontroller_managedswitch_8021xsettings – Configuration method to edit FortiSwitch 802.
    • fmgr_switchcontroller_managedswitch_customcommand – Configuration method to edit FortiSwitch commands to be pushed to this FortiSwitch device upon rebooting the FortiGate switch controller or the FortiSwitch.
    • fmgr_switchcontroller_managedswitch_igmpsnooping – Configure FortiSwitch IGMP snooping global settings.
    • fmgr_switchcontroller_managedswitch_mirror – Configuration method to edit FortiSwitch packet mirror.
    • fmgr_switchcontroller_managedswitch_ports – Managed-switch port list.
    • fmgr_switchcontroller_managedswitch_stormcontrol – Configuration method to edit FortiSwitch storm control for measuring traffic activity using data rates to prevent traffic disruption.
    • fmgr_switchcontroller_managedswitch_stpsettings – Configuration method to edit Spanning Tree Protocol (STP) settings used to prevent bridge loops.
    • fmgr_switchcontroller_managedswitch_switchlog – Configuration method to edit FortiSwitch logging settings (logs are transferred to and inserted into the FortiGate event log).
    • fmgr_switchcontroller_managedswitch_switchstpsettings – Configure spanning tree protocol (STP).
    • fmgr_switchcontroller_qos_dot1pmap – Configure FortiSwitch QoS 802.
    • fmgr_switchcontroller_qos_ipdscpmap – Configure FortiSwitch QoS IP precedence/DSCP.
    • fmgr_switchcontroller_qos_ipdscpmap_map – Maps between IP-DSCP value to COS queue.
    • fmgr_switchcontroller_qos_qospolicy – Configure FortiSwitch QoS policy.
    • fmgr_switchcontroller_qos_queuepolicy – Configure FortiSwitch QoS egress queue policy.
    • fmgr_switchcontroller_qos_queuepolicy_cosqueue – COS queue configuration.
    • fmgr_switchcontroller_securitypolicy_8021x – Configure 802.
    • fmgr_switchcontroller_securitypolicy_captiveportal – Names of VLANs that use captive portal authentication.
    • fmgr_system_admin_group – User group.
    • fmgr_system_admin_group_member – Group members.
    • fmgr_system_admin_ldap – LDAP server entry configuration.
    • fmgr_system_admin_ldap_adom – Admin domain.
    • fmgr_system_admin_profile – Admin profile.
    • fmgr_system_admin_profile_datamaskcustomfields – Customized datamask fields.
    • fmgr_system_admin_radius – Configure radius.
    • fmgr_system_admin_setting – Admin setting.
    • fmgr_system_admin_tacacs – TACACS+ server entry configuration.
    • fmgr_system_admin_user – Admin user.
    • fmgr_system_admin_user_adom – Admin domain.
    • fmgr_system_admin_user_adomexclude – Excluding admin domain.
    • fmgr_system_admin_user_appfilter – App filter.
    • fmgr_system_admin_user_dashboard – Custom dashboard widgets.
    • fmgr_system_admin_user_dashboardtabs – Custom dashboard.
    • fmgr_system_admin_user_ipsfilter – IPS filter.
    • fmgr_system_admin_user_metadata – Configure meta data.
    • fmgr_system_admin_user_policypackage – Policy package access.
    • fmgr_system_admin_user_restrictdevvdom – Restricted to these devices/VDOMs.
    • fmgr_system_admin_user_webfilter – Web filter.
    • fmgr_system_alertconsole – Alert console.
    • fmgr_system_alertemail – Configure alertemail.
    • fmgr_system_alertevent – Alert events.
    • fmgr_system_alertevent_alertdestination – Alert destination.
    • fmgr_system_autodelete – Automatic deletion policy for logs, reports, archived, and quarantined files.
    • fmgr_system_autodelete_dlpfilesautodeletion – Automatic deletion policy for DLP archives.
    • fmgr_system_autodelete_logautodeletion – Automatic deletion policy for device logs.
    • fmgr_system_autodelete_quarantinefilesautodeletion – Automatic deletion policy for quarantined files.
    • fmgr_system_autodelete_reportautodeletion – Automatic deletion policy for reports.
    • fmgr_system_backup_allsettings – Scheduled backup settings.
    • fmgr_system_certificate_ca – CA certificate.
    • fmgr_system_certificate_crl – Certificate Revocation List.
    • fmgr_system_certificate_local – Local keys and certificates.
    • fmgr_system_certificate_oftp – OFTP certificates and keys.
    • fmgr_system_certificate_remote – Remote certificate.
    • fmgr_system_certificate_ssh – SSH certificates and keys.
    • fmgr_system_connector – Configure connector.
    • fmgr_system_customlanguage – Configure custom languages.
    • fmgr_system_dhcp_server – Configure DHCP servers.
    • fmgr_system_dhcp_server_excluderange – Exclude one or more ranges of IP addresses from being assigned to clients.
    • fmgr_system_dhcp_server_iprange – DHCP IP range configuration.
    • fmgr_system_dhcp_server_options – DHCP options.
    • fmgr_system_dhcp_server_reservedaddress – Options for the DHCP server to assign IP settings to specific MAC addresses.
    • fmgr_system_dm – Configure dm.
    • fmgr_system_dns – DNS configuration.
    • fmgr_system_externalresource – Configure external resource.
    • fmgr_system_fips – Settings for FIPS-CC mode.
    • fmgr_system_fortiguard – Configure FortiGuard services.
    • fmgr_system_fortiview_autocache – FortiView auto-cache settings.
    • fmgr_system_fortiview_setting – FortiView settings.
    • fmgr_system_geoipcountry
    • fmgr_system_geoipoverride – Configure geographical location mapping for IP address(es) to override mappings from FortiGuard.
    • fmgr_system_geoipoverride_iprange – Table of IP ranges assigned to country.
    • fmgr_system_global – Global range attributes.
    • fmgr_system_guiact – System settings through GUI.
    • fmgr_system_ha – HA configuration.
    • fmgr_system_ha_peer – Peer.
    • fmgr_system_interface – Interface configuration.
    • fmgr_system_interface_ipv6 – IPv6 of interface.
    • fmgr_system_locallog_disk_filter – Filter for disk logging.
    • fmgr_system_locallog_disk_setting – Settings for local disk logging.
    • fmgr_system_locallog_fortianalyzer2_filter – Filter for FortiAnalyzer2 logging.
    • fmgr_system_locallog_fortianalyzer2_setting – Settings for locallog to fortianalyzer.
    • fmgr_system_locallog_fortianalyzer3_filter – Filter for FortiAnalyzer3 logging.
    • fmgr_system_locallog_fortianalyzer3_setting – Settings for locallog to fortianalyzer.
    • fmgr_system_locallog_fortianalyzer_filter – Filter for FortiAnalyzer logging.
    • fmgr_system_locallog_fortianalyzer_setting – Settings for locallog to fortianalyzer.
    • fmgr_system_locallog_memory_filter – Filter for memory logging.
    • fmgr_system_locallog_memory_setting – Settings for memory buffer.
    • fmgr_system_locallog_setting – Settings for locallog logging.
    • fmgr_system_locallog_syslogd2_filter – Filter for syslog logging.
    • fmgr_system_locallog_syslogd2_setting – Settings for remote syslog server.
    • fmgr_system_locallog_syslogd3_filter – Filter for syslog logging.
    • fmgr_system_locallog_syslogd3_setting – Settings for remote syslog server.
    • fmgr_system_locallog_syslogd_filter – Filter for syslog logging.
    • fmgr_system_locallog_syslogd_setting – Settings for remote syslog server.
    • fmgr_system_log_alert – Log based alert settings.
    • fmgr_system_log_ioc – IoC settings.
    • fmgr_system_log_maildomain – FortiMail domain setting.
    • fmgr_system_log_settings – Log settings.
    • fmgr_system_log_settings_rollinganalyzer – Log rolling policy for Network Analyzer logs.
    • fmgr_system_log_settings_rollinglocal – Log rolling policy for local logs.
    • fmgr_system_log_settings_rollingregular – Log rolling policy for device logs.
    • fmgr_system_logfetch_clientprofile – Log-fetch client profile settings.
    • fmgr_system_logfetch_clientprofile_devicefilter – List of device filter.
    • fmgr_system_logfetch_clientprofile_logfilter – Log content filters.
    • fmgr_system_logfetch_serversettings – Log-fetch server settings.
    • fmgr_system_mail – Alert emails.
    • fmgr_system_meta
    • fmgr_system_meta_sysmetafields
    • fmgr_system_metadata_admins – Configure admins.
    • fmgr_system_ntp – NTP settings.
    • fmgr_system_ntp_ntpserver – NTP server.
    • fmgr_system_objecttagging – Configure object tagging.
    • fmgr_system_passwordpolicy – Password policy.
    • fmgr_system_replacemsggroup – Configure replacement message groups.
    • fmgr_system_replacemsggroup_admin – Replacement message table entries.
    • fmgr_system_replacemsggroup_alertmail – Replacement message table entries.
    • fmgr_system_replacemsggroup_auth – Replacement message table entries.
    • fmgr_system_replacemsggroup_custommessage – Replacement message table entries.
    • fmgr_system_replacemsggroup_devicedetectionportal – Replacement message table entries.
    • fmgr_system_replacemsggroup_ec – Replacement message table entries.
    • fmgr_system_replacemsggroup_fortiguardwf – Replacement message table entries.
    • fmgr_system_replacemsggroup_ftp – Replacement message table entries.
    • fmgr_system_replacemsggroup_http – Replacement message table entries.
    • fmgr_system_replacemsggroup_icap – Replacement message table entries.
    • fmgr_system_replacemsggroup_mail – Replacement message table entries.
    • fmgr_system_replacemsggroup_mm1 – Replacement message table entries.
    • fmgr_system_replacemsggroup_mm3 – Replacement message table entries.
    • fmgr_system_replacemsggroup_mm4 – Replacement message table entries.
    • fmgr_system_replacemsggroup_mm7 – Replacement message table entries.
    • fmgr_system_replacemsggroup_mms – Replacement message table entries.
    • fmgr_system_replacemsggroup_nacquar – Replacement message table entries.
    • fmgr_system_replacemsggroup_nntp – Replacement message table entries.
    • fmgr_system_replacemsggroup_spam – Replacement message table entries.
    • fmgr_system_replacemsggroup_sslvpn – Replacement message table entries.
    • fmgr_system_replacemsggroup_trafficquota – Replacement message table entries.
    • fmgr_system_replacemsggroup_utm – Replacement message table entries.
    • fmgr_system_replacemsggroup_webproxy – Replacement message table entries.
    • fmgr_system_replacemsgimage – Configure replacement message images.
    • fmgr_system_report_autocache – Report auto-cache settings.
    • fmgr_system_report_estbrowsetime – Report estimated browse time settings
    • fmgr_system_report_group – Report group.
    • fmgr_system_report_group_chartalternative – Chart alternatives.
    • fmgr_system_report_group_groupby – Group-by variables.
    • fmgr_system_report_setting – Report settings.
    • fmgr_system_route – Routing table configuration.
    • fmgr_system_route6 – Routing table configuration.
    • fmgr_system_saml – Global settings for SAML authentication.
    • fmgr_system_sdnconnector – Configure connection to SDN Connector.
    • fmgr_system_sdnconnector_externalip – Configure GCP external IP.
    • fmgr_system_sdnconnector_nic – Configure Azure network interface.
    • fmgr_system_sdnconnector_nic_ip – Configure IP configuration.
    • fmgr_system_sdnconnector_route – Configure GCP route.
    • fmgr_system_sdnconnector_routetable – Configure Azure route table.
    • fmgr_system_sdnconnector_routetable_route – Configure Azure route.
    • fmgr_system_smsserver – Configure SMS server for sending SMS messages to support user authentication.
    • fmgr_system_snmp_community – SNMP community configuration.
    • fmgr_system_snmp_community_hosts – Allow hosts configuration.
    • fmgr_system_snmp_community_hosts6 – Allow hosts configuration for IPv6.
    • fmgr_system_snmp_sysinfo – SNMP configuration.
    • fmgr_system_snmp_user – SNMP user configuration.
    • fmgr_system_sql – SQL settings.
    • fmgr_system_sql_customindex – List of SQL index fields.
    • fmgr_system_sql_tsindexfield – List of SQL text search index fields.
    • fmgr_system_syslog – Syslog servers.
    • fmgr_system_virtualwirepair – Configure virtual wire pairs.
    • fmgr_system_workflow_approvalmatrix – workflow approval matrix.
    • fmgr_system_workflow_approvalmatrix_approver – Approver.
    • fmgr_template
    • fmgr_templategroup
    • fmgr_user_adgrp – Configure FSSO groups.
    • fmgr_user_device – Configure devices.
    • fmgr_user_device_dynamicmapping
    • fmgr_user_device_tagging – Config object tagging.
    • fmgr_user_devicecategory – Configure device categories.
    • fmgr_user_devicegroup – Configure device groups.
    • fmgr_user_devicegroup_dynamicmapping
    • fmgr_user_devicegroup_tagging – Config object tagging.
    • fmgr_user_fortitoken – Configure FortiToken.
    • fmgr_user_fsso – Configure Fortinet Single Sign On (FSSO) agents.
    • fmgr_user_fsso_dynamicmapping
    • fmgr_user_fssopolling – Configure FSSO active directory servers for polling mode.
    • fmgr_user_fssopolling_adgrp – LDAP Group Info.
    • fmgr_user_group – Configure user groups.
    • fmgr_user_group_guest – Guest User.
    • fmgr_user_group_match – Group matches.
    • fmgr_user_ldap – Configure LDAP server entries.
    • fmgr_user_ldap_dynamicmapping
    • fmgr_user_local – Configure local users.
    • fmgr_user_passwordpolicy – Configure user password policy.
    • fmgr_user_peer – Configure peer users.
    • fmgr_user_peergrp – Configure peer groups.
    • fmgr_user_pop3 – POP3 server entry configuration.
    • fmgr_user_pxgrid
    • fmgr_user_radius – Configure RADIUS server entries.
    • fmgr_user_radius_accountingserver – Additional accounting servers.
    • fmgr_user_radius_dynamicmapping
    • fmgr_user_securityexemptlist – Configure security exemption list.
    • fmgr_user_securityexemptlist_rule – Configure rules for exempting users from captive portal authentication.
    • fmgr_user_tacacs – Configure TACACS+ server entries.
    • fmgr_user_tacacs_dynamicmapping
    • fmgr_vap – Configure Virtual Access Points (VAPs).
    • fmgr_vap_dynamicmapping
    • fmgr_vap_macfilterlist – Create a list of MAC addresses for MAC address filtering.
    • fmgr_vap_mpskkey – Pre-shared keys that can be used to connect to this virtual access point.
    • fmgr_vap_portalmessageoverrides – Individual message overrides.
    • fmgr_vap_vlanpool – VLAN pool.
    • fmgr_vapgroup – Configure virtual Access Point (VAP) groups.
    • fmgr_voip_profile – Configure VoIP profiles.
    • fmgr_voip_profile_sccp – SCCP.
    • fmgr_voip_profile_sip – SIP.
    • fmgr_vpn_certificate_ca – CA certificate.
    • fmgr_vpn_certificate_ocspserver – OCSP server configuration.
    • fmgr_vpn_certificate_remote – Remote certificate as a PEM file.
    • fmgr_vpnmgr_node – VPN node for VPN Manager.
    • fmgr_vpnmgr_node_iprange
    • fmgr_vpnmgr_node_ipv4excluderange
    • fmgr_vpnmgr_node_protectedsubnet
    • fmgr_vpnmgr_node_summaryaddr
    • fmgr_vpnmgr_vpntable
    • fmgr_vpnsslweb_hostchecksoftware – SSL-VPN host check software.
    • fmgr_vpnsslweb_hostchecksoftware_checkitemlist – Check item list.
    • fmgr_vpnsslweb_portal – Portal.
    • fmgr_vpnsslweb_portal_bookmarkgroup – Portal bookmark group.
    • fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks – Bookmark table.
    • fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks_formdata – Form data.
    • fmgr_vpnsslweb_portal_macaddrcheckrule – Client MAC address check rule.
    • fmgr_vpnsslweb_portal_oschecklist – SSL VPN OS checks.
    • fmgr_vpnsslweb_portal_splitdns – Split DNS for SSL VPN.
    • fmgr_vpnsslweb_realm – Realm.
    • fmgr_waf_mainclass – Hidden table for datasource.
    • fmgr_waf_profile – Web application firewall configuration.
    • fmgr_waf_profile_addresslist – Black address list and white address list.
    • fmgr_waf_profile_constraint – WAF HTTP protocol restrictions.
    • fmgr_waf_profile_constraint_contentlength – HTTP content length in request.
    • fmgr_waf_profile_constraint_exception – HTTP constraint exception.
    • fmgr_waf_profile_constraint_headerlength – HTTP header length in request.
    • fmgr_waf_profile_constraint_hostname – Enable/disable hostname check.
    • fmgr_waf_profile_constraint_linelength – HTTP line length in request.
    • fmgr_waf_profile_constraint_malformed – Enable/disable malformed HTTP request check.
    • fmgr_waf_profile_constraint_maxcookie – Maximum number of cookies in HTTP request.
    • fmgr_waf_profile_constraint_maxheaderline – Maximum number of HTTP header line.
    • fmgr_waf_profile_constraint_maxrangesegment – Maximum number of range segments in HTTP range line.
    • fmgr_waf_profile_constraint_maxurlparam – Maximum number of parameters in URL.
    • fmgr_waf_profile_constraint_method – Enable/disable HTTP method check.
    • fmgr_waf_profile_constraint_paramlength – Maximum length of parameter in URL, HTTP POST request or HTTP body.
    • fmgr_waf_profile_constraint_urlparamlength – Maximum length of parameter in URL.
    • fmgr_waf_profile_constraint_version – Enable/disable HTTP version check.
    • fmgr_waf_profile_method – Method restriction.
    • fmgr_waf_profile_method_methodpolicy – HTTP method policy.
    • fmgr_waf_profile_signature – WAF signatures.
    • fmgr_waf_profile_signature_customsignature – Custom signature.
    • fmgr_waf_profile_signature_mainclass – Main signature class.
    • fmgr_waf_profile_urlaccess – URL access list
    • fmgr_waf_profile_urlaccess_accesspattern – URL access pattern.
    • fmgr_waf_signature – Hidden table for datasource.
    • fmgr_waf_subclass – Hidden table for datasource.
    • fmgr_wanopt_authgroup – Configure WAN optimization authentication groups.
    • fmgr_wanopt_peer – Configure WAN optimization peers.
    • fmgr_wanopt_profile – Configure WAN optimization profiles.
    • fmgr_wanopt_profile_cifs – Enable/disable CIFS (Windows sharing) WAN Optimization and configure CIFS WAN Optimization features.
    • fmgr_wanopt_profile_ftp – Enable/disable FTP WAN Optimization and configure FTP WAN Optimization features.
    • fmgr_wanopt_profile_http – Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features.
    • fmgr_wanopt_profile_mapi – Enable/disable MAPI email WAN Optimization and configure MAPI WAN Optimization features.
    • fmgr_wanopt_profile_tcp – Enable/disable TCP WAN Optimization and configure TCP WAN Optimization features.
    • fmgr_wanprof_system_virtualwanlink – Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
    • fmgr_wanprof_system_virtualwanlink_healthcheck – SD-WAN status checking or health checking.
    • fmgr_wanprof_system_virtualwanlink_healthcheck_sla – Service level agreement (SLA).
    • fmgr_wanprof_system_virtualwanlink_members – Physical FortiGate interfaces added to the virtual-wan-link.
    • fmgr_wanprof_system_virtualwanlink_service – Create SD-WAN rules or priority rules (also called services) to control how sessions are distributed to physical interfaces in the SD-WAN.
    • fmgr_wanprof_system_virtualwanlink_service_sla – Service level agreement (SLA).
    • fmgr_webfilter_categories
    • fmgr_webfilter_content – Configure Web filter banned word table.
    • fmgr_webfilter_content_entries – Configure banned word entries.
    • fmgr_webfilter_contentheader – Configure content types used by Web filter.
    • fmgr_webfilter_contentheader_entries – Configure content types used by web filter.
    • fmgr_webfilter_ftgdlocalcat – Configure FortiGuard Web Filter local categories.
    • fmgr_webfilter_ftgdlocalrating – Configure local FortiGuard Web Filter local ratings.
    • fmgr_webfilter_profile – Configure Web filter profiles.
    • fmgr_webfilter_profile_ftgdwf – FortiGuard Web Filter settings.
    • fmgr_webfilter_profile_ftgdwf_filters – FortiGuard filters.
    • fmgr_webfilter_profile_ftgdwf_quota – FortiGuard traffic quota settings.
    • fmgr_webfilter_profile_override – Web Filter override settings.
    • fmgr_webfilter_profile_urlextraction – Configure URL Extraction
    • fmgr_webfilter_profile_web – Web content filtering settings.
    • fmgr_webfilter_profile_youtubechannelfilter – YouTube channel filter.
    • fmgr_webfilter_urlfilter – Configure URL filter lists.
    • fmgr_webfilter_urlfilter_entries – URL filter entries.
    • fmgr_webproxy_forwardserver – Configure forward-server addresses.
    • fmgr_webproxy_forwardservergroup – Configure a forward server group consisting or multiple forward servers.
    • fmgr_webproxy_forwardservergroup_serverlist – Add web forward servers to a list to form a server group.
    • fmgr_webproxy_profile – Configure web proxy profiles.
    • fmgr_webproxy_profile_headers – Configure HTTP forwarded requests headers.
    • fmgr_webproxy_wisp – Configure Wireless Internet service provider (WISP) servers.
    • fmgr_widsprofile – Configure wireless intrusion detection system (WIDS) profiles.
    • fmgr_wtpprofile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
    • fmgr_wtpprofile_denymaclist – List of MAC addresses that are denied access to this WTP, FortiAP, or AP.
    • fmgr_wtpprofile_lan – WTP LAN port mapping.
    • fmgr_wtpprofile_lbs – Set various location based service (LBS) options.
    • fmgr_wtpprofile_platform – WTP, FortiAP, or AP platform.
    • fmgr_wtpprofile_radio1 – Configuration options for radio 1.
    • fmgr_wtpprofile_radio2 – Configuration options for radio 2.
    • fmgr_wtpprofile_splittunnelingacl – Split tunneling ACL filter list.
  • Facts Gathering Modules
  • Object Manipulating Modules
  • Daemon Modules
  • Generic Modules

APPENDICES

  • Release Notes
Fortinet FortiManager Ansible Collection
  • Docs »
  • Object Oriented Modules »
  • fmgr_pkg_footer_policy
  • Edit on GitHub

fmgr_pkg_footer_policy¶

New in version 2.10.

  • Synopsis
  • Requirements
  • Parameters
  • Notes
  • Examples
  • Return Values
  • Status
  • Authors

Synopsis¶

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.
  • Tested with FortiManager v6.0.0.

Requirements¶

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

  • ansible>=2.9.0

Parameters¶

  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • pkg - The parameter in requested url type: str required: true
  • pkg_footer_policy - no description type: dict
    • action - No description for the parameter type: str choices: [deny, accept, ipsec, ssl-vpn]
    • active-auth-method - No description for the parameter type: str choices: [ntlm, basic, digest, form]
    • anti-replay - No description for the parameter type: str choices: [disable, enable]
    • app-category - No description for the parameter type: str
    • app-group - No description for the parameter type: str
    • application - No description for the parameter type: int
    • application-charts - No description for the parameter type: array choices: [top10-app, top10-p2p-user, top10-media-user]
    • application-list - No description for the parameter type: str
    • auth-cert - No description for the parameter type: str
    • auth-method - No description for the parameter type: str choices: [basic, digest, ntlm, fsae, form, fsso, rsso]
    • auth-path - No description for the parameter type: str choices: [disable, enable]
    • auth-portal - No description for the parameter type: str choices: [disable, enable]
    • auth-redirect-addr - No description for the parameter type: str
    • auto-asic-offload - No description for the parameter type: str choices: [disable, enable]
    • av-profile - No description for the parameter type: str
    • bandwidth - No description for the parameter type: str choices: [disable, enable]
    • block-notification - No description for the parameter type: str choices: [disable, enable]
    • captive-portal-exempt - No description for the parameter type: str choices: [disable, enable]
    • capture-packet - No description for the parameter type: str choices: [disable, enable]
    • casi-profile - No description for the parameter type: str
    • central-nat - No description for the parameter type: str choices: [disable, enable]
    • cifs-profile - No description for the parameter type: str
    • client-reputation - No description for the parameter type: str choices: [disable, enable]
    • client-reputation-mode - No description for the parameter type: str choices: [learning, monitoring]
    • comments - No description for the parameter type: str
    • custom-log-fields - No description for the parameter type: str
    • deep-inspection-options - No description for the parameter type: str
    • delay-tcp-npu-session - No description for the parameter type: str choices: [disable, enable]
    • delay-tcp-npu-sessoin - No description for the parameter type: str choices: [disable, enable]
    • device-detection-portal - No description for the parameter type: str choices: [disable, enable]
    • devices - No description for the parameter type: str
    • diffserv-forward - No description for the parameter type: str choices: [disable, enable]
    • diffserv-reverse - No description for the parameter type: str choices: [disable, enable]
    • diffservcode-forward - No description for the parameter type: str
    • diffservcode-rev - No description for the parameter type: str
    • disclaimer - No description for the parameter type: str choices: [disable, enable]
    • dlp-sensor - No description for the parameter type: str
    • dnsfilter-profile - No description for the parameter type: str
    • dponly - No description for the parameter type: str choices: [disable, enable]
    • dscp-match - No description for the parameter type: str choices: [disable, enable]
    • dscp-negate - No description for the parameter type: str choices: [disable, enable]
    • dscp-value - No description for the parameter type: str
    • dsri - No description for the parameter type: str choices: [disable, enable]
    • dstaddr - No description for the parameter type: str
    • dstaddr-negate - No description for the parameter type: str choices: [disable, enable]
    • dstaddr6 - No description for the parameter type: str
    • dstintf - No description for the parameter type: str
    • dynamic-profile - No description for the parameter type: str choices: [disable, enable]
    • dynamic-profile-access - No description for the parameter type: array choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, ftps, ssh]
    • dynamic-profile-fallthrough - No description for the parameter type: str choices: [disable, enable]
    • dynamic-profile-group - No description for the parameter type: str
    • email-collect - No description for the parameter type: str choices: [disable, enable]
    • email-collection-portal - No description for the parameter type: str choices: [disable, enable]
    • emailfilter-profile - No description for the parameter type: str
    • endpoint-check - No description for the parameter type: str choices: [disable, enable]
    • endpoint-compliance - No description for the parameter type: str choices: [disable, enable]
    • endpoint-keepalive-interface - No description for the parameter type: str
    • endpoint-profile - No description for the parameter type: str
    • failed-connection - No description for the parameter type: str choices: [disable, enable]
    • fall-through-unauthenticated - No description for the parameter type: str choices: [disable, enable]
    • firewall-session-dirty - No description for the parameter type: str choices: [check-all, check-new]
    • fixedport - No description for the parameter type: str choices: [disable, enable]
    • forticlient-compliance-devices - No description for the parameter type: array choices: [windows-pc, mac, iphone-ipad, android]
    • forticlient-compliance-enforcement-portal - No description for the parameter type: str choices: [disable, enable]
    • fsae - No description for the parameter type: str choices: [disable, enable]
    • fsae-server-for-ntlm - No description for the parameter type: str
    • fsso - No description for the parameter type: str choices: [disable, enable]
    • fsso-agent-for-ntlm - No description for the parameter type: str
    • geo-location - No description for the parameter type: str choices: [disable, enable]
    • geoip-anycast - No description for the parameter type: str choices: [disable, enable]
    • global-label - No description for the parameter type: str
    • groups - No description for the parameter type: str
    • gtp-profile - No description for the parameter type: str
    • http-policy-redirect - No description for the parameter type: str choices: [disable, enable]
    • icap-profile - No description for the parameter type: str
    • identity-based - No description for the parameter type: str choices: [disable, enable]
    • identity-based-policy - No description for the parameter type: array
      • action - No description for the parameter type: str choices: [deny, accept]
      • application-charts - No description for the parameter type: array choices: [top10-app, top10-p2p-user, top10-media-user]
      • application-list - No description for the parameter type: str
      • av-profile - No description for the parameter type: str
      • capture-packet - No description for the parameter type: str choices: [disable, enable]
      • deep-inspection-options - No description for the parameter type: str
      • devices - No description for the parameter type: str
      • dlp-sensor - No description for the parameter type: str
      • dstaddr - No description for the parameter type: str
      • dstaddr-negate - No description for the parameter type: str choices: [disable, enable]
      • endpoint-compliance - No description for the parameter type: str choices: [disable, enable]
      • groups - No description for the parameter type: str
      • icap-profile - No description for the parameter type: str
      • id - No description for the parameter type: int
      • ips-sensor - No description for the parameter type: str
      • logtraffic - No description for the parameter type: str choices: [disable, enable, all, utm]
      • logtraffic-app - No description for the parameter type: str choices: [disable, enable]
      • logtraffic-start - No description for the parameter type: str choices: [disable, enable]
      • mms-profile - No description for the parameter type: str
      • per-ip-shaper - No description for the parameter type: str
      • profile-group - No description for the parameter type: str
      • profile-protocol-options - No description for the parameter type: str
      • profile-type - No description for the parameter type: str choices: [single, group]
      • replacemsg-group - No description for the parameter type: str
      • schedule - No description for the parameter type: str
      • send-deny-packet - No description for the parameter type: str choices: [disable, enable]
      • service - No description for the parameter type: str
      • service-negate - No description for the parameter type: str choices: [disable, enable]
      • spamfilter-profile - No description for the parameter type: str
      • sslvpn-portal - No description for the parameter type: str
      • sslvpn-realm - No description for the parameter type: str
      • traffic-shaper - No description for the parameter type: str
      • traffic-shaper-reverse - No description for the parameter type: str
      • users - No description for the parameter type: str
      • utm-status - No description for the parameter type: str choices: [disable, enable]
      • voip-profile - No description for the parameter type: str
      • webfilter-profile - No description for the parameter type: str
    • identity-based-route - No description for the parameter type: str
    • identity-from - No description for the parameter type: str choices: [auth, device]
    • inbound - No description for the parameter type: str choices: [disable, enable]
    • inspection-mode - No description for the parameter type: str choices: [proxy, flow]
    • internet-service - No description for the parameter type: str choices: [disable, enable]
    • internet-service-custom - No description for the parameter type: str
    • internet-service-custom-group - No description for the parameter type: str
    • internet-service-group - No description for the parameter type: str
    • internet-service-id - No description for the parameter type: str
    • internet-service-negate - No description for the parameter type: str choices: [disable, enable]
    • internet-service-src - No description for the parameter type: str choices: [disable, enable]
    • internet-service-src-custom - No description for the parameter type: str
    • internet-service-src-custom-group - No description for the parameter type: str
    • internet-service-src-group - No description for the parameter type: str
    • internet-service-src-id - No description for the parameter type: str
    • internet-service-src-negate - No description for the parameter type: str choices: [disable, enable]
    • ip-based - No description for the parameter type: str choices: [disable, enable]
    • ippool - No description for the parameter type: str choices: [disable, enable]
    • ips-sensor - No description for the parameter type: str
    • label - No description for the parameter type: str
    • learning-mode - No description for the parameter type: str choices: [disable, enable]
    • log-unmatched-traffic - No description for the parameter type: str choices: [disable, enable]
    • logtraffic - No description for the parameter type: str choices: [disable, enable, all, utm]
    • logtraffic-app - No description for the parameter type: str choices: [disable, enable]
    • logtraffic-start - No description for the parameter type: str choices: [disable, enable]
    • match-vip - No description for the parameter type: str choices: [disable, enable]
    • mms-profile - No description for the parameter type: str
    • name - No description for the parameter type: str
    • nat - No description for the parameter type: str choices: [disable, enable]
    • natinbound - No description for the parameter type: str choices: [disable, enable]
    • natip - No description for the parameter type: str
    • natoutbound - No description for the parameter type: str choices: [disable, enable]
    • np-acceleration - No description for the parameter type: str choices: [disable, enable]
    • ntlm - No description for the parameter type: str choices: [disable, enable]
    • ntlm-enabled-browsers - No description for the parameter type: str
    • ntlm-guest - No description for the parameter type: str choices: [disable, enable]
    • outbound - No description for the parameter type: str choices: [disable, enable]
    • per-ip-shaper - No description for the parameter type: str
    • permit-any-host - No description for the parameter type: str choices: [disable, enable]
    • permit-stun-host - No description for the parameter type: str choices: [disable, enable]
    • policyid - No description for the parameter type: int
    • poolname - No description for the parameter type: str
    • profile-group - No description for the parameter type: str
    • profile-protocol-options - No description for the parameter type: str
    • profile-type - No description for the parameter type: str choices: [single, group]
    • radius-mac-auth-bypass - No description for the parameter type: str choices: [disable, enable]
    • redirect-url - No description for the parameter type: str
    • replacemsg-group - No description for the parameter type: str
    • replacemsg-override-group - No description for the parameter type: str
    • reputation-direction - No description for the parameter type: str choices: [source, destination]
    • reputation-minimum - No description for the parameter type: int
    • require-tfa - No description for the parameter type: str choices: [disable, enable]
    • rsso - No description for the parameter type: str choices: [disable, enable]
    • rtp-addr - No description for the parameter type: str
    • rtp-nat - No description for the parameter type: str choices: [disable, enable]
    • scan-botnet-connections - No description for the parameter type: str choices: [disable, block, monitor]
    • schedule - No description for the parameter type: str
    • schedule-timeout - No description for the parameter type: str choices: [disable, enable]
    • send-deny-packet - No description for the parameter type: str choices: [disable, enable]
    • service - No description for the parameter type: str
    • service-negate - No description for the parameter type: str choices: [disable, enable]
    • session-ttl - No description for the parameter type: int
    • sessions - No description for the parameter type: str choices: [disable, enable]
    • spamfilter-profile - No description for the parameter type: str
    • srcaddr - No description for the parameter type: str
    • srcaddr-negate - No description for the parameter type: str choices: [disable, enable]
    • srcaddr6 - No description for the parameter type: str
    • srcintf - No description for the parameter type: str
    • ssh-filter-profile - No description for the parameter type: str
    • ssh-policy-redirect - No description for the parameter type: str choices: [disable, enable]
    • ssl-mirror - No description for the parameter type: str choices: [disable, enable]
    • ssl-mirror-intf - No description for the parameter type: str
    • ssl-ssh-profile - No description for the parameter type: str
    • sslvpn-auth - No description for the parameter type: str choices: [any, local, radius, ldap, tacacs+]
    • sslvpn-ccert - No description for the parameter type: str choices: [disable, enable]
    • sslvpn-cipher - No description for the parameter type: str choices: [any, high, medium]
    • sso-auth-method - No description for the parameter type: str choices: [fsso, rsso]
    • status - No description for the parameter type: str choices: [disable, enable]
    • tags - No description for the parameter type: str
    • tcp-mss-receiver - No description for the parameter type: int
    • tcp-mss-sender - No description for the parameter type: int
    • tcp-reset - No description for the parameter type: str choices: [disable, enable]
    • tcp-session-without-syn - No description for the parameter type: str choices: [all, data-only, disable]
    • timeout-send-rst - No description for the parameter type: str choices: [disable, enable]
    • tos - No description for the parameter type: str
    • tos-mask - No description for the parameter type: str
    • tos-negate - No description for the parameter type: str choices: [disable, enable]
    • traffic-shaper - No description for the parameter type: str
    • traffic-shaper-reverse - No description for the parameter type: str
    • transaction-based - No description for the parameter type: str choices: [disable, enable]
    • url-category - No description for the parameter type: str
    • users - No description for the parameter type: str
    • utm-inspection-mode - No description for the parameter type: str choices: [proxy, flow]
    • utm-status - No description for the parameter type: str choices: [disable, enable]
    • uuid - No description for the parameter type: str
    • vlan-cos-fwd - No description for the parameter type: int
    • vlan-cos-rev - No description for the parameter type: int
    • vlan-filter - No description for the parameter type: str
    • voip-profile - No description for the parameter type: str
    • vpntunnel - No description for the parameter type: str
    • waf-profile - No description for the parameter type: str
    • wanopt - No description for the parameter type: str choices: [disable, enable]
    • wanopt-detection - No description for the parameter type: str choices: [active, passive, off]
    • wanopt-passive-opt - No description for the parameter type: str choices: [default, transparent, non-transparent]
    • wanopt-peer - No description for the parameter type: str
    • wanopt-profile - No description for the parameter type: str
    • wccp - No description for the parameter type: str choices: [disable, enable]
    • web-auth-cookie - No description for the parameter type: str choices: [disable, enable]
    • webcache - No description for the parameter type: str choices: [disable, enable]
    • webcache-https - No description for the parameter type: str choices: [disable, ssl-server, any, enable]
    • webfilter-profile - No description for the parameter type: str
    • webproxy-forward-server - No description for the parameter type: str
    • webproxy-profile - No description for the parameter type: str
    • wsso - No description for the parameter type: str choices: [disable, enable]

Notes¶

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples¶

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_pkg_footer_policy:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        pkg: <your own value>
        state: <value in [present, absent]>
        pkg_footer_policy:
           action: <value in [deny, accept, ipsec, ...]>
           active-auth-method: <value in [ntlm, basic, digest, ...]>
           anti-replay: <value in [disable, enable]>
           app-category: <value of string>
           app-group: <value of string>
           application: <value of integer>
           application-charts:
             - top10-app
             - top10-p2p-user
             - top10-media-user
           application-list: <value of string>
           auth-cert: <value of string>
           auth-method: <value in [basic, digest, ntlm, ...]>
           auth-path: <value in [disable, enable]>
           auth-portal: <value in [disable, enable]>
           auth-redirect-addr: <value of string>
           auto-asic-offload: <value in [disable, enable]>
           av-profile: <value of string>
           bandwidth: <value in [disable, enable]>
           block-notification: <value in [disable, enable]>
           captive-portal-exempt: <value in [disable, enable]>
           capture-packet: <value in [disable, enable]>
           casi-profile: <value of string>
           central-nat: <value in [disable, enable]>
           cifs-profile: <value of string>
           client-reputation: <value in [disable, enable]>
           client-reputation-mode: <value in [learning, monitoring]>
           comments: <value of string>
           custom-log-fields: <value of string>
           deep-inspection-options: <value of string>
           delay-tcp-npu-session: <value in [disable, enable]>
           delay-tcp-npu-sessoin: <value in [disable, enable]>
           device-detection-portal: <value in [disable, enable]>
           devices: <value of string>
           diffserv-forward: <value in [disable, enable]>
           diffserv-reverse: <value in [disable, enable]>
           diffservcode-forward: <value of string>
           diffservcode-rev: <value of string>
           disclaimer: <value in [disable, enable]>
           dlp-sensor: <value of string>
           dnsfilter-profile: <value of string>
           dponly: <value in [disable, enable]>
           dscp-match: <value in [disable, enable]>
           dscp-negate: <value in [disable, enable]>
           dscp-value: <value of string>
           dsri: <value in [disable, enable]>
           dstaddr: <value of string>
           dstaddr-negate: <value in [disable, enable]>
           dstaddr6: <value of string>
           dstintf: <value of string>
           dynamic-profile: <value in [disable, enable]>
           dynamic-profile-access:
             - imap
             - smtp
             - pop3
             - http
             - ftp
             - im
             - nntp
             - imaps
             - smtps
             - pop3s
             - https
             - ftps
             - ssh
           dynamic-profile-fallthrough: <value in [disable, enable]>
           dynamic-profile-group: <value of string>
           email-collect: <value in [disable, enable]>
           email-collection-portal: <value in [disable, enable]>
           emailfilter-profile: <value of string>
           endpoint-check: <value in [disable, enable]>
           endpoint-compliance: <value in [disable, enable]>
           endpoint-keepalive-interface: <value of string>
           endpoint-profile: <value of string>
           failed-connection: <value in [disable, enable]>
           fall-through-unauthenticated: <value in [disable, enable]>
           firewall-session-dirty: <value in [check-all, check-new]>
           fixedport: <value in [disable, enable]>
           forticlient-compliance-devices:
             - windows-pc
             - mac
             - iphone-ipad
             - android
           forticlient-compliance-enforcement-portal: <value in [disable, enable]>
           fsae: <value in [disable, enable]>
           fsae-server-for-ntlm: <value of string>
           fsso: <value in [disable, enable]>
           fsso-agent-for-ntlm: <value of string>
           geo-location: <value in [disable, enable]>
           geoip-anycast: <value in [disable, enable]>
           global-label: <value of string>
           groups: <value of string>
           gtp-profile: <value of string>
           http-policy-redirect: <value in [disable, enable]>
           icap-profile: <value of string>
           identity-based: <value in [disable, enable]>
           identity-based-policy:
             -
                 action: <value in [deny, accept]>
                 application-charts:
                   - top10-app
                   - top10-p2p-user
                   - top10-media-user
                 application-list: <value of string>
                 av-profile: <value of string>
                 capture-packet: <value in [disable, enable]>
                 deep-inspection-options: <value of string>
                 devices: <value of string>
                 dlp-sensor: <value of string>
                 dstaddr: <value of string>
                 dstaddr-negate: <value in [disable, enable]>
                 endpoint-compliance: <value in [disable, enable]>
                 groups: <value of string>
                 icap-profile: <value of string>
                 id: <value of integer>
                 ips-sensor: <value of string>
                 logtraffic: <value in [disable, enable, all, ...]>
                 logtraffic-app: <value in [disable, enable]>
                 logtraffic-start: <value in [disable, enable]>
                 mms-profile: <value of string>
                 per-ip-shaper: <value of string>
                 profile-group: <value of string>
                 profile-protocol-options: <value of string>
                 profile-type: <value in [single, group]>
                 replacemsg-group: <value of string>
                 schedule: <value of string>
                 send-deny-packet: <value in [disable, enable]>
                 service: <value of string>
                 service-negate: <value in [disable, enable]>
                 spamfilter-profile: <value of string>
                 sslvpn-portal: <value of string>
                 sslvpn-realm: <value of string>
                 traffic-shaper: <value of string>
                 traffic-shaper-reverse: <value of string>
                 users: <value of string>
                 utm-status: <value in [disable, enable]>
                 voip-profile: <value of string>
                 webfilter-profile: <value of string>
           identity-based-route: <value of string>
           identity-from: <value in [auth, device]>
           inbound: <value in [disable, enable]>
           inspection-mode: <value in [proxy, flow]>
           internet-service: <value in [disable, enable]>
           internet-service-custom: <value of string>
           internet-service-custom-group: <value of string>
           internet-service-group: <value of string>
           internet-service-id: <value of string>
           internet-service-negate: <value in [disable, enable]>
           internet-service-src: <value in [disable, enable]>
           internet-service-src-custom: <value of string>
           internet-service-src-custom-group: <value of string>
           internet-service-src-group: <value of string>
           internet-service-src-id: <value of string>
           internet-service-src-negate: <value in [disable, enable]>
           ip-based: <value in [disable, enable]>
           ippool: <value in [disable, enable]>
           ips-sensor: <value of string>
           label: <value of string>
           learning-mode: <value in [disable, enable]>
           log-unmatched-traffic: <value in [disable, enable]>
           logtraffic: <value in [disable, enable, all, ...]>
           logtraffic-app: <value in [disable, enable]>
           logtraffic-start: <value in [disable, enable]>
           match-vip: <value in [disable, enable]>
           mms-profile: <value of string>
           name: <value of string>
           nat: <value in [disable, enable]>
           natinbound: <value in [disable, enable]>
           natip: <value of string>
           natoutbound: <value in [disable, enable]>
           np-acceleration: <value in [disable, enable]>
           ntlm: <value in [disable, enable]>
           ntlm-enabled-browsers: <value of string>
           ntlm-guest: <value in [disable, enable]>
           outbound: <value in [disable, enable]>
           per-ip-shaper: <value of string>
           permit-any-host: <value in [disable, enable]>
           permit-stun-host: <value in [disable, enable]>
           policyid: <value of integer>
           poolname: <value of string>
           profile-group: <value of string>
           profile-protocol-options: <value of string>
           profile-type: <value in [single, group]>
           radius-mac-auth-bypass: <value in [disable, enable]>
           redirect-url: <value of string>
           replacemsg-group: <value of string>
           replacemsg-override-group: <value of string>
           reputation-direction: <value in [source, destination]>
           reputation-minimum: <value of integer>
           require-tfa: <value in [disable, enable]>
           rsso: <value in [disable, enable]>
           rtp-addr: <value of string>
           rtp-nat: <value in [disable, enable]>
           scan-botnet-connections: <value in [disable, block, monitor]>
           schedule: <value of string>
           schedule-timeout: <value in [disable, enable]>
           send-deny-packet: <value in [disable, enable]>
           service: <value of string>
           service-negate: <value in [disable, enable]>
           session-ttl: <value of integer>
           sessions: <value in [disable, enable]>
           spamfilter-profile: <value of string>
           srcaddr: <value of string>
           srcaddr-negate: <value in [disable, enable]>
           srcaddr6: <value of string>
           srcintf: <value of string>
           ssh-filter-profile: <value of string>
           ssh-policy-redirect: <value in [disable, enable]>
           ssl-mirror: <value in [disable, enable]>
           ssl-mirror-intf: <value of string>
           ssl-ssh-profile: <value of string>
           sslvpn-auth: <value in [any, local, radius, ...]>
           sslvpn-ccert: <value in [disable, enable]>
           sslvpn-cipher: <value in [any, high, medium]>
           sso-auth-method: <value in [fsso, rsso]>
           status: <value in [disable, enable]>
           tags: <value of string>
           tcp-mss-receiver: <value of integer>
           tcp-mss-sender: <value of integer>
           tcp-reset: <value in [disable, enable]>
           tcp-session-without-syn: <value in [all, data-only, disable]>
           timeout-send-rst: <value in [disable, enable]>
           tos: <value of string>
           tos-mask: <value of string>
           tos-negate: <value in [disable, enable]>
           traffic-shaper: <value of string>
           traffic-shaper-reverse: <value of string>
           transaction-based: <value in [disable, enable]>
           url-category: <value of string>
           users: <value of string>
           utm-inspection-mode: <value in [proxy, flow]>
           utm-status: <value in [disable, enable]>
           uuid: <value of string>
           vlan-cos-fwd: <value of integer>
           vlan-cos-rev: <value of integer>
           vlan-filter: <value of string>
           voip-profile: <value of string>
           vpntunnel: <value of string>
           waf-profile: <value of string>
           wanopt: <value in [disable, enable]>
           wanopt-detection: <value in [active, passive, off]>
           wanopt-passive-opt: <value in [default, transparent, non-transparent]>
           wanopt-peer: <value of string>
           wanopt-profile: <value of string>
           wccp: <value in [disable, enable]>
           web-auth-cookie: <value in [disable, enable]>
           webcache: <value in [disable, enable]>
           webcache-https: <value in [disable, ssl-server, any, ...]>
           webfilter-profile: <value of string>
           webproxy-forward-server: <value of string>
           webproxy-profile: <value of string>
           wsso: <value in [disable, enable]>

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:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status¶

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

Authors¶

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

Hint

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

Next Previous

© Copyright 2020, Fortinet Revision 7f923afc.

Built with Sphinx using a theme provided by Read the Docs.