:source: fortios_monitor_fact.py

:orphan:

.. :

fortios_monitor_fact -- Retrieve Facts of FortiOS Monitor Objects.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 2.10

.. contents::
   :local:
   :depth: 1


Synopsis
--------
- Collects monitor facts from network devices running the fortios operating system.  This facts module will only collect those facts which user specified in playbook.



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

- install galaxy collection fortinet.fortios >= ``2.0.0``.


Parameters
----------


.. raw:: html

    <ul>
    <li> <span class="li-head">vdom</span> - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. <span class="li-normal">type: str</span> <span class="li-required">required: False</span> <span class="li-normal">default: root</span></li>
    <li> <span class="li-head">enable_log</span> - Enable/Disable logging for task. <span class="li-normal">type: bool</span> <span class="li-required">required: False</span> <span class="li-normal">default: False</span> </li>
    <li> <span class="li-head">access_token</span> - Token-based authentication. Generated from GUI of Fortigate. <span class="li-normal">type: str</span> <span class="li-required">required: False</span> </li>
    <li> <span class="li-head">filters</span> - A list of expressions to filter the returned results. <span class="li-normal">type: list</span> <span class="li-required">required: False</span>
     <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a>
     <div id="label1" style="display:none">
     Filter item must be in the following format: <code class="docutils literal notranslate"><span class="pre">[key][operator][pattern]</span></code>, operators could be found in the table:
     <table border="1">
        <tr>
         <td><code class="docutils literal notranslate">Operator </code></td>
         <td><code class="docutils literal notranslate">Case sensitive </code></td>
         <td><code class="docutils literal notranslate">Description </code></td>
        </tr>
      <tr>
       <td>==</td>
       <td>Yes</td>
       <td>Pattern must be identical to the value.</td>
      </tr>
      <tr>
       <td>=*</td>
       <td>No</td>
       <td>Pattern must be identical to the value.</td>
      </tr>
      <tr>
       <td>!=</td>
       <td>Yes</td>
       <td>Pattern does not match the value.</td>
      </tr>
      <tr>
       <td>!*</td>
       <td>No</td>
       <td>Pattern does not match the value.</td>
      </tr>
      <tr>
       <td>=@</td>
       <td>No</td>
       <td>Pattern found within value.</td>
      </tr>
      <tr>
       <td>!@</td>
       <td>No</td>
       <td>Pattern not found within value.</td>
      </tr>
      <tr>
       <td><=</td>
       <td>n/a</td>
       <td>Value must be less than or equal to pattern.</td>
      </tr>
      <tr>
       <td><</td>
       <td>n/a</td>
       <td>Value must be less than pattern.</td>
      </tr>
      <tr>
       <td>>=</td>
       <td>n/a</td>
       <td>Value must be greater than or equal to pattern.</td>
      </tr>
      <tr>
       <td>></td>
       <td>n/a</td>
       <td>Value must be greater than pattern.</td>
      </tr>
      </table>
     </div>
    </li>
    <li> <span class="li-head">sorters</span> - A list of expressions to sort the returned results. <span class="li-normal">type: list</span> <span class="li-required">required: False</span>
        <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a>
       <div id="label3" style="display:none">
       Sorter item must be a <code class="docutils literal notranslate"><span class="pre">[key]</span></code> followed by a <code class="docutils literal notranslate"><span class="pre">,asc</span></code> or <code class="docutils literal notranslate"><span class="pre">,dsc</span></code> order derective.
       <br>
       examples: <code class="docutils literal notranslate"><span class="pre">name,asc</span></code> to sort the result by name in ascending order; <code class="docutils literal notranslate"><span class="pre">vlanid,asc</span></code> to sort the result by vlanid in descending order.
       </div>
    </li>
    <li> <span class="li-head">formatters</span> - A list of fields to display for returned results. <span class="li-normal">type: list</span> <span class="li-required">required: False</span> </li>
    <li><span class="li-head">selector</span> - selector of the retrieved fortigate facts <span class="li-normal">type: str</span> <span class="li-required">choices:</span></li>
        <li style="list-style: none;"><section class="accordion">
        <input type="checkbox" name="collapse" id="handle2">
        <h2 class="handle">
            <label for="handle2"><u>Show full selector list...</u></label>
        </h2>
        <div class="content">
        <ul class="ul-self">
        azure_application-list
        <li><span class="li-head">azure_application-list</span> 
        
        </li>
        casb_saas-application_details
        <li><span class="li-head">casb_saas-application_details</span> - Retrieve details for CASB SaaS applications. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: Key of the application to be fetched <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_avatar_download
        <li><span class="li-head">endpoint-control_avatar_download</span> - Download an endpoint avatar image. 
        <ul class="ul-self">
                <li><span class="li-required">uid</span> - Single FortiClient UID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">user</span> - User name of the endpoint. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">fingerprint</span> - Avatar fingerprint. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">default</span> - Default avatar name ['authuser'|'unauthuser'|'authuser_72'|'unauthuser_72']. Default avatar when endpoint / device avatar is not available. If default is not set, Not found 404 is returned. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_ems_cert-status
        <li><span class="li-head">endpoint-control_ems_cert-status</span> - Retrieve authentication status of the EMS server certificate for a specific EMS. 
        <ul class="ul-self">
                <li><span class="li-required">ems_id</span> - EMS server ID (as defined in CLI table endpoint-control.fctems). <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">scope</span> - Scope from which to retrieve EMS certificate status [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_cert</span> - Return detailed certificate information. Available when the certificate is authenticated by installed CA certificates.  <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_ems_malware-hash
        <li><span class="li-head">endpoint-control_ems_malware-hash</span> 
        
        </li>
        endpoint-control_ems_status
        <li><span class="li-head">endpoint-control_ems_status</span> - Retrieve EMS connection status for a specific EMS. 
        <ul class="ul-self">
                <li><span class="li-required">ems_id</span> - EMS server ID (as defined in CLI table endpoint-control.fctems). <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">scope</span> - Scope from which to retrieve EMS connection status [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_ems_status-summary
        <li><span class="li-head">endpoint-control_ems_status-summary</span> - Retrieve status summary for all configured EMS. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope from which to retrieve EMS status summary [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_installer
        <li><span class="li-head">endpoint-control_installer</span> - List available FortiClient installers. 
        <ul class="ul-self">
                <li><span class="li-required">min_version</span> - Filter: Minimum installer version. (String of the format n[.n[.n]]). <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_installer_download
        <li><span class="li-head">endpoint-control_installer_download</span> - Download a FortiClient installer via FortiGuard. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of installer (image_id). <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_profile_xml
        <li><span class="li-head">endpoint-control_profile_xml</span> - List XML representation for each endpoint-control profile. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of endpoint-control profile. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_record-list
        <li><span class="li-head">endpoint-control_record-list</span> - List endpoint records. This should only be used when you need to retrieve endpoint information from FortiEMS. 
        <ul class="ul-self">
                <li><span class="li-required">intf_name</span> - Filter: Name of interface where the endpoint was detected. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        endpoint-control_registration_summary
        <li><span class="li-head">endpoint-control_registration_summary</span> 
        
        </li>
        endpoint-control_summary
        <li><span class="li-head">endpoint-control_summary</span> 
        
        </li>
        extender-controller_extender
        <li><span class="li-head">extender-controller_extender</span> - Retrieve statistics for specific configured FortiExtender units. 
        <ul class="ul-self">
                <li><span class="li-required">fortiextender-name</span> - Filter: list of FortiExtender name. Retrieve statistics for all configured FortiExtender units unless specified. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">type</span> - Statistic type.'type' options are [system | modem | usage | last]. If 'type' is not specified, all types of statistics are retrieved. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        extender-controller_extender_modem-firmware
        <li><span class="li-head">extender-controller_extender_modem-firmware</span> - List all available FortiExtender modem firmware images on FortiCloud. 
        <ul class="ul-self">
                <li><span class="li-required">serial</span> - FortiExtender serial number. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        extension-controller_fortigate
        <li><span class="li-head">extension-controller_fortigate</span> 
        
        </li>
        extension-controller_lan-extension-vdom-status
        <li><span class="li-head">extension-controller_lan-extension-vdom-status</span> 
        
        </li>
        firewall_acl
        <li><span class="li-head">firewall_acl</span> 
        
        </li>
        firewall_acl6
        <li><span class="li-head">firewall_acl6</span> 
        
        </li>
        firewall_address-dynamic
        <li><span class="li-head">firewall_address-dynamic</span> - List of Fabric Connector address objects and the IPs they resolve to. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of the dynamic address to retrieve. If this is not provided, all dynamic addresses will be retrieved. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_address-fqdns
        <li><span class="li-head">firewall_address-fqdns</span> - List of FQDN address objects and the IPs they resolved to. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of the FQDN address to retrieve. If this is not provided, the count of IPs FQDN resolves to will be returned. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_address-fqdns6
        <li><span class="li-head">firewall_address-fqdns6</span> - List of IPv6 FQDN address objects and the IPs they resolved to. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of the FQDN address to retrieve. If this is not provided, the count of IPs FQDN resolves to will be returned. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_address6-dynamic
        <li><span class="li-head">firewall_address6-dynamic</span> - List of IPv6 Fabric Connector address objects and the IPs they resolve to. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of the dynamic address to retrieve. If this is not provided, all dynamic addresses will be retrieved. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_central-snat-map
        <li><span class="li-head">firewall_central-snat-map</span> - List traffic statistics for firewall central SNAT policies. 
        <ul class="ul-self">
                <li><span class="li-required">policyid</span> - Filter: Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - Filter: Traffic IP Version. [ ipv4 | ipv6 ], if left empty, will retrieve data for both IPv4 and IPv6. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_check-addrgrp-exclude-mac-member
        <li><span class="li-head">firewall_check-addrgrp-exclude-mac-member</span> - Check if the IPv4 or IPv6 address group should exclude mac address type member. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - The address group name to be checked. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">ip_version</span> - IP version [ipv4 | ipv6]. Specify the IP version of the address / address group. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_consolidated-policy
        <li><span class="li-head">firewall_consolidated-policy</span> - List traffic statistics for consolidated policies. 
        <ul class="ul-self">
                <li><span class="li-required">policyid</span> - Filter: Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_dnat
        <li><span class="li-head">firewall_dnat</span> - List hit count statistics for firewall virtual IP/server. 
        <ul class="ul-self">
                <li><span class="li-required">uuid</span> - Filter: List of Virtual IP UUIDs. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - Filter: Traffic IP Version. [ ipv4 | ipv6 ], if left empty, will retrieve data for both IPv4 and IPv6. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_gtp
        <li><span class="li-head">firewall_gtp</span> 
        
        </li>
        firewall_gtp-runtime-statistics
        <li><span class="li-head">firewall_gtp-runtime-statistics</span> 
        
        </li>
        firewall_gtp-statistics
        <li><span class="li-head">firewall_gtp-statistics</span> 
        
        </li>
        firewall_health
        <li><span class="li-head">firewall_health</span> 
        
        </li>
        firewall_internet-service-basic
        <li><span class="li-head">firewall_internet-service-basic</span> - List internet services with basic information. 
        <ul class="ul-self">
                <li><span class="li-required">ipv6_only</span> - Only return IPv6 entries. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_internet-service-details
        <li><span class="li-head">firewall_internet-service-details</span> - List all details for a given Internet Service ID. 
        <ul class="ul-self">
                <li><span class="li-required">id</span> - ID of the Internet Service to get details for. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">country_id</span> - Filter: Country ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">region_id</span> - Filter: Region ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">city_id</span> - Filter: City ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">summary_only</span> - Only return number of entries instead of entries. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ipv6_only</span> - Only returns ipv6 entries. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_internet-service-fqdn
        <li><span class="li-head">firewall_internet-service-fqdn</span> 
        
        </li>
        firewall_internet-service-fqdn-icon-ids
        <li><span class="li-head">firewall_internet-service-fqdn-icon-ids</span> 
        
        </li>
        firewall_internet-service-match
        <li><span class="li-head">firewall_internet-service-match</span> - List internet services that exist at a given IP or Subnet. 
        <ul class="ul-self">
                <li><span class="li-required">ip</span> - IP (in dot-decimal notation). <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">is_ipv6</span> - Whether IP is IPv6. If not provided, will determine IP version based on given IP, but setting is_ipv6 flag is recommended. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ipv4_mask</span> - IPv4 address mask (in dot-decimal notation). Required if is_ipv6 is false. Example: 255.255.255.255 <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ipv6_prefix</span> - IPv6 address prefix. Required if is_ipv6 is true. Example: 128 <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_internet-service-reputation
        <li><span class="li-head">firewall_internet-service-reputation</span> - List internet services with reputation information that exist at a given IP. 
        <ul class="ul-self">
                <li><span class="li-required">ip</span> - IP (in dot-decimal notation). <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">is_ipv6</span> - Whether IP is IPv6. If not provided, will determine IP version based on given IP, but setting is_ipv6 flag is recommended. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_ippool
        <li><span class="li-head">firewall_ippool</span> 
        
        </li>
        firewall_ippool_mapping
        <li><span class="li-head">firewall_ippool_mapping</span> - Get the list of IPv4 mappings for the specified IP pool. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - The IP pool name. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        firewall_load-balance
        <li><span class="li-head">firewall_load-balance</span> - List all firewall load balance servers. 
        <ul class="ul-self">
                <li><span class="li-required">count</span> - Maximum number of entries to return. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        firewall_local-in
        <li><span class="li-head">firewall_local-in</span> - List implicit and explicit local-in firewall policies. 
        <ul class="ul-self">
                <li><span class="li-required">include_ttl</span> - Include TTL local-in policies. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_local-in6
        <li><span class="li-head">firewall_local-in6</span> 
        
        </li>
        firewall_multicast-policy
        <li><span class="li-head">firewall_multicast-policy</span> - List traffic statistics for IPv4 firewall multicast policies. 
        <ul class="ul-self">
                <li><span class="li-required">policyid</span> - Filter: Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_multicast-policy6
        <li><span class="li-head">firewall_multicast-policy6</span> - List traffic statistics for IPv6 firewall multicast policies. 
        <ul class="ul-self">
                <li><span class="li-required">policyid</span> - Filter: Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_network-service-dynamic
        <li><span class="li-head">firewall_network-service-dynamic</span> - List of dynamic network service IP address and port pairs. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of the dynamic network service entry. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        firewall_per-ip-shaper
        <li><span class="li-head">firewall_per-ip-shaper</span> - List of statistics for configured firewall per-IP traffic shapers. 
        <ul class="ul-self">
                <li><span class="li-required">shaper_name</span> - Filter the results by per-IP shaper name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_policy
        <li><span class="li-head">firewall_policy</span> - List traffic statistics for firewall policies. 
        <ul class="ul-self">
                <li><span class="li-required">policyid</span> - Filter: Array of policy IDs. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - Filter: Traffic IP Version. [ ipv4 | ipv6 ], if left empty, will retrieve data for both ipv4 and ipv6. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_policy-lookup
        <li><span class="li-head">firewall_policy-lookup</span> - Performs a policy lookup by creating a dummy packet and asking the kernel which policy would be hit. 
        <ul class="ul-self">
                <li><span class="li-required">ipv6</span> - Perform an IPv6 lookup? <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintf</span> - Source interface. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">sourceport</span> - Source port. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sourceip</span> - Source IP. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">protocol</span> - Protocol. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">dest</span> - Destination IP/FQDN. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">destport</span> - Destination port. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">icmptype</span> - ICMP type. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">icmpcode</span> - ICMP code. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">policy_type</span> - Policy type. [*policy | proxy] <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">auth_type</span> - Authentication type. [user | group | saml | ldap] Note: this only works for models that can guarantee WAD workers availability, i.e. those that do not disable proxy features globally. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">user_group</span> - List of remote user groups. ['cn=remote desktop users,cn=builtin,dc=devqa,dc=lab','cn=domain users,cn=users,dc=devqa,dc=lab', ...] Note: this only works for models that can guarantee WAD workers availability, i.e. those that do not disable proxy features globally. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">server_name</span> - Remote user/group server name. Note: this only works for models that can guarantee WAD workers availability, i.e. those that do not disable proxy features globally. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">user_db</span> - Authentication server to contain user information. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">group_attr_type</span> - Remote user group attribute type. [*name | id] <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_policy6
        <li><span class="li-head">firewall_policy6</span> - List traffic statistics for IPv6 policies. 
        <ul class="ul-self">
                <li><span class="li-required">policyid</span> - Filter: Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_proxy-policy
        <li><span class="li-head">firewall_proxy-policy</span> - List traffic statistics for all explicit proxy policies. 
        <ul class="ul-self">
                <li><span class="li-required">policyid</span> - Filter: Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_proxy_sessions
        <li><span class="li-head">firewall_proxy_sessions</span> - List all active proxy sessions (optionally filtered). 
        <ul class="ul-self">
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">count</span> - Maximum number of entries to return. Valid range is [20, 1000]; if a value is specified out of that range, it will be rounded up or down. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">summary</span> - Enable/disable inclusion of session summary (setup rate, total sessions, etc). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr</span> - Source IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr</span> - Destination IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr6</span> - Source IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr6</span> - Destination IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcport</span> - Source TCP port number. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstport</span> - Destination TCP port number. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintf</span> - Source interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintf</span> - Destination interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">policyid</span> - Firewall policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">proxy-policyid</span> - Explicit proxy policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">protocol</span> - Protocol type. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">application</span> - Web application type. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">country</span> - Geographic location. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">seconds</span> - Time in seconds, since the session is established. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">since</span> - Time when the session is established. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">owner</span> - Owner. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">username</span> - Session login user name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">src_uuid</span> - UUID of source. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dst_uuid</span> - UUID of destination. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_saas-application
        <li><span class="li-head">firewall_saas-application</span> 
        
        </li>
        firewall_sdn-connector-filters
        <li><span class="li-head">firewall_sdn-connector-filters</span> - List all available filters for a specified SDN Fabric Connector. Used for Fabric Connector address objects. 
        <ul class="ul-self">
                <li><span class="li-required">connector</span> - Name of the SDN Fabric Connector to get the filters from. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        firewall_security-policy
        <li><span class="li-head">firewall_security-policy</span> - List IPS engine statistics for security policies. 
        <ul class="ul-self">
                <li><span class="li-required">policyid</span> - Filter: Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_session
        <li><span class="li-head">firewall_session</span> - List all active firewall sessions (optionally filtered). 
        <ul class="ul-self">
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">count</span> - Maximum number of entries to return. Valid range is [20, 1000]; if a value is specified out of that range, it will be rounded up or down. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">summary</span> - Enable/disable inclusion of session summary (setup rate, total sessions, etc). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sourceport</span> - Filter: Source port. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">policyid</span> - Filter: Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">security-policyid</span> - Filter: Security Policy ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">application</span> - Filter: Application PROTO/PORT. (e.g. "TCP/443") <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">protocol</span> - Filter: Protocol name [all|igmp|tcp|udp|icmp|etc]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">destport</span> - Filter: Destination port. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintf</span> - Filter: Source interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintf</span> - Filter: Destination interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintfrole</span> - Filter: Source interface roles. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintfrole</span> - Filter: Destination interface roles. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">source</span> - Filter: Source IP address. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcuuid</span> - Filter: Source UUID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">destination</span> - Filter: Destination IP address. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstuuid</span> - Filter: Destination UUID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">username</span> - Filter: Authenticated username. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">shaper</span> - Filter: Forward traffic shaper name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">country</span> - Filter: Destination country name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">owner</span> - Filter: Destination owner. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">natsourceaddress</span> - Filter: NAT source address. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">natsourceport</span> - Filter: NAT source port. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">filter-csf</span> - Filter: Include sessions from downstream fortigates. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">since</span> - Filter: Only return sessions generated since this Unix timestamp. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">seconds</span> - Filter: Only return sessions generated in the last N seconds. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">web-domain</span> - Filter: Web domain. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">web-category</span> - Filter: Web category. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">fortiasic</span> - Filter: 1 to include NPU accelerated sessions, 0 to exclude. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_sessions
        <li><span class="li-head">firewall_sessions</span> - List all active firewall sessions (optionally filtered). 
        <ul class="ul-self">
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">count</span> - Maximum number of entries to return. Valid range is [20, 1000]; if a value is specified out of that range, it will be rounded up or down. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">summary</span> - Enable/disable inclusion of session summary (setup rate, total sessions, etc). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcport</span> - Source port. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">policyid</span> - Policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">security-policyid</span> - Filter: Security Policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">application</span> - Application ID, or application PROTO/PORT pair. (e.g. "TCP/443") <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">protocol</span> - Protocol name [all|igmp|tcp|udp|icmp|etc]. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstport</span> - Destination port. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintf</span> - Source interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintf</span> - Destination interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintfrole</span> - Source interface roles. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintfrole</span> - Filter: Destination interface roles. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr</span> - Source IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr6</span> - Source IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcuuid</span> - Source UUID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr</span> - Destination IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr6</span> - Destination IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstuuid</span> - Destination UUID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">username</span> - Authenticated username. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">shaper</span> - Forward traffic shaper name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">country</span> - Destination country name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">owner</span> - Destination owner. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">natsourceaddress</span> - NAT source address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">natsourceport</span> - NAT source port. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">since</span> - Only return sessions generated since this Unix timestamp. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">seconds</span> - Only return sessions generated in the last N seconds. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">fortiasic</span> - "true" to show NPU accelerated sessions only, false to exclude. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">nturbo</span> - "true" to include nTurbo sessions, false to exclude. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_shaper
        <li><span class="li-head">firewall_shaper</span> - List of statistics for configured firewall shared traffic shapers. 
        <ul class="ul-self">
                <li><span class="li-required">shaper_name</span> - Filter the result by shaper name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_shaper_multi-class-shaper
        <li><span class="li-head">firewall_shaper_multi-class-shaper</span> 
        
        </li>
        firewall_uuid-list
        <li><span class="li-head">firewall_uuid-list</span> 
        
        </li>
        firewall_uuid-type-lookup
        <li><span class="li-head">firewall_uuid-type-lookup</span> - Retrieve a mapping of UUIDs to their firewall object type for given UUIDs. 
        <ul class="ul-self">
                <li><span class="li-required">uuids</span> - List of UUIDs to be resolved. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        firewall_vip-overlap
        <li><span class="li-head">firewall_vip-overlap</span> 
        
        </li>
        firmware_extension-device
        <li><span class="li-head">firmware_extension-device</span> - Retrieve a list of recommended firmwares for the specified extension device type. 
        <ul class="ul-self">
                <li><span class="li-required">type</span> - Extension device type to get recommended firmwares for. [fortiswitch|fortiap|fortiextender] <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">timeout</span> - FortiGuard connection timeout. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">version</span> - Target firmware version of the parent FortiGate. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        forticonverter_custom-operation_status
        <li><span class="li-head">forticonverter_custom-operation_status</span> - Get the current status for a custom FortiConverter operation that was executed. 
        <ul class="ul-self">
                <li><span class="li-required">id</span> - Operation ID. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_download_ready
        <li><span class="li-head">forticonverter_download_ready</span> - Check if config file from FortiConverter is ready for download. 
        <ul class="ul-self">
                <li><span class="li-required">ticket_id</span> - Service ticket ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">extension</span> - File extension [pdf|conf]. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_download_status
        <li><span class="li-head">forticonverter_download_status</span> - Retrieve download status for converted config. 
        <ul class="ul-self">
                <li><span class="li-required">ticket_id</span> - Service ticket ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">extension</span> - File extension [pdf|conf]. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_eligibility
        <li><span class="li-head">forticonverter_eligibility</span> 
        
        </li>
        forticonverter_file_download
        <li><span class="li-head">forticonverter_file_download</span> - Download processed config sent by FortiConverter. 
        <ul class="ul-self">
                <li><span class="li-required">ticket_id</span> - Service ticket ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">extension</span> - File extension [pdf|conf]. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_intf-list
        <li><span class="li-head">forticonverter_intf-list</span> - Retrieve source interface list. 
        <ul class="ul-self">
                <li><span class="li-required">ticket_id</span> - Service ticket ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_intf-mapping
        <li><span class="li-head">forticonverter_intf-mapping</span> - Retrieve submitted physical interface mapping. 
        <ul class="ul-self">
                <li><span class="li-required">ticket_id</span> - Service ticket ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_mgmt-intf
        <li><span class="li-head">forticonverter_mgmt-intf</span> - Retrieve submitted management interface details. 
        <ul class="ul-self">
                <li><span class="li-required">ticket_id</span> - Service ticket ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_notes
        <li><span class="li-head">forticonverter_notes</span> - Retrieve submitted contact details and conversion notes. 
        <ul class="ul-self">
                <li><span class="li-required">ticket_id</span> - Service ticket ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_sn-list
        <li><span class="li-head">forticonverter_sn-list</span> - Retrieve source FortiGate serials that can upload their config. 
        <ul class="ul-self">
                <li><span class="li-required">ticket_id</span> - Service ticket ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        forticonverter_ticket_status
        <li><span class="li-head">forticonverter_ticket_status</span> 
        
        </li>
        fortiguard_answers
        <li><span class="li-head">fortiguard_answers</span> - Retrieve a list of questions on answers.fortinet.com 
        <ul class="ul-self">
                <li><span class="li-required">page</span> - Page number to retrieve. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">pagesize</span> - Page size of a list of response. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sortkey</span> - Sort key of a list of response. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">topics</span> - Topic to retrieve. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">limit</span> - Limit of the number of entries. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        fortiguard_redirect-portal
        <li><span class="li-head">fortiguard_redirect-portal</span> 
        
        </li>
        fortiguard_service-communication-stats
        <li><span class="li-head">fortiguard_service-communication-stats</span> - Retrieve historical statistics for communication with FortiGuard services. 
        <ul class="ul-self">
                <li><span class="li-required">service_type</span> - To get stats for [forticare|fortiguard_download|fortiguard_query|forticloud_log|fortisandbox_cloud|fortiguard.com|sdns|fortitoken_registration|sms_service]. Defaults to all stats if not provided. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">timeslot</span> - History timeslot of stats [1_hour|24_hour|1_week]. Defaults to all timeslots if not provided. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        fortiview_historical-statistics
        <li><span class="li-head">fortiview_historical-statistics</span> - Retrieve historical drill-down and summary data for FortiView. 
        <ul class="ul-self">
                <li><span class="li-required">filter</span> - A map of filter keys to arrays of values. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sessionid</span> - FortiView request Session ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">device</span> - FortiView source device [disk|fortianalyzer|forticloud]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">report_by</span> - Report by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sort_by</span> - Sort by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">chart_only</span> - Only return graph values in results. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">end</span> - End timestamp. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        fortiview_proxy-statistics
        <li><span class="li-head">fortiview_proxy-statistics</span> - Retrieve drill-down and summary data for realtime proxy session FortiView statistics. 
        <ul class="ul-self">
                <li><span class="li-required">report_by</span> - Report by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sort_by</span> - Sort by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">count</span> - Maximum number of details to return. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr</span> - Source IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr</span> - Destination IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr6</span> - Source IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr6</span> - Destination IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcport</span> - Source TCP port number. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstport</span> - Destination TCP port number. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintf</span> - Source interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintf</span> - Destination interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">policyid</span> - Firewall policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">proxy-policyid</span> - Explicit proxy policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">protocol</span> - Protocol type. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">application</span> - Web application type. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">country</span> - Geographic location. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">seconds</span> - Time in seconds, since the session is established. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">since</span> - Time when the session is established. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">owner</span> - Owner. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">username</span> - Session login user name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcuuid</span> - UUID of source. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstuuid</span> - UUID of destination. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        fortiview_realtime-proxy-statistics
        <li><span class="li-head">fortiview_realtime-proxy-statistics</span> - Retrieve realtime drill-down and summary data for proxy session FortiView statistics. 
        <ul class="ul-self">
                <li><span class="li-required">report_by</span> - Report by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sort_by</span> - Sort by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr</span> - Source IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr</span> - Destination IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr6</span> - Source IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr6</span> - Destination IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcport</span> - Source TCP port number. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstport</span> - Destination TCP port number. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintf</span> - Source interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintf</span> - Destination interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">policyid</span> - Firewall policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">proxy-policyid</span> - Explicit proxy policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">protocol</span> - Protocol type. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">application</span> - Web application type. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">country</span> - Geographic location. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">seconds</span> - Time in seconds, since the session is established. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">since</span> - Time when the session is established. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">owner</span> - Owner. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">username</span> - Session login user name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcuuid</span> - UUID of source. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstuuid</span> - UUID of destination. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        fortiview_realtime-statistics
        <li><span class="li-head">fortiview_realtime-statistics</span> - Retrieve realtime drill-down and summary data for FortiView. 
        <ul class="ul-self">
                <li><span class="li-required">srcaddr</span> - Source IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr</span> - Destination IPv4 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcaddr6</span> - Source IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstaddr6</span> - Destination IPv6 address. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcport</span> - Source TCP port number. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstport</span> - Destination TCP port number. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintf</span> - Source interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcintfrole</span> - Source interface role name. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintf</span> - Destination interface name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstintfrole</span> - Destination interface role name. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">policyid</span> - Firewall policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">security-policyid</span> - NGFW policy ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">protocol</span> - Protocol type. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">web-category</span> - Web category ID. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">web-domain</span> - Web domain name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">application</span> - Web application type. It can be ID, or protocol/port pair. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">country</span> - Geographic location. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">seconds</span> - Time in seconds, since the session is established. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">since</span> - Time when the session is established. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">owner</span> - Owner. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">username</span> - Session login user name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">shaper</span> - Traffic shaper name. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcuuid</span> - UUID of source. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">dstuuid</span> - UUID of destination. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sessionid</span> - FortiView request Session ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">report_by</span> - Report by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sort_by</span> - Sort by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        fortiview_sandbox-file-details
        <li><span class="li-head">fortiview_sandbox-file-details</span> - Retrieve FortiSandbox analysis details for a specific file checksum. 
        <ul class="ul-self">
                <li><span class="li-required">checksum</span> - Checksum of a specific file that has been analyzed by the connected FortiSandbox. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        fortiview_sandbox-file-list
        <li><span class="li-head">fortiview_sandbox-file-list</span> 
        
        </li>
        fortiview_statistics
        <li><span class="li-head">fortiview_statistics</span> - Retrieve drill-down and summary data for FortiView (both realtime and historical). Deprecated, use /api/v2/monitor/fortiview/realtime-statistics or /api/v2/monitor/fortiview/historical-statistics instead. 
        <ul class="ul-self">
                <li><span class="li-required">realtime</span> - Set to true to retrieve realtime results (from kernel). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">filter</span> - A map of filter keys to arrays of values. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sessionid</span> - FortiView request Session ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">device</span> - FortiView source device [disk|fortianalyzer|forticloud]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">report_by</span> - Report by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sort_by</span> - Sort by field. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">chart_only</span> - Only return graph values in results. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">end</span> - End timestamp. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        geoip_geoip-query
        <li><span class="li-head">geoip_geoip-query</span> - Retrieve location details for IPs queried against FortiGuard's geoip service. 
        <ul class="ul-self">
                <li><span class="li-required">ip_addresses</span> - One or more IP address strings to query for location details. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        ips_anomaly
        <li><span class="li-head">ips_anomaly</span> 
        
        </li>
        ips_exceed-scan-range
        <li><span class="li-head">ips_exceed-scan-range</span> - Returns a list of applications that exceed the scan range from a list of application IDs. 
        <ul class="ul-self">
                <li><span class="li-required">ids</span> - List of application IDs. <span class="li-normal">type: array</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        ips_hold-signatures
        <li><span class="li-head">ips_hold-signatures</span> - Return a list of IPS signatures that are on hold due to active hold time. 
        <ul class="ul-self">
                <li><span class="li-required">ips_sensor</span> - Optional filter: Provide the name of the IPS sensor to retrieve only the hold signatures being used by that sensor. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        ips_metadata
        <li><span class="li-head">ips_metadata</span> 
        
        </li>
        ips_rate-based
        <li><span class="li-head">ips_rate-based</span> 
        
        </li>
        ips_session_performance
        <li><span class="li-head">ips_session_performance</span> 
        
        </li>
        license_fortianalyzer-status
        <li><span class="li-head">license_fortianalyzer-status</span> 
        
        </li>
        license_forticare-org-list
        <li><span class="li-head">license_forticare-org-list</span> 
        
        </li>
        license_forticare-resellers
        <li><span class="li-head">license_forticare-resellers</span> - Get current FortiCare resellers for the requested country. 
        <ul class="ul-self">
                <li><span class="li-required">country_code</span> - FortiGuard country code <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        license_status
        <li><span class="li-head">license_status</span> 
        
        </li>
        log_av-archive_download
        <li><span class="li-head">log_av-archive_download</span> - Download file quarantined by AntiVirus. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Checksum for quarantined file. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        log_current-disk-usage
        <li><span class="li-head">log_current-disk-usage</span> 
        
        </li>
        log_device_state
        <li><span class="li-head">log_device_state</span> - Retrieve information on state of log devices. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope from which to retrieve log device state [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        log_event
        <li><span class="li-head">log_event</span> 
        
        </li>
        log_feature-set
        <li><span class="li-head">log_feature-set</span> 
        
        </li>
        log_fortianalyzer
        <li><span class="li-head">log_fortianalyzer</span> - Return FortiAnalyzer/FortiManager log status. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope from which to test the connectivity of the FortiAnalyzer address [vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">server</span> - FortiAnalyzer/FortiManager address. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">srcip</span> - The IP to use to make the request to the FortiAnalyzer [<ip>|auto]. When set to "auto" it will use the FortiGate's routing table to determine the IP to make the request from. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        log_fortianalyzer-queue
        <li><span class="li-head">log_fortianalyzer-queue</span> - Retrieve information on FortiAnalyzer's queue state. Note:- FortiAnalyzer logs are queued only if upload-option is realtime. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope from which to retrieve FortiAnalyzer's queue state [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        log_forticloud
        <li><span class="li-head">log_forticloud</span> 
        
        </li>
        log_forticloud-report-list
        <li><span class="li-head">log_forticloud-report-list</span> 
        
        </li>
        log_forticloud-report_download
        <li><span class="li-head">log_forticloud-report_download</span> - Download PDF report from FortiCloud. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - FortiCloud Report ID. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">report_name</span> - Full filename of the report. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">inline</span> - Set to 1 to download the report inline. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        log_forticloud_connection
        <li><span class="li-head">log_forticloud_connection</span> 
        
        </li>
        log_historic-daily-remote-logs
        <li><span class="li-head">log_historic-daily-remote-logs</span> - Returns the amount of logs in bytes sent daily to a remote logging service (FortiCloud or FortiAnalyzer). 
        <ul class="ul-self">
                <li><span class="li-required">server</span> - Service name [forticloud | fortianalyzer | fortianalyzercloud | nulldevice]. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        log_hourly-disk-usage
        <li><span class="li-head">log_hourly-disk-usage</span> 
        
        </li>
        log_ips-archive_download
        <li><span class="li-head">log_ips-archive_download</span> - Download IPS/application control packet capture files. Uses configured log display device. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - IPS archive ID. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">pcap_no</span> - Packet capture roll number (required when log device is 'disk') <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">pcap_category</span> - Packet capture category (required when log device is 'disk') <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        log_local-report-list
        <li><span class="li-head">log_local-report-list</span> 
        
        </li>
        log_local-report_download
        <li><span class="li-head">log_local-report_download</span> - Download local report 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Local report name. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">layout</span> - Layout name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        log_policy-archive_download
        <li><span class="li-head">log_policy-archive_download</span> - Download policy-based packet capture archive. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Session ID (from traffic log). <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">srcip</span> - Source IP. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">dstip</span> - Destination IP. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        log_stats
        <li><span class="li-head">log_stats</span> - Return number of logs sent by category per day for a specific log device. 
        <ul class="ul-self">
                <li><span class="li-required">dev</span> - Log device [*memory | disk | fortianalyzer | forticloud]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        network_arp
        <li><span class="li-head">network_arp</span> 
        
        </li>
        network_ddns_lookup
        <li><span class="li-head">network_ddns_lookup</span> - Check DDNS FQDN availability. 
        <ul class="ul-self">
                <li><span class="li-required">domain</span> - Filter: domain to check. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        network_ddns_servers
        <li><span class="li-head">network_ddns_servers</span> 
        
        </li>
        network_dns_latency
        <li><span class="li-head">network_dns_latency</span> 
        
        </li>
        network_fortiguard_live-services-latency
        <li><span class="li-head">network_fortiguard_live-services-latency</span> 
        
        </li>
        network_lldp_neighbors
        <li><span class="li-head">network_lldp_neighbors</span> - List all active LLDP neighbors. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope of LLDP neighbors [*vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">port</span> - Filter: specific port name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        network_lldp_ports
        <li><span class="li-head">network_lldp_ports</span> - List all active LLDP ports. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: specific port name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">scope</span> - Scope of LLDP ports [*vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        network_reverse-ip-lookup
        <li><span class="li-head">network_reverse-ip-lookup</span> - Retrieve the resolved DNS domain name for a given IP address. 
        <ul class="ul-self">
                <li><span class="li-required">ip</span> - IP address (in dot-decimal notation). <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        nsx_instance
        <li><span class="li-head">nsx_instance</span> - List NSX instances and their resource statistics. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: NSX SDN name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        nsx_service_status
        <li><span class="li-head">nsx_service_status</span> - Retrieve NSX service status. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: NSX SDN name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        registration_forticare_check-connectivity
        <li><span class="li-head">registration_forticare_check-connectivity</span> 
        
        </li>
        registration_forticloud_device-status
        <li><span class="li-head">registration_forticloud_device-status</span> - Fetch device registration status from FortiCloud. Currently FortiSwitch and FortiAP are supported. 
        <ul class="ul-self">
                <li><span class="li-required">serials</span> - Serials of FortiSwitch and FortiAP to fetch registration status. <span class="li-normal">type: array</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">update_cache</span> - Clear cache and retrieve updated data. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        registration_forticloud_disclaimer
        <li><span class="li-head">registration_forticloud_disclaimer</span> 
        
        </li>
        registration_forticloud_domains
        <li><span class="li-head">registration_forticloud_domains</span> 
        
        </li>
        router_bgp_neighbors
        <li><span class="li-head">router_bgp_neighbors</span> 
        
        </li>
        router_bgp_neighbors-statistics
        <li><span class="li-head">router_bgp_neighbors-statistics</span> - Retrieve BGP neighbors statistics, including number of IPv4 or IPv6 BGP neighbors. 
        <ul class="ul-self">
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_bgp_neighbors6
        <li><span class="li-head">router_bgp_neighbors6</span> 
        
        </li>
        router_bgp_paths
        <li><span class="li-head">router_bgp_paths</span> 
        
        </li>
        router_bgp_paths-statistics
        <li><span class="li-head">router_bgp_paths-statistics</span> - Retrieve BGP paths statistics, including number of IPv4 or IPv6 BGP paths. 
        <ul class="ul-self">
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_bgp_paths6
        <li><span class="li-head">router_bgp_paths6</span> 
        
        </li>
        router_charts
        <li><span class="li-head">router_charts</span> - Retrieve routing chart statistics, including a map of interfaces and route types. 
        <ul class="ul-self">
                <li><span class="li-required">operator</span> - Filter logic [*and|or]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - IP version (4|6). If not present, IPv4 and IPv6 will be returned. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_mask</span> - Filter: IP/netmask. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">gateway</span> - Filter: gateway. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">type</span> - Filter: route type. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">origin</span> - Filter: router origin. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">interface</span> - Filter: interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_ipv4
        <li><span class="li-head">router_ipv4</span> - List all active IPv4 routing table entries. 
        <ul class="ul-self">
                <li><span class="li-required">operator</span> - Filter logic [*and|or]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_mask</span> - Filter: IP/netmask. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">gateway</span> - Filter: gateway. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">type</span> - Filter: route type. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">origin</span> - Filter: router origin. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">interface</span> - Filter: interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_ipv6
        <li><span class="li-head">router_ipv6</span> - List all active IPv6 routing table entries. 
        <ul class="ul-self">
                <li><span class="li-required">operator</span> - Filter logic [*and|or]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_mask</span> - Filter: IP/netmask. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">gateway</span> - Filter: gateway. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">type</span> - Filter: route type. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">origin</span> - Filter: router origin. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">interface</span> - Filter: interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_lookup
        <li><span class="li-head">router_lookup</span> - Performs a route lookup by querying the routing table. 
        <ul class="ul-self">
                <li><span class="li-required">ipv6</span> - Perform an IPv6 lookup. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">destination</span> - Destination IP/FQDN. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        router_lookup-policy
        <li><span class="li-head">router_lookup-policy</span> - Performs a route lookup by querying the policy routing table. 
        <ul class="ul-self">
                <li><span class="li-required">ipv6</span> - Perform an IPv6 lookup. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">destination</span> - Destination IP/FQDN. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">source</span> - Source IP/FQDN. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">destination_port</span> - Destination Port. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">source_port</span> - Source Port. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">interface_name</span> - Incoming Interface. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">protocol_number</span> - IP Protocol Number. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_lookup_ha-peer
        <li><span class="li-head">router_lookup_ha-peer</span> - Performs a route lookup by querying the routing table of an HA peer. 
        <ul class="ul-self">
                <li><span class="li-required">serial</span> - HA peer serial number. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">ipv6</span> - Perform an IPv6 lookup. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">destination</span> - Destination IP/FQDN. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        router_ospf_neighbors
        <li><span class="li-head">router_ospf_neighbors</span> 
        
        </li>
        router_policy
        <li><span class="li-head">router_policy</span> - Retrieve a list of active IPv4 policy routes. 
        <ul class="ul-self">
                <li><span class="li-required">count_only</span> - Returns the number of IPv4 policy routes only. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_policy6
        <li><span class="li-head">router_policy6</span> - Retrieve a list of active IPv6 policy routes. 
        <ul class="ul-self">
                <li><span class="li-required">count_only</span> - Returns the number of IPv6 policy routes only. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_sdwan_routes
        <li><span class="li-head">router_sdwan_routes</span> 
        
        </li>
        router_sdwan_routes-statistics
        <li><span class="li-head">router_sdwan_routes-statistics</span> - Retrieve SD-WAN routes statistics, including number of IPv4 or IPv6 SD-WAN routes. 
        <ul class="ul-self">
                <li><span class="li-required">ip_version</span> - IP version [*ipv4 | ipv6 | ipboth]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        router_sdwan_routes6
        <li><span class="li-head">router_sdwan_routes6</span> 
        
        </li>
        router_statistics
        <li><span class="li-head">router_statistics</span> - Retrieve routing table statistics, including number of matched routes. 
        <ul class="ul-self">
                <li><span class="li-required">operator</span> - Filter logic [*and|or]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_version</span> - IP version (4|6). If not present, IPv4 and IPv6 will be returned. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ip_mask</span> - Filter: IP/netmask. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">gateway</span> - Filter: gateway. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">type</span> - Filter: route type. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">origin</span> - Filter: router origin. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">interface</span> - Filter: interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        service_ldap_query
        <li><span class="li-head">service_ldap_query</span> - Retrieve LDAP server information and LDAP entries. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of the LDAP server setting object. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">server_info_only</span> - Only retrieve server information. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">skip_schema</span> - Explicitly skip schema retrieval. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ldap_filter</span> - LDAP filter string. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ldap</span> - Object containing overriden values of the LDAP server setting object. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_detected-device
        <li><span class="li-head">switch-controller_detected-device</span> 
        
        </li>
        switch-controller_fsw-firmware
        <li><span class="li-head">switch-controller_fsw-firmware</span> - Retrieve a list of recommended firmware for managed FortiSwitches. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">timeout</span> - FortiGuard connection timeout (defaults to 3 seconds). <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">version</span> - Target firmware version of the parent FortiGate. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_isl-lockdown_status
        <li><span class="li-head">switch-controller_isl-lockdown_status</span> - Get current status of ISL lockdown. 
        <ul class="ul-self">
                <li><span class="li-required">fortilink</span> - FortiLink interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        switch-controller_known-nac-device-criteria-list
        <li><span class="li-head">switch-controller_known-nac-device-criteria-list</span> 
        
        </li>
        switch-controller_managed-switch
        <li><span class="li-head">switch-controller_managed-switch</span> - Retrieve statistics for configured FortiSwitches. Deprecated. It will be removed in 7.2.       It's replaced by /api/v2/monitor/switch-controller/managed-switch/status for faster performance. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">poe</span> - Filter: Retrieve PoE statistics for ports of configured FortiSwitches. Port power usage is in Watt units. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">port_stats</span> - Filter: Retrieve tx/rx statistics for ports of configured FortiSwitches. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">qos_stats</span> - Filter: Retrieve QoS statistics for ports of configured FortiSwitches. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">stp_status</span> - Filter: Retrieve STP status for ports of configured FortiSwitches. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">igmp_snooping_group</span> - Filter: Retrieve IGMP Snooping group for configured FortiSwitches. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">transceiver</span> - Filter: Retrieve transceiver information for ports of configured FortiSwitches. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_bios
        <li><span class="li-head">switch-controller_managed-switch_bios</span> - Get a list of BIOS info by managed FortiSwitches. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_cable-status
        <li><span class="li-head">switch-controller_managed-switch_cable-status</span> - Diagnose cable information for a port. Virtual FortiSwitches and FortiLink ports are not supported. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">port</span> - Name of managed FortiSwitch port. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_dhcp-snooping
        <li><span class="li-head">switch-controller_managed-switch_dhcp-snooping</span> 
        
        </li>
        switch-controller_managed-switch_faceplate-xml
        <li><span class="li-head">switch-controller_managed-switch_faceplate-xml</span> - Retrieve XML for rendering FortiSwitch faceplate widget. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of managed FortiSwitch. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_health
        <li><span class="li-head">switch-controller_managed-switch_health</span> - Retrieve health-check statistics for managed FortiSwitches. To be deprecated in FortiOS v7.6.0, replaced by /api/v2/monitor/switch-controller/managed-switch/health-status. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_health-status
        <li><span class="li-head">switch-controller_managed-switch_health-status</span> - Retrieve health-check statistics for managed FortiSwitches. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">serial</span> - Filter: FortiSwitch Serial. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_models
        <li><span class="li-head">switch-controller_managed-switch_models</span> 
        
        </li>
        switch-controller_managed-switch_port-health
        <li><span class="li-head">switch-controller_managed-switch_port-health</span> - Retrieve port health statistics for managed FortiSwitches. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_port-stats
        <li><span class="li-head">switch-controller_managed-switch_port-stats</span> - Retrieve port statistics for configured FortiSwitches. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_status
        <li><span class="li-head">switch-controller_managed-switch_status</span> - Retrieve statistics for configured FortiSwitches. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_managed-switch_transceivers
        <li><span class="li-head">switch-controller_managed-switch_transceivers</span> 
        
        </li>
        switch-controller_managed-switch_tx-rx
        <li><span class="li-head">switch-controller_managed-switch_tx-rx</span> - Retrieve the transceiver Tx and Rx power for a specific port. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: FortiSwitch ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">port</span> - Name of the port. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        switch-controller_matched-devices
        <li><span class="li-head">switch-controller_matched-devices</span> - Return a list of devices that match NAC and/or dynamic port policies. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - FortiSwitch ID. Will return all devices if no ID is provided. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_dynamic</span> - If true, include devices that match dynamic port policies. Default value is false. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">mac</span> - FortiSwitch client MAC address. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        switch-controller_mclag-icl_eligible-peer
        <li><span class="li-head">switch-controller_mclag-icl_eligible-peer</span> - Find a pair of FortiSwitches that are eligible to form a tier-1 MC-LAG. 
        <ul class="ul-self">
                <li><span class="li-required">fortilink</span> - FortiLink interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        switch-controller_mclag-icl_tier-plus-candidates
        <li><span class="li-head">switch-controller_mclag-icl_tier-plus-candidates</span> - Find a pair of FortiSwitches that are eligible to form a tier 2/3 MC-LAG. 
        <ul class="ul-self">
                <li><span class="li-required">fortilink</span> - FortiLink interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">parent_peer1</span> - FortiSwitch ID for MC-LAG parent peer 1. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">parent_peer2</span> - FortiSwitch ID for MC-LAG parent peer 2. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">is_tier2</span> - Whether candidates are for a Tier 2 MC-LAG. <span class="li-normal">type: boolean</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        switch-controller_nac-device_stats
        <li><span class="li-head">switch-controller_nac-device_stats</span> 
        
        </li>
        switch-controller_validate-switch-prefix
        <li><span class="li-head">switch-controller_validate-switch-prefix</span> - Validate a FortiSwitch serial number prefix. Deprecated in 7.2 replaced by /api/v2/monitor/switch-controller/managed-switch/models. 
        <ul class="ul-self">
                <li><span class="li-required">prefix</span> - Prefix of FortiSwitch serial number. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_3g-modem
        <li><span class="li-head">system_3g-modem</span> 
        
        </li>
        system_5g-modem_status
        <li><span class="li-head">system_5g-modem_status</span> - Retrieve the 5G modem status. 
        <ul class="ul-self">
                <li><span class="li-required">modem</span> - Modem to query status [all|1|2]. Defaults to all modems if not provided. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_acme-certificate-status
        <li><span class="li-head">system_acme-certificate-status</span> - Get ACME certificate status. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Check if specific certificate is available. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">scope</span> - Scope of certificate [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_acquired-dns
        <li><span class="li-head">system_acquired-dns</span> 
        
        </li>
        system_automation-action_stats
        <li><span class="li-head">system_automation-action_stats</span> - Statistics for automation actions. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: Automation action name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_automation-stitch_stats
        <li><span class="li-head">system_automation-stitch_stats</span> - Statistics for automation stitches. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: Automation stitch name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_available-certificates
        <li><span class="li-head">system_available-certificates</span> - Get available certificates. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope of certificate [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_remote</span> - Include remote certificates. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_ca</span> - Include certificate authorities. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_crl</span> - Include certificate revocation lists. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">mkey</span> - Check if specific certificate is available. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">find_all_references</span> - Include reference counts across all VDOMs when scope is global. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_available-interfaces
        <li><span class="li-head">system_available-interfaces</span> - Retrieve a list of all interfaces along with some meta information regarding their availability. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of the interface. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_ha</span> - Incude HA management interfaces. Will only show if accessing the root VDOM interfaces. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">view_type</span> - Deprecated: Use format instead <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">scope</span> - Scope of interface list [vdom|global] <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_available-interfaces_meta
        <li><span class="li-head">system_available-interfaces_meta</span> - Get metadata for the system/available-interfaces API endpoint. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope of interface list [*vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_ha</span> - Incude HA management interfaces. Will only show if accessing the root VDOM interfaces. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_botnet
        <li><span class="li-head">system_botnet</span> - List all known IP-based botnet entries in FortiGuard botnet database. 
        <ul class="ul-self">
                <li><span class="li-required">include_hit_only</span> - Include entries with hits only. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_botnet-domains
        <li><span class="li-head">system_botnet-domains</span> 
        
        </li>
        system_botnet-domains_hits
        <li><span class="li-head">system_botnet-domains_hits</span> 
        
        </li>
        system_botnet-domains_stat
        <li><span class="li-head">system_botnet-domains_stat</span> 
        
        </li>
        system_botnet_stat
        <li><span class="li-head">system_botnet_stat</span> 
        
        </li>
        system_central-management_status
        <li><span class="li-head">system_central-management_status</span> - Get Central Management status. 
        <ul class="ul-self">
                <li><span class="li-required">skip_detect</span> - Skip sending a detect message to the central management device. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_certificate_download
        <li><span class="li-head">system_certificate_download</span> - Download certificate. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of certificate. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">type</span> - Type of certificate [local-cer|remote-cer|local-ca|remote-ca|local-csr|crl]. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">scope</span> - Scope of certificate [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_check-port-availability
        <li><span class="li-head">system_check-port-availability</span> - Check whether a list of TCP port ranges is available for a certain service. 
        <ul class="ul-self">
                <li><span class="li-required">port_ranges</span> - List of TCP port range objects to check against. <span class="li-normal">type: array</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">service</span> - The service in which the ports could be available. 'service' options are [reserved | sysglobal | webproxy | ftpproxy | sslvpn | slaprobe | fsso | ftm_push]. If 'service' is not specified, the port ranges availability is checked against all services. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_cluster_state
        <li><span class="li-head">system_cluster_state</span> 
        
        </li>
        system_com-log_download
        <li><span class="li-head">system_com-log_download</span> 
        
        </li>
        system_com-log_update
        <li><span class="li-head">system_com-log_update</span> 
        
        </li>
        system_config-error-log_download
        <li><span class="li-head">system_config-error-log_download</span> 
        
        </li>
        system_config-revision
        <li><span class="li-head">system_config-revision</span> 
        
        </li>
        system_config-revision_file
        <li><span class="li-head">system_config-revision_file</span> - Download a specific configuration revision. 
        <ul class="ul-self">
                <li><span class="li-required">config_id</span> - Configuration id. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_config-revision_info
        <li><span class="li-head">system_config-revision_info</span> - Retrieve meta information for a specific configuration revision. 
        <ul class="ul-self">
                <li><span class="li-required">config_id</span> - Configuration id. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_config-script
        <li><span class="li-head">system_config-script</span> 
        
        </li>
        system_config-sync_status
        <li><span class="li-head">system_config-sync_status</span> 
        
        </li>
        system_config_backup
        <li><span class="li-head">system_config_backup</span> - Backup system config 
        <ul class="ul-self">
                <li><span class="li-required">destination</span> - Configuration file destination [file*] <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">password</span> - Password to encrypt configuration data. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">scope</span> - Specify global or VDOM only backup [global | vdom]. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">vdom</span> - If 'vdom' scope specified, the name of the VDOM to backup configuration. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">password_mask</span> - True to replace all the secrects and passwords with a mask. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">file_format</span> - Configuration file format [fos* | yaml]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_config_restore-status
        <li><span class="li-head">system_config_restore-status</span> - Check the status of the restoring system configuration session. 
        <ul class="ul-self">
                <li><span class="li-required">session_id</span> - Session ID for restoring configuration. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_config_usb-filelist
        <li><span class="li-head">system_config_usb-filelist</span> 
        
        </li>
        system_crash-log_download
        <li><span class="li-head">system_crash-log_download</span> 
        
        </li>
        system_csf
        <li><span class="li-head">system_csf</span> - Retrieve a full tree of downstream FortiGates registered to the Security Fabric. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope from which to retrieve the Security Fabric tree [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">all_vdoms</span> - Include information from all VDOMs that the admin can access. Only applies for scope=vdom <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_csf_pending-authorizations
        <li><span class="li-head">system_csf_pending-authorizations</span> 
        
        </li>
        system_current-admins
        <li><span class="li-head">system_current-admins</span> 
        
        </li>
        system_debug_download
        <li><span class="li-head">system_debug_download</span> 
        
        </li>
        system_dhcp
        <li><span class="li-head">system_dhcp</span> - List all DHCP and DHCPv6 leases. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope from which to retrieve DHCP leases [vdom*|global]. Global scope is only accessible for global administrators. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ipv6</span> - Include IPv6 addresses in the response. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">interface</span> - Filter: Retrieve DHCP leases for this interface only. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_external-resource_entry-list
        <li><span class="li-head">system_external-resource_entry-list</span> - Retrieve resource file status with a list of valid/invalid entries for the specific external resource. Empty lines and comment lines are not returned. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - The external resource name to query. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">status_only</span> - Set to true to retrieve resource file status only. (Skip valid/invalid entries.) <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_notes</span> - Set to true to retrieve notes on the resource file. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">counts_only</span> - Set to true to retrive valid/invalid counts only. (Skip entries.) <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">entry</span> - Entry of external resource. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_external-resource_validate-jsonpath
        <li><span class="li-head">system_external-resource_validate-jsonpath</span> - Validate a JSON path name. 
        <ul class="ul-self">
                <li><span class="li-required">path_name</span> - The name of the JSON path to validate. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_firmware
        <li><span class="li-head">system_firmware</span> 
        
        </li>
        system_firmware_upgrade-paths
        <li><span class="li-head">system_firmware_upgrade-paths</span> 
        
        </li>
        system_fortiguard-blacklist
        <li><span class="li-head">system_fortiguard-blacklist</span> - Retrieve blacklist information for a specified IP. 
        <ul class="ul-self">
                <li><span class="li-required">ip</span> - IPv4 address to check against. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">timeout</span> - Timeout period in seconds (defaults to 5). <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_fortiguard_server-info
        <li><span class="li-head">system_fortiguard_server-info</span> 
        
        </li>
        system_fortimanager_backup-details
        <li><span class="li-head">system_fortimanager_backup-details</span> - Get the properties of a FortiManager object. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Object name. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">datasource</span> - Object datasource. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_fortimanager_backup-summary
        <li><span class="li-head">system_fortimanager_backup-summary</span> 
        
        </li>
        system_fortimanager_status
        <li><span class="li-head">system_fortimanager_status</span> - Get FortiManager status. To be deprecated in FortiOS v7.6.0, replaced by /api/v2/monitor/system/central-management/status 
        <ul class="ul-self">
                <li><span class="li-required">skip_detect</span> - Skip sending a detect message to the FortiManager. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_global-resources
        <li><span class="li-head">system_global-resources</span> 
        
        </li>
        system_global-search
        <li><span class="li-head">system_global-search</span> - Search for CMDB table objects based on search phrase. 
        <ul class="ul-self">
                <li><span class="li-required">search</span> - Phrase used for searching. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">scope</span> - Search scope [vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">search_tables</span> - Array of CMDB tables to search on. If not defined, global search function will do a search on all tables that the current user has read permission on. E.g ['firewall.address', 'firewall.address6']. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">skip_tables</span> - Array of CMDB tables to be skipped when doing global search. E.g. ['firewall.address', 'firewall.address6']. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">exact</span> - If true, only entries with exact match will be returned. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_ha-backup-hb-used
        <li><span class="li-head">system_ha-backup-hb-used</span> 
        
        </li>
        system_ha-checksums
        <li><span class="li-head">system_ha-checksums</span> 
        
        </li>
        system_ha-history
        <li><span class="li-head">system_ha-history</span> 
        
        </li>
        system_ha-hw-interface
        <li><span class="li-head">system_ha-hw-interface</span> 
        
        </li>
        system_ha-nonsync-checksums
        <li><span class="li-head">system_ha-nonsync-checksums</span> 
        
        </li>
        system_ha-peer
        <li><span class="li-head">system_ha-peer</span> - Get configuration of peer(s) in HA cluster. Uptime is expressed in seconds. 
        <ul class="ul-self">
                <li><span class="li-required">serial_no</span> - Serial number of the HA member. If not specified, fetch information for all HA members <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">vcluster_id</span> - Virtual cluster number. If not specified, fetch information for all active vclusters <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_ha-statistics
        <li><span class="li-head">system_ha-statistics</span> 
        
        </li>
        system_ha-table-checksums
        <li><span class="li-head">system_ha-table-checksums</span> - List of table checksums for members of HA cluster. 
        <ul class="ul-self">
                <li><span class="li-required">serial_no</span> - Serial number of the HA member. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">vdom_name</span> - VDOM name of the HA member. If not specified, fetch table checksums for global. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_interface
        <li><span class="li-head">system_interface</span> - Retrieve statistics for all system interfaces. 
        <ul class="ul-self">
                <li><span class="li-required">interface_name</span> - Filter: interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_vlan</span> - Enable to include VLANs in result list. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_aggregate</span> - Enable to include Aggregate interfaces in result list. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">scope</span> - Scope from which to retrieve the interface stats from [vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_interface-connected-admins-info
        <li><span class="li-head">system_interface-connected-admins-info</span> - Return admins info that are connected to current interface. 
        <ul class="ul-self">
                <li><span class="li-required">interface</span> - Interface that admins is connected through. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_interface_dhcp-status
        <li><span class="li-head">system_interface_dhcp-status</span> - Retrieve the DHCP client status of an interface. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of the interface. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">ipv6</span> - Retrieve the DHCPv6 client status. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_interface_kernel-interfaces
        <li><span class="li-head">system_interface_kernel-interfaces</span> 
        
        </li>
        system_interface_poe
        <li><span class="li-head">system_interface_poe</span> - Retrieve PoE statistics for system interfaces. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: Name of the interface to fetch PoE statistics for. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">scope</span> - Scope from which to retrieve the interface stats from [vdom|global] (default=vdom). <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_interface_poe-usage
        <li><span class="li-head">system_interface_poe-usage</span> 
        
        </li>
        system_interface_speed-test-status
        <li><span class="li-head">system_interface_speed-test-status</span> - Retrieve the current status of a speed-test with the results if finished. 
        <ul class="ul-self">
                <li><span class="li-required">id</span> - ID of the speed test. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_interface_transceivers
        <li><span class="li-head">system_interface_transceivers</span> - Get a list of transceivers being used by the FortiGate. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope from which to retrieve the transceiver information from [vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_ipam_list
        <li><span class="li-head">system_ipam_list</span> 
        
        </li>
        system_ipam_status
        <li><span class="li-head">system_ipam_status</span> 
        
        </li>
        system_ipam_utilization
        <li><span class="li-head">system_ipam_utilization</span> 
        
        </li>
        system_ipconf
        <li><span class="li-head">system_ipconf</span> - Determine if there is an IP conflict for a specific IP using ARP. 
        <ul class="ul-self">
                <li><span class="li-required">devs</span> - List of interfaces to check for conflict. <span class="li-normal">type: array</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">ipaddr</span> - IPv4 address to check for conflict. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_link-monitor
        <li><span class="li-head">system_link-monitor</span> - Retrieve per-interface statistics for active link monitors. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of link monitor. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_lte-modem_status
        <li><span class="li-head">system_lte-modem_status</span> 
        
        </li>
        system_modem
        <li><span class="li-head">system_modem</span> 
        
        </li>
        system_monitor-sensor
        <li><span class="li-head">system_monitor-sensor</span> 
        
        </li>
        system_nat46-ippools
        <li><span class="li-head">system_nat46-ippools</span> 
        
        </li>
        system_ntp_status
        <li><span class="li-head">system_ntp_status</span> 
        
        </li>
        system_object-tagging_usage
        <li><span class="li-head">system_object-tagging_usage</span> 
        
        </li>
        system_object_usage
        <li><span class="li-head">system_object_usage</span> - Retrieve all objects that are currently using as well as objects that can use the given object. 
        <ul class="ul-self">
                <li><span class="li-required">q_path</span> - The CMDB table's path <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">q_name</span> - The CMDB table's name <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">qtypes</span> - List of CMDB table qTypes <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">scope</span> - Scope of resource [vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">mkey</span> - The mkey for the object <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">child_path</span> - The child path for the object <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_performance_status
        <li><span class="li-head">system_performance_status</span> 
        
        </li>
        system_resolve-fqdn
        <li><span class="li-head">system_resolve-fqdn</span> - Resolves the provided FQDNs to FQDN -> IP mappings. 
        <ul class="ul-self">
                <li><span class="li-required">ipv6</span> - Resolve for the AAAA record? <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">fqdn</span> - List of FQDNs to be resolved <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_resource_usage
        <li><span class="li-head">system_resource_usage</span> - Retreive current and historical usage data for a provided resource. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope of resource [vdom|global]. This parameter is only applicable if the FGT is in VDOM mode. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">resource</span> - Resource to get usage data for [cpu|mem|disk|session|session6|setuprate|setuprate6|disk_lograte|faz_lograte|forticloud_lograte|gtp_tunnel|gtp_tunnel_setup_rate]. Defaults to all resources if not provided. Additionally, [npu_session|npu_session6] data is available for devices that have an NPU and [nturbo_session|nturbo_session6] data is available for NP6 devices that support NTurbo. [gtp_tunnel|gtp_tunnel_setup_rate] data is available for carrier platforms only. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">interval</span> - Time interval of resource usage [1-min|10-min|30-min|1-hour|12-hour|24-hour]. Defaults to all intervals if not provided. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_running-processes
        <li><span class="li-head">system_running-processes</span> 
        
        </li>
        system_sandbox_cloud-regions
        <li><span class="li-head">system_sandbox_cloud-regions</span> 
        
        </li>
        system_sandbox_connection
        <li><span class="li-head">system_sandbox_connection</span> - Test the connection to FortiSandbox. 
        <ul class="ul-self">
                <li><span class="li-required">server</span> - IP/FQDN of the FortiSandbox to test. Uses the configured FortiSandbox IP/FQDN if no server is provided. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_sandbox_detect
        <li><span class="li-head">system_sandbox_detect</span> 
        
        </li>
        system_sandbox_stats
        <li><span class="li-head">system_sandbox_stats</span> 
        
        </li>
        system_sandbox_status
        <li><span class="li-head">system_sandbox_status</span> 
        
        </li>
        system_sandbox_test-connect
        <li><span class="li-head">system_sandbox_test-connect</span> - Test the connectivity of a given FortiSandbox IP. 
        <ul class="ul-self">
                <li><span class="li-required">server</span> - IP/FQDN of the FortiSandbox to test. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_sdn-connector_nsx-security-tags
        <li><span class="li-head">system_sdn-connector_nsx-security-tags</span> - Retrieve a list of NSX security tags for connected NSX servers. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: NSX SDN connector name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_sdn-connector_status
        <li><span class="li-head">system_sdn-connector_status</span> - Retrieve connection status for SDN connectors. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Filter: SDN connector name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">type</span> - Filter: SDN connector type. Ignored if mkey is specified. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_security-rating
        <li><span class="li-head">system_security-rating</span> - Retrieve a Security Rating report result. Without ID specified, returns the most recent result. 
        <ul class="ul-self">
                <li><span class="li-required">id</span> - Report ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">report_type</span> - Report type to view, Security Report when unspecified. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">scope</span> - Scope of the report [vdom*|global]. Global scope is only accessible for global administrators. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_security-rating_history
        <li><span class="li-head">system_security-rating_history</span> - Retrieve Security Rating history. 
        <ul class="ul-self">
                <li><span class="li-required">report_type</span> - Security Rating report history to view, view Security Report when unspecified. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_security-rating_lang
        <li><span class="li-head">system_security-rating_lang</span> - Returns the requested Security Rating language mapping. 
        <ul class="ul-self">
                <li><span class="li-required">key</span> - Requested language mapping (en, fr, big5, euc-kr, GB2312, pg, sp, x-sjis). <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_security-rating_status
        <li><span class="li-head">system_security-rating_status</span> - Check if a Security Rating report is currently running. 
        <ul class="ul-self">
                <li><span class="li-required">id</span> - Report ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">report_type</span> - Report type to view, Security Report when unspecified. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">progress</span> - Query report progress. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_security-rating_supported-reports
        <li><span class="li-head">system_security-rating_supported-reports</span> 
        
        </li>
        system_sensor-info
        <li><span class="li-head">system_sensor-info</span> 
        
        </li>
        system_sniffer
        <li><span class="li-head">system_sniffer</span> 
        
        </li>
        system_sniffer_download
        <li><span class="li-head">system_sniffer_download</span> - Download a stored packet capture. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - ID of packet capture entry. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_status
        <li><span class="li-head">system_status</span> 
        
        </li>
        system_storage
        <li><span class="li-head">system_storage</span> 
        
        </li>
        system_time
        <li><span class="li-head">system_time</span> 
        
        </li>
        system_timezone
        <li><span class="li-head">system_timezone</span> 
        
        </li>
        system_traffic-history_interface
        <li><span class="li-head">system_traffic-history_interface</span> - Retrieve history traffic stats for an interface. 
        <ul class="ul-self">
                <li><span class="li-required">interface</span> - Interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">time_period</span> - Time period to retrieve data for [hour | day | week]. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_traffic-history_top-applications
        <li><span class="li-head">system_traffic-history_top-applications</span> - Retrieve top FortiView applications traffic stats by bandwidth. 
        <ul class="ul-self">
                <li><span class="li-required">time_period</span> - Time period to retrieve data for [hour | day | week]. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        system_trusted-cert-authorities
        <li><span class="li-head">system_trusted-cert-authorities</span> - Get trusted certifiate authorities. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope of certificate [vdom*|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_upgrade-report_current
        <li><span class="li-head">system_upgrade-report_current</span> 
        
        </li>
        system_upgrade-report_exists
        <li><span class="li-head">system_upgrade-report_exists</span> 
        
        </li>
        system_upgrade-report_saved
        <li><span class="li-head">system_upgrade-report_saved</span> 
        
        </li>
        system_usb-log
        <li><span class="li-head">system_usb-log</span> 
        
        </li>
        system_vdom-link
        <li><span class="li-head">system_vdom-link</span> - Gets a list of all NPU VDOM Links and VDOM Links. 
        <ul class="ul-self">
                <li><span class="li-required">scope</span> - Scope from which to retrieve the VDOM link informaton from [vdom|global]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        system_vdom-resource
        <li><span class="li-head">system_vdom-resource</span> 
        
        </li>
        system_vm-information
        <li><span class="li-head">system_vm-information</span> 
        
        </li>
        telemetry-controller_agent-tasks
        <li><span class="li-head">telemetry-controller_agent-tasks</span> 
        
        </li>
        telemetry-controller_agents
        <li><span class="li-head">telemetry-controller_agents</span> 
        
        </li>
        user_banned
        <li><span class="li-head">user_banned</span> 
        
        </li>
        user_banned_check
        <li><span class="li-head">user_banned_check</span> - Check if an IPv4 or IPv6 address is banned administratively. 
        <ul class="ul-self">
                <li><span class="li-required">ip_address</span> - IPv4 or IPv6 Address to check. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        user_collected-email
        <li><span class="li-head">user_collected-email</span> - List email addresses collected from captive portal. 
        <ul class="ul-self">
                <li><span class="li-required">ipv6</span> - Include collected email from IPv6 users. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_detected-device
        <li><span class="li-head">user_detected-device</span> - Retrieve a list of detected devices. 
        <ul class="ul-self">
                <li><span class="li-required">expand_child_macs</span> - Include child devices as separate entries in the list. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_dhcp</span> - Retrieve DHCP lease information. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_endpoint</span> - Retrieve FortiClient endpoint information. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_fortilink</span> - Retrieve FortiLink information. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_fortiap</span> - Retrieve FortiAP information. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_user</span> - Retrieve authenticated user information. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_device
        <li><span class="li-head">user_device</span> - Retrieve a list of detected devices. 
        <ul class="ul-self">
                <li><span class="li-required">master_only</span> - List of master device only. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">master_mac</span> - Filter: Master MAC of a device. Multiple entries could be returned. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_device-category
        <li><span class="li-head">user_device-category</span> 
        
        </li>
        user_device-type
        <li><span class="li-head">user_device-type</span> 
        
        </li>
        user_device_iot-query
        <li><span class="li-head">user_device_iot-query</span> - Retrieve IoT/OT information for a given device from user device store. 
        <ul class="ul-self">
                <li><span class="li-required">mac</span> - Main MAC address of the device. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">ip</span> - IP address of the device. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        user_device_query
        <li><span class="li-head">user_device_query</span> - Retrieve user devices from user device store. List all the user devices if there is no filter set. 
        <ul class="ul-self">
                <li><span class="li-required">timestamp_from</span> - To get entries since the timestamp for unified historical query. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">timestamp_to</span> - To get entries before the timestamp for unified historical query. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">filters</span> - A list of filters. Type:{"type": string, "value": string, "op": string}. Op: filter operator [exact|contains|greaterThanEqualTo|lessThanEqualTo]. Default is exact. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">query_type</span> - Query type [latest|unified_latest|unified_history]. Default is latest. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">view_type</span> - View type [device|fortiswitch_client|forticlient|iot_vuln_info]. Default is device. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">query_id</span> - Provide a query ID to continue getting data for that unified request. Only available for unified query types. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">cache_query</span> - Cache query result for 5 mins and return query ID. Only available for unified query types. Default is false. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">key_only</span> - Return primary key fields only. Default is false. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">filter_logic</span> - The logic between filters [and|or]). Default is and. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">total_only</span> - Whether the query should return just the total number of devices present. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_device_stats
        <li><span class="li-head">user_device_stats</span> - Retrieve user devices stats from device store by given stat item. 
        <ul class="ul-self">
                <li><span class="li-required">stat-query-type</span> - Stat query type [device|fortiswitch_client|forticlient]. Default is device. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">stat-key</span> - key of the stats count on [os_name|hardware_type|detected_interface|is_online|max_vuln_level|fortiswitch_id|fortiswitch_port_name]. fortiswitch_id and fortiswitch_port_name only for fortiswitch_client stats query type <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">timestamp_from</span> - To get entries since the timestamp for stats query. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">timestamp_to</span> - To get entries before the timestamp for stats query. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">filters</span> - A list of filters. Type:{"type": string, "value": string, "op": string}. Only is_online type is supported. Op: filter operator [exact|contains]. Default is exact. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">filter_logic</span> - The logic between filters [and|or]). Default is and. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_firewall
        <li><span class="li-head">user_firewall</span> - List authenticated firewall users. 
        <ul class="ul-self">
                <li><span class="li-required">ipv4</span> - Include IPv4 users (default=true). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ipv6</span> - Include IPv6 users (default=false). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_fsso</span> - Include FSSO users (default=true). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_firewall_count
        <li><span class="li-head">user_firewall_count</span> - Get the number of authenticated firewall users. 
        <ul class="ul-self">
                <li><span class="li-required">ipv4</span> - Include IPv4 users (default=true). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ipv6</span> - Include IPv6 users (default=false). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_fsso</span> - Include FSSO users (default=true). <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_fortitoken
        <li><span class="li-head">user_fortitoken</span> 
        
        </li>
        user_fortitoken-cloud_status
        <li><span class="li-head">user_fortitoken-cloud_status</span> 
        
        </li>
        user_fsso
        <li><span class="li-head">user_fsso</span> 
        
        </li>
        user_info_query
        <li><span class="li-head">user_info_query</span> - Query user info. 
        <ul class="ul-self">
                <li><span class="li-required">timestamp_from</span> - To get entries since the timestamp for unified historical query. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">timestamp_to</span> - To get entries before the timestamp for unified historical query. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">filters</span> - A list of filters. Type:{"type": string, "value": string, "op": string}. Op: filter operator [exact|contains|greaterThanEqualTo|lessThanEqualTo]. Default is exact. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">query_type</span> - Query type [latest|unified_latest|unified_history]. Default is latest. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">query_id</span> - Provide a query ID to continue getting data for that unified request. Only available for unified query types. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">cache_query</span> - Cache query result for 5 mins and return query ID. Only available for unified query types. Default is false. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">key_only</span> - Return primary key fields only. Default is false. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">filter_logic</span> - The logic between filters [and|or]). Default is and. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">total_only</span> - Whether the query should return just the total number of identities present. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_info_thumbnail
        <li><span class="li-head">user_info_thumbnail</span> - Get user info thumbnail. Returns the first match to the filter. 
        <ul class="ul-self">
                <li><span class="li-required">filters</span> - A list of filters. Type:{"type": string, "value": string} <span class="li-normal">type: array</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        user_info_thumbnail-file
        <li><span class="li-head">user_info_thumbnail-file</span> - Get user info thumbnail by given file name. 
        <ul class="ul-self">
                <li><span class="li-required">filename</span> - Thumbnail file name. The file name is from thumbnailPhoto field of user info query. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        user_proxy
        <li><span class="li-head">user_proxy</span> 
        
        </li>
        user_proxy_count
        <li><span class="li-head">user_proxy_count</span> 
        
        </li>
        user_radius_get-test-connect
        <li><span class="li-head">user_radius_get-test-connect</span> - Test the connectivity of the given RADIUS server and, optionally, the validity of a username & password. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - Name of FortiGate's RADIUS object whose settings to test. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">ordinal</span> - If 'mkey' is provided, the server-secret pair to use from the object: 'primary', 'secondary' or 'tertiary'. Defaults to 'primary'. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">server</span> - Host name or IP of a RADIUS server. If 'mkey' is provided, this overrides the 'server' value in the object. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">secret</span> - Secret password for the RADIUS server. If 'mkey' is provided, this overrides the 'secret' value in the object. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">auth_type</span> - Authentication protocol to use [auto|ms_chap_v2|ms_chap|chap|pap]. If 'mkey' is provided, this overrides the 'auth-type' value in the object. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">user</span> - User name whose access to check. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">password</span> - User's password. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        user_scim_groups
        <li><span class="li-head">user_scim_groups</span> - Get SCIM client group-names. 
        <ul class="ul-self">
                <li><span class="li-required">client_name</span> - SCIM client name to be used to retrieve group names. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        user_scim_users
        <li><span class="li-head">user_scim_users</span> - Get SCIM client users. 
        <ul class="ul-self">
                <li><span class="li-required">client_name</span> - SCIM client name to be used to retrieve group names. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">group_name</span> - SCIM client group name to be used to retrieve users, if left empty, will retrieve users from all groups. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">user_name</span> - SCIM client user name to retrieve, if left empty, will retrieve all users from group. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        utm_antivirus_stats
        <li><span class="li-head">utm_antivirus_stats</span> 
        
        </li>
        utm_app-lookup
        <li><span class="li-head">utm_app-lookup</span> - Query ISDB to resolve hosts to application control entries. 
        <ul class="ul-self">
                <li><span class="li-required">hosts</span> - List of hosts to resolve. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        utm_application-categories
        <li><span class="li-head">utm_application-categories</span> 
        
        </li>
        utm_blacklisted-certificates
        <li><span class="li-head">utm_blacklisted-certificates</span> - Retrieve a list of blacklisted SSL certificates. 
        <ul class="ul-self">
                <li><span class="li-required">start</span> - Starting entry index. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">count</span> - Maximum number of entries to return. Limit is set to 2000. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        utm_blacklisted-certificates_statistics
        <li><span class="li-head">utm_blacklisted-certificates_statistics</span> 
        
        </li>
        utm_rating-lookup
        <li><span class="li-head">utm_rating-lookup</span> - Lookup FortiGuard rating for a specific URL. 
        <ul class="ul-self">
                <li><span class="li-required">url</span> - List of URLs to query. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        videofilter_fortiguard-categories
        <li><span class="li-head">videofilter_fortiguard-categories</span> 
        
        </li>
        virtual-wan_health-check
        <li><span class="li-head">virtual-wan_health-check</span> - Retrieve health-check statistics for each SD-WAN link. To be deprecated and replaced by /api/v2/monitor/virtual-wan/sla-log?latest=1&sla=<sla_name> for SLA health metrics  
        <ul class="ul-self">
                <li><span class="li-required">health_check_name</span> - Health check name. If not provided, will return results of all health checks. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        virtual-wan_interface-log
        <li><span class="li-head">virtual-wan_interface-log</span> - Retrieve log of SD-WAN interface quality information. 
        <ul class="ul-self">
                <li><span class="li-required">interface</span> - Filter: Interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">since</span> - Filter: Only return SLA logs generated since this Unix timestamp. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">seconds</span> - Filter: Only return SLA logs generated in the last N seconds. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        virtual-wan_members
        <li><span class="li-head">virtual-wan_members</span> - Retrieve interface statistics for each SD-WAN link. 
        <ul class="ul-self">
                <li><span class="li-required">interface</span> - Interface names. "interface" param take precedence over "zone" or "sla". If set, will return only return the members that matches the interfaces. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">zone</span> - SD-WAN zone name. "zone" param take precedence over "sla". If set, will only return members of the zone. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sla</span> - SLA name. If set, will only return members that are participants of the SLA. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">skip_vpn_child</span> - If set, will skip all VPN child interfaces. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        virtual-wan_sla-log
        <li><span class="li-head">virtual-wan_sla-log</span> - Retrieve logs of SLA probe results for the specified SD-WAN SLA or health check name. 
        <ul class="ul-self">
                <li><span class="li-required">sla</span> - Filter: SLA names. <span class="li-normal">type: array</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">interface</span> - Filter: Interface name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">since</span> - Filter: Only return SLA logs generated since this Unix timestamp. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">seconds</span> - Filter: Only return SLA logs generated in the last N seconds. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">latest</span> - If set, will only return the latest log, in the meantime, since, seconds, or sampling_interval will be ignored. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">min_sample_interval</span> - Minimum seconds between kept log samples. Returned samples may not be evenly spaced (default: 5). <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">sampling_interval</span> - Deprecated: Use min_sample_interval instead <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">skip_vpn_child</span> - If set, will skip all VPN child interfaces. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">include_sla_targets_met</span> - If set, will return SLA targets that are met. Can only be used when "latest" is set. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        virtual-wan_sladb
        <li><span class="li-head">virtual-wan_sladb</span> 
        
        </li>
        vpn-certificate_cert-name-available
        <li><span class="li-head">vpn-certificate_cert-name-available</span> - Check if the local certificate name is available to use. 
        <ul class="ul-self">
                <li><span class="li-required">mkey</span> - The certificate name to be checked. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">scope</span> - Scope of certificate name [vdom*|global]. Global scope is only accessible for global administrators <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        vpn_ipsec
        <li><span class="li-head">vpn_ipsec</span> - Return an array of active IPsec VPNs. 
        <ul class="ul-self">
                <li><span class="li-required">tunnel</span> - Filter for a specific IPsec tunnel name. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        vpn_ipsec_connection-count
        <li><span class="li-head">vpn_ipsec_connection-count</span> 
        
        </li>
        vpn_ocvpn_members
        <li><span class="li-head">vpn_ocvpn_members</span> 
        
        </li>
        vpn_ocvpn_meta
        <li><span class="li-head">vpn_ocvpn_meta</span> 
        
        </li>
        vpn_ocvpn_status
        <li><span class="li-head">vpn_ocvpn_status</span> 
        
        </li>
        vpn_one-click_members
        <li><span class="li-head">vpn_one-click_members</span> 
        
        </li>
        vpn_one-click_status
        <li><span class="li-head">vpn_one-click_status</span> 
        
        </li>
        vpn_ssl
        <li><span class="li-head">vpn_ssl</span> 
        
        </li>
        vpn_ssl_stats
        <li><span class="li-head">vpn_ssl_stats</span> 
        
        </li>
        wanopt_history
        <li><span class="li-head">wanopt_history</span> - Retrieve WAN opt. statistics history. 
        <ul class="ul-self">
                <li><span class="li-required">period</span> - Statistics period [10-min*|hour|day|week|30-day]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wanopt_peer_stats
        <li><span class="li-head">wanopt_peer_stats</span> 
        
        </li>
        wanopt_webcache
        <li><span class="li-head">wanopt_webcache</span> - Retrieve webcache statistics history. 
        <ul class="ul-self">
                <li><span class="li-required">period</span> - Statistics period [10-min*|hour|day|week|30-day]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        web-ui_custom-language_download
        <li><span class="li-head">web-ui_custom-language_download</span> - Download a custom language file. 
        <ul class="ul-self">
                <li><span class="li-required">lang_name</span> - Name of custom language entry. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        webcache_stats
        <li><span class="li-head">webcache_stats</span> - Retrieve webcache statistics. 
        <ul class="ul-self">
                <li><span class="li-required">period</span> - Statistics period [10min|hour|day|month]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        webfilter_category-quota
        <li><span class="li-head">webfilter_category-quota</span> - Retrieve quota usage statistics for webfilter categories. 
        <ul class="ul-self">
                <li><span class="li-required">profile</span> - Webfilter profile. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">user</span> - User or IP (required if profile specified). <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        webfilter_fortiguard-categories
        <li><span class="li-head">webfilter_fortiguard-categories</span> 
        
        </li>
        webfilter_malicious-urls
        <li><span class="li-head">webfilter_malicious-urls</span> 
        
        </li>
        webfilter_malicious-urls_stat
        <li><span class="li-head">webfilter_malicious-urls_stat</span> 
        
        </li>
        webfilter_override
        <li><span class="li-head">webfilter_override</span> 
        
        </li>
        webfilter_trusted-urls
        <li><span class="li-head">webfilter_trusted-urls</span> 
        
        </li>
        webproxy_pacfile_download
        <li><span class="li-head">webproxy_pacfile_download</span> 
        
        </li>
        wifi_ap-names
        <li><span class="li-head">wifi_ap-names</span> 
        
        </li>
        wifi_ap_channels
        <li><span class="li-head">wifi_ap_channels</span> - Retrieve the set of channel lists for all possible band/configurations for the given FortiAP platform. 
        <ul class="ul-self">
                <li><span class="li-required">country</span> - Two-letter code for the country the AP is operating in. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">platform_type</span> - Short name for platform type (e.g. '220A') <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">indoor_outdoor</span> - FortiAP indoor/outdoor configuration value (0 for indoor, 1 for outdoor, 2 for default). <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_ap_status
        <li><span class="li-head">wifi_ap_status</span> 
        
        </li>
        wifi_client
        <li><span class="li-head">wifi_client</span> - Retrieve a list of connected WiFi clients. 
        <ul class="ul-self">
                <li><span class="li-required">type</span> - Request type [all*|fail-login]. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_triangulation</span> - Enable to include regions of FortiAP detecting the client. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">with_stats</span> - Enable to include statistics of FortiAP client. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">mac</span> - WiFi client MAC address. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_euclid
        <li><span class="li-head">wifi_euclid</span> 
        
        </li>
        wifi_firmware
        <li><span class="li-head">wifi_firmware</span> - Retrieve a list of current and recommended firmware for FortiAPs in use. 
        <ul class="ul-self">
                <li><span class="li-required">timeout</span> - FortiGuard connection timeout (defaults to 2 seconds). <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">version</span> - Target firmware version of the parent FortiGate. <span class="li-normal">type: object</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_interfering_ap
        <li><span class="li-head">wifi_interfering_ap</span> - Retrieve a list of interfering APs for one FortiAP radio. 
        <ul class="ul-self">
                <li><span class="li-required">wtp</span> - FortiAP ID to query. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">radio</span> - Radio ID. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_managed_ap
        <li><span class="li-head">wifi_managed_ap</span> - Retrieve a list of managed FortiAPs. 
        <ul class="ul-self">
                <li><span class="li-required">wtp_id</span> - Filter: single managed FortiAP by ID. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">incl_local</span> - Enable to include the local FortiWiFi device in the results. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">skip_eos</span> - Skip adding Fortiguard end-of-support data. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_matched-devices
        <li><span class="li-head">wifi_matched-devices</span> - Return a list of devices that match NAC WiFi settings. 
        <ul class="ul-self">
                <li><span class="li-required">mac</span> - WiFi client MAC address. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_meta
        <li><span class="li-head">wifi_meta</span> 
        
        </li>
        wifi_nac-device_stats
        <li><span class="li-head">wifi_nac-device_stats</span> 
        
        </li>
        wifi_network_list
        <li><span class="li-head">wifi_network_list</span> 
        
        </li>
        wifi_network_status
        <li><span class="li-head">wifi_network_status</span> 
        
        </li>
        wifi_region-image
        <li><span class="li-head">wifi_region-image</span> - Retrieves a floorplan/region image from a configured FortiAP region. 
        <ul class="ul-self">
                <li><span class="li-required">region_name</span> - Region name to retrieve image from. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        wifi_rogue_ap
        <li><span class="li-head">wifi_rogue_ap</span> - Retrieve a list of detected rogue APs. 
        <ul class="ul-self">
                <li><span class="li-required">managed_ssid_only</span> - Filter: True to include only WiFi controller managed SSIDs. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_spectrum
        <li><span class="li-head">wifi_spectrum</span> - Retrieve spectrum analysis information for a specific FortiAP. 
        <ul class="ul-self">
                <li><span class="li-required">wtp_id</span> - FortiAP ID to query. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        wifi_station-capability
        <li><span class="li-head">wifi_station-capability</span> - Retrieve a list of stations and their capability to connect to detected access points. 
        <ul class="ul-self">
                <li><span class="li-required">mac_address</span> - Station MAC address. <span class="li-normal">type: string</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">min_age</span> - Minimum value for RSSI 2G age and 5G RSSI age, in seconds. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                <li><span class="li-required">max_age</span> - Maximum value for RSSI 2G age and 5G RSSI age, in seconds. <span class="li-normal">type: int</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_statistics
        <li><span class="li-head">wifi_statistics</span> 
        
        </li>
        wifi_unassociated-devices
        <li><span class="li-head">wifi_unassociated-devices</span> - Retrieve a list of unassociated and BLE devices 
        <ul class="ul-self">
                <li><span class="li-required">with_triangulation</span> - Enable to include regions of FortiAP detecting the device. <span class="li-normal">type: boolean</span> <span class="li-normal">required: False</span> </li>
                
            </ul>
        
        </li>
        wifi_vlan-probe
        <li><span class="li-head">wifi_vlan-probe</span> - Retrieve the VLAN probe results. 
        <ul class="ul-self">
                <li><span class="li-required">ap_interface</span> - FortiAP interface to send the probe on. <span class="li-normal">type: int</span> <span class="li-normal">required: True</span> </li>
                <li><span class="li-required">wtp</span> - FortiAP ID. <span class="li-normal">type: string</span> <span class="li-normal">required: True</span> </li>
                
            </ul>
        
        </li>
        </ul>
        </div>
        </section>
    <li><span class="li-head">params</span> - the parameter for each selector, see definition in above list.<span class="li-normal">type: dict</span></li>


Notes
-----

.. note::

   - Backup API varies across versions. For FOS 7.0.1 and earlier, utilize system_config_backup in fortios_monitor_fact. For FOS 7.0.2 and later, utilize backup.system.config in fortios_monitor.

   - Different ``selector`` may have different parameters, users are expected to look them up for a specific selector.

   - For some selectors, the objects are global, no ``params`` are allowed to appear.

   - Not all parameters are required for a slector.

   - This module is exclusivly for FortiOS monitor API.

   - The result of API request is stored in ``results``.

   - There are three filtering parameters: ``filters``, ``sorters`` and ``formatters``, please see `filtering spec`_ for more information.

Examples
--------

.. code-block:: yaml+jinja

 - hosts: fortigates
   connection: httpapi
   collections:
   - fortinet.fortios
   vars:
    vdom: "root"
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
   tasks:

   - fortios_monitor_fact:
        vdom: ""
        enable_log: true
        formatters:
            - model_name
        filters:
            - model_name==FortiGat
        selector: 'system_status'

   - name: fact gathering
     fortios_monitor_fact:
        vdom: ""
        access_token: ""
        selector: 'firewall_acl'

   - name: fact gathering
     fortios_monitor_fact:
        vdom: ""
        access_token: ""
        selector: 'firewall_security-policy'
        params:
            policyid: '1'


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:

.. raw:: html

    <ul>

    <li> <span class="li-return">build</span> - Build number of the fortigate image <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: 1547</span></li>
    <li> <span class="li-return">http_method</span> - Last method used to provision the content into FortiGate <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: GET</span></li>
    <li> <span class="li-return">name</span> - Name of the table used to fulfill the request <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: firmware</span></li>
    <li> <span class="li-return">path</span> - Path of the table used to fulfill the request <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: system</span></li>
    <li> <span class="li-return">results</span> - Object list retrieved from device. <span class="li-normal">returned: always</span> <span class="li-normal">type: list</span></li>
    <li> <span class="li-return">revision</span> - Internal revision number <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: 17.0.2.10658</span></li>
    <li> <span class="li-return">serial</span> - Serial number of the unit <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: FGVMEVYYQT3AB5352</span></li>
    <li> <span class="li-return">status</span> - Indication of the operation's result <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: success</span></li>
    <li> <span class="li-return">vdom</span> - Virtual domain used <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: root</span></li>
    <li> <span class="li-return">version</span> - Version of the FortiGate <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: v5.6.3</span></li>
    <li> <span class="li-return">ansible_facts</span> - The list of fact subsets collected from the device <span class="li-normal">returned: always</span> <span class="li-normal">type: dict</span></li>
    </ul>

Status
------

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


Authors
-------

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


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

.. _filtering spec: https://fndn.fortinet.net/index.php?/fortiapi/1-fortios/597/