fortios_monitor_fact – Retrieve Facts of FortiOS Monitor Objects.

Added in version 2.10.

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 

vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str required: False default: root
enable_log - Enable/Disable logging for task. type: bool required: False default: False
access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False

filters - A list of expressions to filter the returned results. type: list required: False more...

Filter item must be in the following format: [key][operator][pattern], operators could be found in the table:

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

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

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 

- 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:

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

Status 

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

Authors 

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

Hint

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

fortios_monitor_fact – Retrieve Facts of FortiOS Monitor Objects.

Show full selector list...