drmofu.fortimanager.fmgr_fact (2.2.2) — module

Gather fortimanager facts.

| "added in version" 2.0.0 of drmofu.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2


Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: gathering fortimanager facts
  hosts: fortimanager01
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
    - name: retrieve all the scripts
      fmgr_fact:
        facts:
          selector: "dvmdb_script"
          params:
            adom: "root"
            script: ""

    - name: retrive all the interfaces
      fmgr_fact:
        facts:
          selector: "system_interface"
          params:
            interface: ""
    - name: retrieve the interface port1
      fmgr_fact:
        facts:
          selector: "system_interface"
          params:
            interface: "port1"
    - name: fetch urlfilter with name urlfilter4
      fmgr_fact:
        facts:
          selector: "webfilter_urlfilter"
          params:
            adom: "root"
            urlfilter: ""
          filter:
            - - "name"
              - "=="
              - "urlfilter4"
          fields:
            - "id"
            - "name"
            - "comment"
          sortings:
            - "id": 1
              "name": -1
    - name: Retrieve device
      fmgr_fact:
        facts:
          selector: "dvmdb_device"
          params:
            adom: "root"
            device: ""
          option:
            - "get meta"

Inputs

    
facts:
    description: Gathering fortimanager facts.
    required: true
    suboptions:
      fields:
        description: Field filtering expression list.
        elements: str
        required: false
        type: list
      filter:
        description: Item filtering expression list.
        elements: str
        required: false
        type: list
      option:
        description: Option list. See more details in FNDN API documents.
        elements: str
        required: false
        type: list
      params:
        description: The specific parameters for each different selector.
        required: false
        type: dict
      selector:
        choices:
        - adom_options
        - antivirus_mmschecksum
        - antivirus_mmschecksum_entries
        - antivirus_notification
        - antivirus_notification_entries
        - antivirus_profile
        - antivirus_profile_cifs
        - antivirus_profile_contentdisarm
        - antivirus_profile_ftp
        - antivirus_profile_http
        - antivirus_profile_imap
        - antivirus_profile_mapi
        - antivirus_profile_nacquar
        - antivirus_profile_nntp
        - antivirus_profile_outbreakprevention
        - antivirus_profile_pop3
        - antivirus_profile_smb
        - antivirus_profile_smtp
        - antivirus_profile_ssh
        - apcfgprofile
        - apcfgprofile_commandlist
        - application_casi_profile
        - application_casi_profile_entries
        - application_categories
        - application_custom
        - application_group
        - application_internetservice
        - application_internetservice_entry
        - application_internetservicecustom
        - application_internetservicecustom_disableentry
        - application_internetservicecustom_disableentry_iprange
        - application_internetservicecustom_entry
        - application_internetservicecustom_entry_portrange
        - application_list
        - application_list_defaultnetworkservices
        - application_list_entries
        - application_list_entries_parameters
        - application_list_entries_parameters_members
        - arrpprofile
        - authentication_scheme
        - bleprofile
        - bonjourprofile
        - bonjourprofile_policylist
        - certificate_template
        - cifs_domaincontroller
        - cifs_profile
        - cifs_profile_filefilter
        - cifs_profile_filefilter_entries
        - cifs_profile_serverkeytab
        - cloud_orchestaws
        - cloud_orchestawsconnector
        - cloud_orchestawstemplate_autoscaleexistingvpc
        - cloud_orchestawstemplate_autoscalenewvpc
        - cloud_orchestawstemplate_autoscaletgwnewvpc
        - cloud_orchestration
        - credentialstore_domaincontroller
        - devprof_device_profile_fortianalyzer
        - devprof_device_profile_fortiguard
        - devprof_log_fortianalyzer_setting
        - devprof_log_fortianalyzercloud_setting
        - devprof_log_syslogd_filter
        - devprof_log_syslogd_filter_excludelist
        - devprof_log_syslogd_filter_excludelist_fields
        - devprof_log_syslogd_filter_freestyle
        - devprof_log_syslogd_setting
        - devprof_log_syslogd_setting_customfieldname
        - devprof_system_centralmanagement
        - devprof_system_centralmanagement_serverlist
        - devprof_system_dns
        - devprof_system_emailserver
        - devprof_system_global
        - devprof_system_ntp
        - devprof_system_ntp_ntpserver
        - devprof_system_replacemsg_admin
        - devprof_system_replacemsg_alertmail
        - devprof_system_replacemsg_auth
        - devprof_system_replacemsg_devicedetectionportal
        - devprof_system_replacemsg_ec
        - devprof_system_replacemsg_fortiguardwf
        - devprof_system_replacemsg_ftp
        - devprof_system_replacemsg_http
        - devprof_system_replacemsg_mail
        - devprof_system_replacemsg_mms
        - devprof_system_replacemsg_nacquar
        - devprof_system_replacemsg_nntp
        - devprof_system_replacemsg_spam
        - devprof_system_replacemsg_sslvpn
        - devprof_system_replacemsg_trafficquota
        - devprof_system_replacemsg_utm
        - devprof_system_replacemsg_webproxy
        - devprof_system_snmp_community
        - devprof_system_snmp_community_hosts
        - devprof_system_snmp_community_hosts6
        - devprof_system_snmp_sysinfo
        - devprof_system_snmp_user
        - dlp_datatype
        - dlp_dictionary
        - dlp_dictionary_entries
        - dlp_filepattern
        - dlp_filepattern_entries
        - dlp_fpsensitivity
        - dlp_profile
        - dlp_profile_rule
        - dlp_sensitivity
        - dlp_sensor
        - dlp_sensor_entries
        - dlp_sensor_filter
        - dnsfilter_domainfilter
        - dnsfilter_domainfilter_entries
        - dnsfilter_profile
        - dnsfilter_profile_dnstranslation
        - dnsfilter_profile_domainfilter
        - dnsfilter_profile_ftgddns
        - dnsfilter_profile_ftgddns_filters
        - dnsfilter_profile_urlfilter
        - dnsfilter_urlfilter
        - dnsfilter_urlfilter_entries
        - dvmdb_adom
        - dvmdb_device
        - dvmdb_device_haslave
        - dvmdb_device_vdom
        - dvmdb_folder
        - dvmdb_group
        - dvmdb_metafields_adom
        - dvmdb_metafields_device
        - dvmdb_metafields_group
        - dvmdb_revision
        - dvmdb_script
        - dvmdb_script_log_latest
        - dvmdb_script_log_latest_device
        - dvmdb_script_log_list
        - dvmdb_script_log_list_device
        - dvmdb_script_log_output_device_logid
        - dvmdb_script_log_output_logid
        - dvmdb_script_log_summary
        - dvmdb_script_log_summary_device
        - dvmdb_script_scriptschedule
        - dvmdb_workflow
        - dvmdb_workflow_wflog
        - dvmdb_workspace_dirty
        - dvmdb_workspace_dirty_dev
        - dvmdb_workspace_lockinfo
        - dvmdb_workspace_lockinfo_dev
        - dvmdb_workspace_lockinfo_obj
        - dvmdb_workspace_lockinfo_pkg
        - dynamic_address
        - dynamic_address_dynamicaddrmapping
        - dynamic_certificate_local
        - dynamic_certificate_local_dynamicmapping
        - dynamic_input_interface
        - dynamic_input_interface_dynamicmapping
        - dynamic_interface
        - dynamic_interface_dynamicmapping
        - dynamic_interface_platformmapping
        - dynamic_ippool
        - dynamic_multicast_interface
        - dynamic_multicast_interface_dynamicmapping
        - dynamic_vip
        - dynamic_virtualwanlink_members
        - dynamic_virtualwanlink_members_dynamicmapping
        - dynamic_virtualwanlink_neighbor
        - dynamic_virtualwanlink_neighbor_dynamicmapping
        - dynamic_virtualwanlink_server
        - dynamic_virtualwanlink_server_dynamicmapping
        - dynamic_vpntunnel
        - dynamic_vpntunnel_dynamicmapping
        - emailfilter_blockallowlist
        - emailfilter_blockallowlist_entries
        - emailfilter_bwl
        - emailfilter_bwl_entries
        - emailfilter_bword
        - emailfilter_bword_entries
        - emailfilter_dnsbl
        - emailfilter_dnsbl_entries
        - emailfilter_fortishield
        - emailfilter_iptrust
        - emailfilter_iptrust_entries
        - emailfilter_mheader
        - emailfilter_mheader_entries
        - emailfilter_options
        - emailfilter_profile
        - emailfilter_profile_filefilter
        - emailfilter_profile_filefilter_entries
        - emailfilter_profile_gmail
        - emailfilter_profile_imap
        - emailfilter_profile_mapi
        - emailfilter_profile_msnhotmail
        - emailfilter_profile_otherwebmails
        - emailfilter_profile_pop3
        - emailfilter_profile_smtp
        - emailfilter_profile_yahoomail
        - endpointcontrol_fctems
        - extendercontroller_dataplan
        - extendercontroller_extenderprofile
        - extendercontroller_extenderprofile_cellular
        - extendercontroller_extenderprofile_cellular_controllerreport
        - extendercontroller_extenderprofile_cellular_modem1
        - extendercontroller_extenderprofile_cellular_modem1_autoswitch
        - extendercontroller_extenderprofile_cellular_modem2
        - extendercontroller_extenderprofile_cellular_modem2_autoswitch
        - extendercontroller_extenderprofile_cellular_smsnotification
        - extendercontroller_extenderprofile_cellular_smsnotification_alert
        - extendercontroller_extenderprofile_cellular_smsnotification_receiver
        - extendercontroller_extenderprofile_lanextension
        - extendercontroller_extenderprofile_lanextension_backhaul
        - extendercontroller_simprofile
        - extendercontroller_simprofile_autoswitchprofile
        - extendercontroller_template
        - extensioncontroller_dataplan
        - extensioncontroller_extenderprofile
        - extensioncontroller_extenderprofile_cellular
        - extensioncontroller_extenderprofile_cellular_controllerreport
        - extensioncontroller_extenderprofile_cellular_modem1
        - extensioncontroller_extenderprofile_cellular_modem1_autoswitch
        - extensioncontroller_extenderprofile_cellular_modem2
        - extensioncontroller_extenderprofile_cellular_modem2_autoswitch
        - extensioncontroller_extenderprofile_cellular_smsnotification
        - extensioncontroller_extenderprofile_cellular_smsnotification_alert
        - extensioncontroller_extenderprofile_cellular_smsnotification_receiver
        - extensioncontroller_extenderprofile_lanextension
        - extensioncontroller_extenderprofile_lanextension_backhaul
        - filefilter_profile
        - filefilter_profile_rules
        - firewall_accessproxy
        - firewall_accessproxy6
        - firewall_accessproxy6_apigateway
        - firewall_accessproxy6_apigateway6
        - firewall_accessproxy6_apigateway6_realservers
        - firewall_accessproxy6_apigateway6_sslciphersuites
        - firewall_accessproxy6_apigateway_realservers
        - firewall_accessproxy6_apigateway_sslciphersuites
        - firewall_accessproxy_apigateway
        - firewall_accessproxy_apigateway6
        - firewall_accessproxy_apigateway6_realservers
        - firewall_accessproxy_apigateway6_sslciphersuites
        - firewall_accessproxy_apigateway_realservers
        - firewall_accessproxy_apigateway_sslciphersuites
        - firewall_accessproxy_realservers
        - firewall_accessproxy_serverpubkeyauthsettings
        - firewall_accessproxy_serverpubkeyauthsettings_certextension
        - firewall_accessproxyvirtualhost
        - firewall_address
        - firewall_address6
        - firewall_address6_dynamicmapping
        - firewall_address6_dynamicmapping_subnetsegment
        - firewall_address6_list
        - firewall_address6_profilelist
        - firewall_address6_subnetsegment
        - firewall_address6_tagging
        - firewall_address6template
        - firewall_address6template_subnetsegment
        - firewall_address6template_subnetsegment_values
        - firewall_address_dynamicmapping
        - firewall_address_list
        - firewall_address_profilelist
        - firewall_address_tagging
        - firewall_addrgrp
        - firewall_addrgrp6
        - firewall_addrgrp6_dynamicmapping
        - firewall_addrgrp6_tagging
        - firewall_addrgrp_dynamicmapping
        - firewall_addrgrp_tagging
        - firewall_carrierendpointbwl
        - firewall_carrierendpointbwl_entries
        - firewall_decryptedtrafficmirror
        - firewall_explicitproxyaddress
        - firewall_explicitproxyaddress_headergroup
        - firewall_explicitproxyaddrgrp
        - firewall_gtp
        - firewall_gtp_apn
        - firewall_gtp_ieremovepolicy
        - firewall_gtp_ievalidation
        - firewall_gtp_imsi
        - firewall_gtp_ippolicy
        - firewall_gtp_messagefilter
        - firewall_gtp_messageratelimit
        - firewall_gtp_messageratelimitv0
        - firewall_gtp_messageratelimitv1
        - firewall_gtp_messageratelimitv2
        - firewall_gtp_noippolicy
        - firewall_gtp_perapnshaper
        - firewall_gtp_policy
        - firewall_gtp_policyv2
        - firewall_identitybasedroute
        - firewall_identitybasedroute_rule
        - firewall_internetservice
        - firewall_internetservice_entry
        - firewall_internetserviceaddition
        - firewall_internetserviceaddition_entry
        - firewall_internetserviceaddition_entry_portrange
        - firewall_internetservicecustom
        - firewall_internetservicecustom_disableentry
        - firewall_internetservicecustom_disableentry_iprange
        - firewall_internetservicecustom_entry
        - firewall_internetservicecustom_entry_portrange
        - firewall_internetservicecustomgroup
        - firewall_internetservicegroup
        - firewall_internetservicename
        - firewall_ippool
        - firewall_ippool6
        - firewall_ippool6_dynamicmapping
        - firewall_ippool_dynamicmapping
        - firewall_ippoolgrp
        - firewall_ldbmonitor
        - firewall_mmsprofile
        - firewall_mmsprofile_dupe
        - firewall_mmsprofile_flood
        - firewall_mmsprofile_notification
        - firewall_mmsprofile_notifmsisdn
        - firewall_mmsprofile_outbreakprevention
        - firewall_multicastaddress
        - firewall_multicastaddress6
        - firewall_multicastaddress6_tagging
        - firewall_multicastaddress_tagging
        - firewall_networkservicedynamic
        - firewall_profilegroup
        - firewall_profileprotocoloptions
        - firewall_profileprotocoloptions_cifs
        - firewall_profileprotocoloptions_cifs_filefilter
        - firewall_profileprotocoloptions_cifs_filefilter_entries
        - firewall_profileprotocoloptions_cifs_serverkeytab
        - firewall_profileprotocoloptions_dns
        - firewall_profileprotocoloptions_ftp
        - firewall_profileprotocoloptions_http
        - firewall_profileprotocoloptions_imap
        - firewall_profileprotocoloptions_mailsignature
        - firewall_profileprotocoloptions_mapi
        - firewall_profileprotocoloptions_nntp
        - firewall_profileprotocoloptions_pop3
        - firewall_profileprotocoloptions_smtp
        - firewall_profileprotocoloptions_ssh
        - firewall_proxyaddress
        - firewall_proxyaddress_headergroup
        - firewall_proxyaddress_tagging
        - firewall_proxyaddrgrp
        - firewall_proxyaddrgrp_tagging
        - firewall_schedule_group
        - firewall_schedule_onetime
        - firewall_schedule_recurring
        - firewall_service_category
        - firewall_service_custom
        - firewall_service_group
        - firewall_shaper_peripshaper
        - firewall_shaper_trafficshaper
        - firewall_shapingprofile
        - firewall_shapingprofile_shapingentries
        - firewall_ssh_localca
        - firewall_sslsshprofile
        - firewall_sslsshprofile_dot
        - firewall_sslsshprofile_ftps
        - firewall_sslsshprofile_https
        - firewall_sslsshprofile_imaps
        - firewall_sslsshprofile_pop3s
        - firewall_sslsshprofile_smtps
        - firewall_sslsshprofile_ssh
        - firewall_sslsshprofile_ssl
        - firewall_sslsshprofile_sslexempt
        - firewall_sslsshprofile_sslserver
        - firewall_trafficclass
        - firewall_vip
        - firewall_vip46
        - firewall_vip46_dynamicmapping
        - firewall_vip46_realservers
        - firewall_vip6
        - firewall_vip64
        - firewall_vip64_dynamicmapping
        - firewall_vip64_realservers
        - firewall_vip6_dynamicmapping
        - firewall_vip6_dynamicmapping_realservers
        - firewall_vip6_dynamicmapping_sslciphersuites
        - firewall_vip6_realservers
        - firewall_vip6_sslciphersuites
        - firewall_vip6_sslserverciphersuites
        - firewall_vip_dynamicmapping
        - firewall_vip_dynamicmapping_realservers
        - firewall_vip_dynamicmapping_sslciphersuites
        - firewall_vip_realservers
        - firewall_vip_sslciphersuites
        - firewall_vip_sslserverciphersuites
        - firewall_vipgrp
        - firewall_vipgrp46
        - firewall_vipgrp6
        - firewall_vipgrp64
        - firewall_vipgrp_dynamicmapping
        - firewall_wildcardfqdn_custom
        - firewall_wildcardfqdn_group
        - fmg_device_blueprint
        - fmg_fabric_authorization_template
        - fmg_fabric_authorization_template_platforms
        - fmg_variable
        - fmg_variable_dynamicmapping
        - fmupdate_analyzer_virusreport
        - fmupdate_avips_advancedlog
        - fmupdate_avips_webproxy
        - fmupdate_customurllist
        - fmupdate_diskquota
        - fmupdate_fctservices
        - fmupdate_fdssetting
        - fmupdate_fdssetting_pushoverride
        - fmupdate_fdssetting_pushoverridetoclient
        - fmupdate_fdssetting_pushoverridetoclient_announceip
        - fmupdate_fdssetting_serveroverride
        - fmupdate_fdssetting_serveroverride_servlist
        - fmupdate_fdssetting_updateschedule
        - fmupdate_fwmsetting
        - fmupdate_fwmsetting_upgradetimeout
        - fmupdate_multilayer
        - fmupdate_publicnetwork
        - fmupdate_serveraccesspriorities
        - fmupdate_serveraccesspriorities_privateserver
        - fmupdate_serveroverridestatus
        - fmupdate_service
        - fmupdate_webspam_fgdsetting
        - fmupdate_webspam_fgdsetting_serveroverride
        - fmupdate_webspam_fgdsetting_serveroverride_servlist
        - fmupdate_webspam_webproxy
        - footer_consolidated_policy
        - footer_policy
        - footer_policy6
        - footer_policy6_identitybasedpolicy6
        - footer_policy_identitybasedpolicy
        - footer_shapingpolicy
        - fsp_vlan
        - fsp_vlan_dhcpserver
        - fsp_vlan_dhcpserver_excluderange
        - fsp_vlan_dhcpserver_iprange
        - fsp_vlan_dhcpserver_options
        - fsp_vlan_dhcpserver_reservedaddress
        - fsp_vlan_dynamicmapping
        - fsp_vlan_dynamicmapping_dhcpserver
        - fsp_vlan_dynamicmapping_dhcpserver_excluderange
        - fsp_vlan_dynamicmapping_dhcpserver_iprange
        - fsp_vlan_dynamicmapping_dhcpserver_options
        - fsp_vlan_dynamicmapping_dhcpserver_reservedaddress
        - fsp_vlan_dynamicmapping_interface
        - fsp_vlan_dynamicmapping_interface_ipv6
        - fsp_vlan_dynamicmapping_interface_ipv6_ip6delegatedprefixlist
        - fsp_vlan_dynamicmapping_interface_ipv6_ip6extraaddr
        - fsp_vlan_dynamicmapping_interface_ipv6_ip6prefixlist
        - fsp_vlan_dynamicmapping_interface_ipv6_vrrp6
        - fsp_vlan_dynamicmapping_interface_secondaryip
        - fsp_vlan_dynamicmapping_interface_vrrp
        - fsp_vlan_dynamicmapping_interface_vrrp_proxyarp
        - fsp_vlan_interface
        - fsp_vlan_interface_ipv6
        - fsp_vlan_interface_ipv6_ip6delegatedprefixlist
        - fsp_vlan_interface_ipv6_ip6extraaddr
        - fsp_vlan_interface_ipv6_ip6prefixlist
        - fsp_vlan_interface_ipv6_vrrp6
        - fsp_vlan_interface_secondaryip
        - fsp_vlan_interface_vrrp
        - fsp_vlan_interface_vrrp_proxyarp
        - gtp_apn
        - gtp_apngrp
        - gtp_iewhitelist
        - gtp_iewhitelist_entries
        - gtp_messagefilterv0v1
        - gtp_messagefilterv2
        - gtp_tunnellimit
        - header_consolidated_policy
        - header_policy
        - header_policy6
        - header_policy6_identitybasedpolicy6
        - header_policy_identitybasedpolicy
        - header_shapingpolicy
        - hotspot20_anqp3gppcellular
        - hotspot20_anqp3gppcellular_mccmnclist
        - hotspot20_anqpipaddresstype
        - hotspot20_anqpnairealm
        - hotspot20_anqpnairealm_nailist
        - hotspot20_anqpnairealm_nailist_eapmethod
        - hotspot20_anqpnairealm_nailist_eapmethod_authparam
        - hotspot20_anqpnetworkauthtype
        - hotspot20_anqproamingconsortium
        - hotspot20_anqproamingconsortium_oilist
        - hotspot20_anqpvenuename
        - hotspot20_anqpvenuename_valuelist
        - hotspot20_anqpvenueurl
        - hotspot20_anqpvenueurl_valuelist
        - hotspot20_h2qpadviceofcharge
        - hotspot20_h2qpadviceofcharge_aoclist
        - hotspot20_h2qpadviceofcharge_aoclist_planinfo
        - hotspot20_h2qpconncapability
        - hotspot20_h2qpoperatorname
        - hotspot20_h2qpoperatorname_valuelist
        - hotspot20_h2qposuprovider
        - hotspot20_h2qposuprovider_friendlyname
        - hotspot20_h2qposuprovider_servicedescription
        - hotspot20_h2qposuprovidernai
        - hotspot20_h2qposuprovidernai_nailist
        - hotspot20_h2qptermsandconditions
        - hotspot20_h2qpwanmetric
        - hotspot20_hsprofile
        - hotspot20_icon
        - hotspot20_icon_iconlist
        - hotspot20_qosmap
        - hotspot20_qosmap_dscpexcept
        - hotspot20_qosmap_dscprange
        - icap_profile
        - icap_profile_icapheaders
        - icap_profile_respmodforwardrules
        - icap_profile_respmodforwardrules_headergroup
        - icap_server
        - ips_baseline_sensor
        - ips_baseline_sensor_entries
        - ips_baseline_sensor_entries_exemptip
        - ips_baseline_sensor_filter
        - ips_baseline_sensor_override
        - ips_baseline_sensor_override_exemptip
        - ips_custom
        - ips_sensor
        - ips_sensor_entries
        - ips_sensor_entries_exemptip
        - ips_sensor_filter
        - ips_sensor_override
        - ips_sensor_override_exemptip
        - log_customfield
        - log_npuserver
        - log_npuserver_servergroup
        - log_npuserver_serverinfo
        - metafields_system_admin_user
        - mpskprofile
        - mpskprofile_mpskgroup
        - mpskprofile_mpskgroup_mpskkey
        - nacprofile
        - pkg_authentication_rule
        - pkg_authentication_setting
        - pkg_central_dnat
        - pkg_central_dnat6
        - pkg_firewall_acl
        - pkg_firewall_acl6
        - pkg_firewall_centralsnatmap
        - pkg_firewall_consolidated_policy
        - pkg_firewall_dospolicy
        - pkg_firewall_dospolicy6
        - pkg_firewall_dospolicy6_anomaly
        - pkg_firewall_dospolicy_anomaly
        - pkg_firewall_explicitproxypolicy
        - pkg_firewall_explicitproxypolicy_identitybasedpolicy
        - pkg_firewall_hyperscalepolicy
        - pkg_firewall_hyperscalepolicy46
        - pkg_firewall_hyperscalepolicy6
        - pkg_firewall_hyperscalepolicy64
        - pkg_firewall_interfacepolicy
        - pkg_firewall_interfacepolicy6
        - pkg_firewall_localinpolicy
        - pkg_firewall_localinpolicy6
        - pkg_firewall_multicastpolicy
        - pkg_firewall_multicastpolicy6
        - pkg_firewall_policy
        - pkg_firewall_policy46
        - pkg_firewall_policy6
        - pkg_firewall_policy64
        - pkg_firewall_policy_vpndstnode
        - pkg_firewall_policy_vpnsrcnode
        - pkg_firewall_proxypolicy
        - pkg_firewall_securitypolicy
        - pkg_firewall_shapingpolicy
        - pkg_footer_consolidated_policy
        - pkg_footer_policy
        - pkg_footer_policy6
        - pkg_footer_policy6_identitybasedpolicy6
        - pkg_footer_policy_identitybasedpolicy
        - pkg_footer_shapingpolicy
        - pkg_header_consolidated_policy
        - pkg_header_policy
        - pkg_header_policy6
        - pkg_header_policy6_identitybasedpolicy6
        - pkg_header_policy_identitybasedpolicy
        - pkg_header_shapingpolicy
        - pkg_user_nacpolicy
        - pm_config_adom_options
        - pm_config_application_list
        - pm_config_category_list
        - pm_config_data_tablesize
        - pm_config_data_tablesize_faz
        - pm_config_data_tablesize_fmg
        - pm_config_data_tablesize_fos
        - pm_config_data_tablesize_log
        - pm_config_fct_endpointcontrol_profile
        - pm_config_metafields_firewall_address
        - pm_config_metafields_firewall_addrgrp
        - pm_config_metafields_firewall_centralsnatmap
        - pm_config_metafields_firewall_policy
        - pm_config_metafields_firewall_service_custom
        - pm_config_metafields_firewall_service_group
        - pm_config_package_status
        - pm_config_pblock_firewall_consolidated_policy
        - pm_config_pblock_firewall_policy
        - pm_config_pblock_firewall_policy6
        - pm_config_pblock_firewall_securitypolicy
        - pm_config_rule_list
        - pm_devprof
        - pm_devprof_adom
        - pm_pblock
        - pm_pblock_adom
        - pm_pkg
        - pm_pkg_adom
        - pm_pkg_global
        - pm_pkg_schedule
        - pm_wanprof
        - pm_wanprof_adom
        - qosprofile
        - region
        - router_accesslist
        - router_accesslist6
        - router_accesslist6_rule
        - router_accesslist_rule
        - router_aspathlist
        - router_aspathlist_rule
        - router_communitylist
        - router_communitylist_rule
        - router_prefixlist
        - router_prefixlist6
        - router_prefixlist6_rule
        - router_prefixlist_rule
        - router_routemap
        - router_routemap_rule
        - spamfilter_bwl
        - spamfilter_bwl_entries
        - spamfilter_bword
        - spamfilter_bword_entries
        - spamfilter_dnsbl
        - spamfilter_dnsbl_entries
        - spamfilter_iptrust
        - spamfilter_iptrust_entries
        - spamfilter_mheader
        - spamfilter_mheader_entries
        - spamfilter_profile
        - spamfilter_profile_gmail
        - spamfilter_profile_imap
        - spamfilter_profile_mapi
        - spamfilter_profile_msnhotmail
        - spamfilter_profile_pop3
        - spamfilter_profile_smtp
        - spamfilter_profile_yahoomail
        - sshfilter_profile
        - sshfilter_profile_filefilter
        - sshfilter_profile_filefilter_entries
        - sshfilter_profile_shellcommands
        - switchcontroller_acl_group
        - switchcontroller_acl_ingress
        - switchcontroller_acl_ingress_action
        - switchcontroller_acl_ingress_classifier
        - switchcontroller_customcommand
        - switchcontroller_dsl_policy
        - switchcontroller_dynamicportpolicy
        - switchcontroller_dynamicportpolicy_policy
        - switchcontroller_fortilinksettings
        - switchcontroller_fortilinksettings_nacports
        - switchcontroller_lldpprofile
        - switchcontroller_lldpprofile_customtlvs
        - switchcontroller_lldpprofile_medlocationservice
        - switchcontroller_lldpprofile_mednetworkpolicy
        - switchcontroller_macpolicy
        - switchcontroller_managedswitch
        - switchcontroller_managedswitch_8021xsettings
        - switchcontroller_managedswitch_customcommand
        - switchcontroller_managedswitch_dhcpsnoopingstaticclient
        - switchcontroller_managedswitch_igmpsnooping
        - switchcontroller_managedswitch_ipsourceguard
        - switchcontroller_managedswitch_ipsourceguard_bindingentry
        - switchcontroller_managedswitch_mirror
        - switchcontroller_managedswitch_ports
        - switchcontroller_managedswitch_ports_dhcpsnoopoption82override
        - switchcontroller_managedswitch_remotelog
        - switchcontroller_managedswitch_snmpcommunity
        - switchcontroller_managedswitch_snmpcommunity_hosts
        - switchcontroller_managedswitch_snmpsysinfo
        - switchcontroller_managedswitch_snmptrapthreshold
        - switchcontroller_managedswitch_snmpuser
        - switchcontroller_managedswitch_staticmac
        - switchcontroller_managedswitch_stormcontrol
        - switchcontroller_managedswitch_stpinstance
        - switchcontroller_managedswitch_stpsettings
        - switchcontroller_managedswitch_switchlog
        - switchcontroller_managedswitch_switchstpsettings
        - switchcontroller_qos_dot1pmap
        - switchcontroller_qos_ipdscpmap
        - switchcontroller_qos_ipdscpmap_map
        - switchcontroller_qos_qospolicy
        - switchcontroller_qos_queuepolicy
        - switchcontroller_qos_queuepolicy_cosqueue
        - switchcontroller_securitypolicy_8021x
        - switchcontroller_securitypolicy_captiveportal
        - switchcontroller_switchinterfacetag
        - switchcontroller_trafficpolicy
        - switchcontroller_vlanpolicy
        - sys_ha_status
        - sys_status
        - system_admin_group
        - system_admin_group_member
        - system_admin_ldap
        - system_admin_ldap_adom
        - system_admin_profile
        - system_admin_profile_datamaskcustomfields
        - system_admin_radius
        - system_admin_setting
        - system_admin_tacacs
        - system_admin_user
        - system_admin_user_adom
        - system_admin_user_adomexclude
        - system_admin_user_appfilter
        - system_admin_user_dashboard
        - system_admin_user_dashboardtabs
        - system_admin_user_ipsfilter
        - system_admin_user_metadata
        - system_admin_user_policypackage
        - system_admin_user_restrictdevvdom
        - system_admin_user_webfilter
        - system_alertconsole
        - system_alertemail
        - system_alertevent
        - system_alertevent_alertdestination
        - system_autodelete
        - system_autodelete_dlpfilesautodeletion
        - system_autodelete_logautodeletion
        - system_autodelete_quarantinefilesautodeletion
        - system_autodelete_reportautodeletion
        - system_backup_allsettings
        - system_certificate_ca
        - system_certificate_crl
        - system_certificate_local
        - system_certificate_oftp
        - system_certificate_remote
        - system_certificate_ssh
        - system_connector
        - system_customlanguage
        - system_dhcp_server
        - system_dhcp_server_excluderange
        - system_dhcp_server_iprange
        - system_dhcp_server_options
        - system_dhcp_server_reservedaddress
        - system_dm
        - system_dns
        - system_docker
        - system_externalresource
        - system_fips
        - system_fortiguard
        - system_fortiview_autocache
        - system_fortiview_setting
        - system_geoipcountry
        - system_geoipoverride
        - system_geoipoverride_ip6range
        - system_geoipoverride_iprange
        - system_global
        - system_guiact
        - system_ha
        - system_ha_monitoredinterfaces
        - system_ha_monitoredips
        - system_ha_peer
        - system_hascheduledcheck
        - system_interface
        - system_interface_ipv6
        - system_interface_member
        - system_localinpolicy
        - system_localinpolicy6
        - system_locallog_disk_filter
        - system_locallog_disk_setting
        - system_locallog_fortianalyzer2_filter
        - system_locallog_fortianalyzer2_setting
        - system_locallog_fortianalyzer3_filter
        - system_locallog_fortianalyzer3_setting
        - system_locallog_fortianalyzer_filter
        - system_locallog_fortianalyzer_setting
        - system_locallog_memory_filter
        - system_locallog_memory_setting
        - system_locallog_setting
        - system_locallog_syslogd2_filter
        - system_locallog_syslogd2_setting
        - system_locallog_syslogd3_filter
        - system_locallog_syslogd3_setting
        - system_locallog_syslogd_filter
        - system_locallog_syslogd_setting
        - system_log_alert
        - system_log_devicedisable
        - system_log_fospolicystats
        - system_log_interfacestats
        - system_log_ioc
        - system_log_maildomain
        - system_log_ratelimit
        - system_log_ratelimit_device
        - system_log_ratelimit_ratelimits
        - system_log_settings
        - system_log_settings_rollinganalyzer
        - system_log_settings_rollinglocal
        - system_log_settings_rollingregular
        - system_log_topology
        - system_logfetch_clientprofile
        - system_logfetch_clientprofile_devicefilter
        - system_logfetch_clientprofile_logfilter
        - system_logfetch_serversettings
        - system_mail
        - system_mcpolicydisabledadoms
        - system_meta
        - system_meta_sysmetafields
        - system_metadata_admins
        - system_npu
        - system_npu_backgroundssescan
        - system_npu_dosoptions
        - system_npu_dswdtsprofile
        - system_npu_dswqueuedtsprofile
        - system_npu_fpanomaly
        - system_npu_hpe
        - system_npu_ipreassembly
        - system_npu_isfnpqueues
        - system_npu_npqueues
        - system_npu_npqueues_ethernettype
        - system_npu_npqueues_ipprotocol
        - system_npu_npqueues_ipservice
        - system_npu_npqueues_profile
        - system_npu_npqueues_scheduler
        - system_npu_portcpumap
        - system_npu_portnpumap
        - system_npu_portpathoption
        - system_npu_priorityprotocol
        - system_npu_ssehascan
        - system_npu_swehhash
        - system_npu_swtrhash
        - system_npu_tcptimeoutprofile
        - system_npu_udptimeoutprofile
        - system_ntp
        - system_ntp_ntpserver
        - system_objecttag
        - system_objecttagging
        - system_passwordpolicy
        - system_performance
        - system_replacemsggroup
        - system_replacemsggroup_admin
        - system_replacemsggroup_alertmail
        - system_replacemsggroup_auth
        - system_replacemsggroup_automation
        - system_replacemsggroup_custommessage
        - system_replacemsggroup_devicedetectionportal
        - system_replacemsggroup_ec
        - system_replacemsggroup_fortiguardwf
        - system_replacemsggroup_ftp
        - system_replacemsggroup_http
        - system_replacemsggroup_icap
        - system_replacemsggroup_mail
        - system_replacemsggroup_mm1
        - system_replacemsggroup_mm3
        - system_replacemsggroup_mm4
        - system_replacemsggroup_mm7
        - system_replacemsggroup_mms
        - system_replacemsggroup_nacquar
        - system_replacemsggroup_nntp
        - system_replacemsggroup_spam
        - system_replacemsggroup_sslvpn
        - system_replacemsggroup_trafficquota
        - system_replacemsggroup_utm
        - system_replacemsggroup_webproxy
        - system_replacemsgimage
        - system_report_autocache
        - system_report_estbrowsetime
        - system_report_group
        - system_report_group_chartalternative
        - system_report_group_groupby
        - system_report_setting
        - system_route
        - system_route6
        - system_saml
        - system_saml_fabricidp
        - system_saml_serviceproviders
        - system_sdnconnector
        - system_sdnconnector_compartmentlist
        - system_sdnconnector_externalaccountlist
        - system_sdnconnector_externalip
        - system_sdnconnector_forwardingrule
        - system_sdnconnector_gcpprojectlist
        - system_sdnconnector_nic
        - system_sdnconnector_nic_ip
        - system_sdnconnector_ociregionlist
        - system_sdnconnector_route
        - system_sdnconnector_routetable
        - system_sdnconnector_routetable_route
        - system_smsserver
        - system_sniffer
        - system_snmp_community
        - system_snmp_community_hosts
        - system_snmp_community_hosts6
        - system_snmp_sysinfo
        - system_snmp_user
        - system_socfabric
        - system_socfabric_trustedlist
        - system_sql
        - system_sql_customindex
        - system_sql_customskipidx
        - system_sql_tsindexfield
        - system_sslciphersuites
        - system_status
        - system_syslog
        - system_virtualwirepair
        - system_webproxy
        - system_workflow_approvalmatrix
        - system_workflow_approvalmatrix_approver
        - task_task
        - task_task_history
        - task_task_line
        - task_task_line_history
        - template
        - templategroup
        - user_adgrp
        - user_certificate
        - user_clearpass
        - user_connector
        - user_device
        - user_device_dynamicmapping
        - user_device_tagging
        - user_deviceaccesslist
        - user_deviceaccesslist_devicelist
        - user_devicecategory
        - user_devicegroup
        - user_devicegroup_dynamicmapping
        - user_devicegroup_tagging
        - user_domaincontroller
        - user_domaincontroller_extraserver
        - user_exchange
        - user_flexvm
        - user_fortitoken
        - user_fsso
        - user_fsso_dynamicmapping
        - user_fssopolling
        - user_fssopolling_adgrp
        - user_group
        - user_group_dynamicmapping
        - user_group_dynamicmapping_guest
        - user_group_dynamicmapping_match
        - user_group_dynamicmapping_sslvpnoschecklist
        - user_group_guest
        - user_group_match
        - user_json
        - user_krbkeytab
        - user_ldap
        - user_ldap_dynamicmapping
        - user_local
        - user_nsx
        - user_nsx_service
        - user_passwordpolicy
        - user_peer
        - user_peergrp
        - user_pop3
        - user_pxgrid
        - user_radius
        - user_radius_accountingserver
        - user_radius_dynamicmapping
        - user_radius_dynamicmapping_accountingserver
        - user_saml
        - user_saml_dynamicmapping
        - user_securityexemptlist
        - user_securityexemptlist_rule
        - user_tacacs
        - user_tacacs_dynamicmapping
        - user_vcenter
        - user_vcenter_rule
        - utmprofile
        - vap
        - vap_dynamicmapping
        - vap_macfilterlist
        - vap_mpskkey
        - vap_portalmessageoverrides
        - vap_vlanname
        - vap_vlanpool
        - vapgroup
        - videofilter_profile
        - videofilter_profile_fortiguardcategory
        - videofilter_profile_fortiguardcategory_filters
        - videofilter_youtubechannelfilter
        - videofilter_youtubechannelfilter_entries
        - voip_profile
        - voip_profile_msrp
        - voip_profile_sccp
        - voip_profile_sip
        - vpn_certificate_ca
        - vpn_certificate_ocspserver
        - vpn_certificate_remote
        - vpn_ipsec_fec
        - vpn_ipsec_fec_mappings
        - vpn_ssl_settings
        - vpn_ssl_settings_authenticationrule
        - vpnmgr_node
        - vpnmgr_node_iprange
        - vpnmgr_node_ipv4excluderange
        - vpnmgr_node_protectedsubnet
        - vpnmgr_node_summaryaddr
        - vpnmgr_vpntable
        - vpnsslweb_hostchecksoftware
        - vpnsslweb_hostchecksoftware_checkitemlist
        - vpnsslweb_portal
        - vpnsslweb_portal_bookmarkgroup
        - vpnsslweb_portal_bookmarkgroup_bookmarks
        - vpnsslweb_portal_bookmarkgroup_bookmarks_formdata
        - vpnsslweb_portal_landingpage
        - vpnsslweb_portal_landingpage_formdata
        - vpnsslweb_portal_macaddrcheckrule
        - vpnsslweb_portal_oschecklist
        - vpnsslweb_portal_splitdns
        - vpnsslweb_realm
        - vpnsslweb_virtualdesktopapplist
        - vpnsslweb_virtualdesktopapplist_apps
        - waf_mainclass
        - waf_profile
        - waf_profile_addresslist
        - waf_profile_constraint
        - waf_profile_constraint_contentlength
        - waf_profile_constraint_exception
        - waf_profile_constraint_headerlength
        - waf_profile_constraint_hostname
        - waf_profile_constraint_linelength
        - waf_profile_constraint_malformed
        - waf_profile_constraint_maxcookie
        - waf_profile_constraint_maxheaderline
        - waf_profile_constraint_maxrangesegment
        - waf_profile_constraint_maxurlparam
        - waf_profile_constraint_method
        - waf_profile_constraint_paramlength
        - waf_profile_constraint_urlparamlength
        - waf_profile_constraint_version
        - waf_profile_method
        - waf_profile_method_methodpolicy
        - waf_profile_signature
        - waf_profile_signature_customsignature
        - waf_profile_signature_mainclass
        - waf_profile_urlaccess
        - waf_profile_urlaccess_accesspattern
        - waf_signature
        - waf_subclass
        - wagprofile
        - wanopt_authgroup
        - wanopt_peer
        - wanopt_profile
        - wanopt_profile_cifs
        - wanopt_profile_ftp
        - wanopt_profile_http
        - wanopt_profile_mapi
        - wanopt_profile_tcp
        - wanprof_system_sdwan
        - wanprof_system_sdwan_duplication
        - wanprof_system_sdwan_healthcheck
        - wanprof_system_sdwan_healthcheck_sla
        - wanprof_system_sdwan_members
        - wanprof_system_sdwan_neighbor
        - wanprof_system_sdwan_service
        - wanprof_system_sdwan_service_sla
        - wanprof_system_sdwan_zone
        - wanprof_system_virtualwanlink
        - wanprof_system_virtualwanlink_healthcheck
        - wanprof_system_virtualwanlink_healthcheck_sla
        - wanprof_system_virtualwanlink_members
        - wanprof_system_virtualwanlink_neighbor
        - wanprof_system_virtualwanlink_service
        - wanprof_system_virtualwanlink_service_sla
        - webfilter_categories
        - webfilter_content
        - webfilter_content_entries
        - webfilter_contentheader
        - webfilter_contentheader_entries
        - webfilter_ftgdlocalcat
        - webfilter_ftgdlocalrating
        - webfilter_profile
        - webfilter_profile_antiphish
        - webfilter_profile_antiphish_custompatterns
        - webfilter_profile_antiphish_inspectionentries
        - webfilter_profile_filefilter
        - webfilter_profile_filefilter_entries
        - webfilter_profile_ftgdwf
        - webfilter_profile_ftgdwf_filters
        - webfilter_profile_ftgdwf_quota
        - webfilter_profile_override
        - webfilter_profile_urlextraction
        - webfilter_profile_web
        - webfilter_profile_youtubechannelfilter
        - webfilter_urlfilter
        - webfilter_urlfilter_entries
        - webproxy_forwardserver
        - webproxy_forwardservergroup
        - webproxy_forwardservergroup_serverlist
        - webproxy_profile
        - webproxy_profile_headers
        - webproxy_wisp
        - widsprofile
        - wireless_accesscontrollist
        - wireless_accesscontrollist_layer3ipv4rules
        - wireless_accesscontrollist_layer3ipv6rules
        - wireless_address
        - wireless_addrgrp
        - wireless_ssidpolicy
        - wireless_syslogprofile
        - wtpprofile
        - wtpprofile_denymaclist
        - wtpprofile_eslsesdongle
        - wtpprofile_lan
        - wtpprofile_lbs
        - wtpprofile_platform
        - wtpprofile_radio1
        - wtpprofile_radio2
        - wtpprofile_radio3
        - wtpprofile_radio4
        - wtpprofile_splittunnelingacl
        description: Selector of the retrieved fortimanager facts.
        required: true
        type: str
      sortings:
        description: Sorting rules list. Items are returned in ascending(1) or descending(-1)
          order of fields in the list.
        elements: str
        required: false
        type: list
    type: dict

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Access token of FortiCloud managed API users, this option is available
      with FortiManager later than 6.4.0.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list