fortisase_facts – Gather FortiSASE Facts.
Added in version 1.0.0.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.17.0
Parameters
- selector The selector of the facts.type: strrequired: True
- params The params of the facts. Different selectors have different required params.type: dict
| Selector | Required Params | API |
|---|---|---|
| endpoints_access_proxy | /monitor-api/v1/endpoints/access-proxy | |
| endpoints_client_user_details | client_user_id | /monitor-api/v1/endpoints/client-user-details/{client_user_id} |
| endpoints_details | device_id | /monitor-api/v1/endpoints/details/{device_id} |
| endpoints_donut | donut_type | /monitor-api/v1/endpoints/donut/{donut_type} |
| endpoints_endpoints_with_software | software_id | /monitor-api/v1/endpoints/endpoints-with-software/{software_id} |
| endpoints_groups | primary_key | /monitor-api/v1/endpoints/groups/{primary_key} |
| endpoints_software | /monitor-api/v1/endpoints/software | |
| endpoints_software_on_client_user | client_user_id | /monitor-api/v1/endpoints/software-on-client-user/{client_user_id} |
| endpoints_software_on_endpoint | device_id | /monitor-api/v1/endpoints/software-on-endpoint/{device_id} |
| endpoints_uid_tags | /monitor-api/v1/endpoints/uid-tags | |
| endpoints_users | /monitor-api/v1/endpoints/users | |
| endpoints_vulnerabilities | /monitor-api/v1/endpoints/vulnerabilities | |
| endpoints_vulnerabilities_endpoints | vulnerability_id | /monitor-api/v1/endpoints/vulnerabilities/{vulnerability_id}/endpoints |
| endpoints_ztna_count | /monitor-api/v1/endpoints/ztna-count | |
| endpoints_ztna_tags | /monitor-api/v1/endpoints/ztna-tags | |
| security_botnet_domains | /monitor-api/v1/security/botnet-domains | |
| security_botnet_domains_stat | /monitor-api/v1/security/botnet-domains/stat | |
| traffic_history | /monitor-api/v1/traffic-history | |
| traffic_history_vpn_connections | /monitor-api/v1/traffic-history/vpn-connections | |
| user_swg_sessions | /monitor-api/v1/user/swg/sessions | |
| user_vpn_sessions | /monitor-api/v1/user/vpn/sessions | |
| auth_fsso_agents | primary_key | /resource-api/v2/auth/fsso-agents/{primary_key} |
| auth_ldap_servers | primary_key | /resource-api/v2/auth/ldap-servers/{primary_key} |
| auth_radius_servers | primary_key | /resource-api/v2/auth/radius-servers/{primary_key} |
| auth_swg_saml_server | /resource-api/v2/auth/swg-saml-server | |
| auth_user_groups | primary_key | /resource-api/v2/auth/user-groups/{primary_key} |
| auth_users | primary_key | /resource-api/v2/auth/users/{primary_key} |
| auth_vpn_saml_server | /resource-api/v2/auth/vpn-saml-server | |
| dem_custom_saas_apps | primary_key | /resource-api/v2/dem/custom-saas-apps/{primary_key} |
| dem_spa_applications | primary_key | /resource-api/v2/dem/spa-applications/{primary_key} |
| endpoint_connection_profiles | primary_key | /resource-api/v2/endpoint/connection-profiles/{primary_key} |
| endpoint_fsso_profiles | primary_key | /resource-api/v2/endpoint/fsso-profiles/{primary_key} |
| endpoint_group_ad_user_profiles | primary_key | /resource-api/v2/endpoint/group-ad-user-profiles/{primary_key} |
| endpoint_group_invitation_codes | primary_key | /resource-api/v2/endpoint/group-invitation-codes/{primary_key} |
| endpoint_policies | primary_key | /resource-api/v2/endpoint/policies/{primary_key} |
| endpoint_protection_profiles | primary_key | /resource-api/v2/endpoint/protection-profiles/{primary_key} |
| endpoint_sandbox_profiles | primary_key | /resource-api/v2/endpoint/sandbox-profiles/{primary_key} |
| endpoint_setting_profiles | primary_key | /resource-api/v2/endpoint/setting-profiles/{primary_key} |
| endpoint_ztna_profiles | primary_key | /resource-api/v2/endpoint/ztna-profiles/{primary_key} |
| endpoint_ztna_rules | primary_key | /resource-api/v2/endpoint/ztna-rules/{primary_key} |
| endpoint_ztna_tags | primary_key | /resource-api/v2/endpoint/ztna-tags/{primary_key} |
| infra_extenders | primary_key | /resource-api/v2/infra/extenders/{primary_key} |
| infra_fortigates | primary_key | /resource-api/v2/infra/fortigates/{primary_key} |
| infra_ssids | primary_key | /resource-api/v2/infra/ssids/{primary_key} |
| network_basic_internet_services | primary_key | /resource-api/v2/network/basic-internet-services/{primary_key} |
| network_dns_rules | primary_key | /resource-api/v2/network/dns-rules/{primary_key} |
| network_host_groups | primary_key | /resource-api/v2/network/host-groups/{primary_key} |
| network_hosts | primary_key | /resource-api/v2/network/hosts/{primary_key} |
| network_implicit_dns_rules | primary_key | /resource-api/v2/network/implicit-dns-rules/{primary_key} |
| network_internet_services | primary_key | /resource-api/v2/network/internet-services/{primary_key} |
| network_wildcard_fqdn_customs | primary_key | /resource-api/v2/network/wildcard-fqdn-customs/{primary_key} |
| security_antivirus_filetypes | primary_key | /resource-api/v2/security/antivirus-filetypes/{primary_key} |
| security_antivirus_profile | direction, primary_key | /resource-api/v2/security/antivirus-profile/{direction}/{primary_key} |
| security_antivirus_profiles | /resource-api/v2/security/antivirus-profiles | |
| security_app_custom_signatures | primary_key | /resource-api/v2/security/app-custom-signatures/{primary_key} |
| security_application_categories | primary_key | /resource-api/v2/security/application-categories/{primary_key} |
| security_application_control_profile | direction, primary_key | /resource-api/v2/security/application-control-profile/{direction}/{primary_key} |
| security_application_control_profiles | /resource-api/v2/security/application-control-profiles | |
| security_applications | primary_key | /resource-api/v2/security/applications/{primary_key} |
| security_dlp_data_types | primary_key | /resource-api/v2/security/dlp-data-types/{primary_key} |
| security_dlp_dictionaries | primary_key | /resource-api/v2/security/dlp-dictionaries/{primary_key} |
| security_dlp_exact_data_matches | primary_key | /resource-api/v2/security/dlp-exact-data-matches/{primary_key} |
| security_dlp_file_patterns | primary_key | /resource-api/v2/security/dlp-file-patterns/{primary_key} |
| security_dlp_fingerprint_databases | primary_key | /resource-api/v2/security/dlp-fingerprint-databases/{primary_key} |
| security_dlp_profile | direction, primary_key | /resource-api/v2/security/dlp-profile/{direction}/{primary_key} |
| security_dlp_profiles | /resource-api/v2/security/dlp-profiles | |
| security_dlp_sensors | primary_key | /resource-api/v2/security/dlp-sensors/{primary_key} |
| security_dns_filter_profile | direction, primary_key | /resource-api/v2/security/dns-filter-profile/{direction}/{primary_key} |
| security_dns_filter_profiles | /resource-api/v2/security/dns-filter-profiles | |
| security_domain_threat_feeds | primary_key | /resource-api/v2/security/domain-threat-feeds/{primary_key} |
| security_endpoint_to_endpoint_policies | primary_key | /resource-api/v2/security/endpoint-to-endpoint-policies/{primary_key} |
| security_file_filter_profile | direction, primary_key | /resource-api/v2/security/file-filter-profile/{direction}/{primary_key} |
| security_file_filter_profiles | /resource-api/v2/security/file-filter-profiles | |
| security_fortiguard_categories | primary_key | /resource-api/v2/security/fortiguard-categories/{primary_key} |
| security_fortiguard_local_categories | primary_key | /resource-api/v2/security/fortiguard-local-categories/{primary_key} |
| security_geoip_countries | primary_key | /resource-api/v2/security/geoip-countries/{primary_key} |
| security_internal_policies | primary_key | /resource-api/v2/security/internal-policies/{primary_key} |
| security_internal_reverse_policies | primary_key | /resource-api/v2/security/internal-reverse-policies/{primary_key} |
| security_ip_threat_feeds | primary_key | /resource-api/v2/security/ip-threat-feeds/{primary_key} |
| security_ips_custom_signatures | primary_key | /resource-api/v2/security/ips-custom-signatures/{primary_key} |
| security_ips_profile | direction, primary_key | /resource-api/v2/security/ips-profile/{direction}/{primary_key} |
| security_ips_profiles | /resource-api/v2/security/ips-profiles | |
| security_onetime_schedules | primary_key | /resource-api/v2/security/onetime-schedules/{primary_key} |
| security_outbound_policies | primary_key | /resource-api/v2/security/outbound-policies/{primary_key} |
| security_profile_group | direction, primary_key | /resource-api/v2/security/profile-group/{direction}/{primary_key} |
| security_profile_groups | primary_key | /resource-api/v2/security/profile-groups/{primary_key} |
| security_recurring_schedules | primary_key | /resource-api/v2/security/recurring-schedules/{primary_key} |
| security_schedule_groups | primary_key | /resource-api/v2/security/schedule-groups/{primary_key} |
| security_service_categories | primary_key | /resource-api/v2/security/service-categories/{primary_key} |
| security_service_groups | primary_key | /resource-api/v2/security/service-groups/{primary_key} |
| security_services | primary_key | /resource-api/v2/security/services/{primary_key} |
| security_ssl_ssh_profile | direction, primary_key | /resource-api/v2/security/ssl-ssh-profile/{direction}/{primary_key} |
| security_ssl_ssh_profiles | /resource-api/v2/security/ssl-ssh-profiles | |
| security_url_threat_feeds | primary_key | /resource-api/v2/security/url-threat-feeds/{primary_key} |
| security_video_filter_fortiguard_categories | primary_key | /resource-api/v2/security/video-filter-fortiguard-categories/{primary_key} |
| security_video_filter_profile | direction, primary_key | /resource-api/v2/security/video-filter-profile/{direction}/{primary_key} |
| security_video_filter_profiles | /resource-api/v2/security/video-filter-profiles | |
| security_video_filter_youtube_key | /resource-api/v2/security/video-filter-youtube-key | |
| security_web_filter_profile | direction, primary_key | /resource-api/v2/security/web-filter-profile/{direction}/{primary_key} |
| security_web_filter_profiles | /resource-api/v2/security/web-filter-profiles | |
| usage_auth_fsso_agents | primary_key | /resource-api/v2/usage/auth/fsso-agents/{primary_key} |
| usage_auth_ldap_servers | primary_key | /resource-api/v2/usage/auth/ldap-servers/{primary_key} |
| usage_auth_radius_servers | primary_key | /resource-api/v2/usage/auth/radius-servers/{primary_key} |
| usage_auth_user_groups | primary_key | /resource-api/v2/usage/auth/user-groups/{primary_key} |
| usage_endpoint_ztna_tags | primary_key | /resource-api/v2/usage/endpoint/ztna-tags/{primary_key} |
| usage_infra_ssids | primary_key | /resource-api/v2/usage/infra/ssids/{primary_key} |
| usage_network_host_groups | primary_key | /resource-api/v2/usage/network/host-groups/{primary_key} |
| usage_network_hosts | primary_key | /resource-api/v2/usage/network/hosts/{primary_key} |
| usage_security_app_custom_signatures | primary_key | /resource-api/v2/usage/security/app-custom-signatures/{primary_key} |
| usage_security_dlp_dictionaries | primary_key | /resource-api/v2/usage/security/dlp-dictionaries/{primary_key} |
| usage_security_dlp_exact_data_matches | primary_key | /resource-api/v2/usage/security/dlp-exact-data-matches/{primary_key} |
| usage_security_dlp_file_patterns | primary_key | /resource-api/v2/usage/security/dlp-file-patterns/{primary_key} |
| usage_security_dlp_fingerprint_databases | primary_key | /resource-api/v2/usage/security/dlp-fingerprint-databases/{primary_key} |
| usage_security_dlp_sensors | primary_key | /resource-api/v2/usage/security/dlp-sensors/{primary_key} |
| usage_security_domain_threat_feeds | primary_key | /resource-api/v2/usage/security/domain-threat-feeds/{primary_key} |
| usage_security_endpoint_to_endpoint_policies | primary_key | /resource-api/v2/usage/security/endpoint-to-endpoint-policies/{primary_key} |
| usage_security_fortiguard_local_categories | primary_key | /resource-api/v2/usage/security/fortiguard-local-categories/{primary_key} |
| usage_security_internal_policies | primary_key | /resource-api/v2/usage/security/internal-policies/{primary_key} |
| usage_security_internal_reverse_policies | primary_key | /resource-api/v2/usage/security/internal-reverse-policies/{primary_key} |
| usage_security_ip_threat_feeds | primary_key | /resource-api/v2/usage/security/ip-threat-feeds/{primary_key} |
| usage_security_ips_custom_signatures | primary_key | /resource-api/v2/usage/security/ips-custom-signatures/{primary_key} |
| usage_security_onetime_schedules | primary_key | /resource-api/v2/usage/security/onetime-schedules/{primary_key} |
| usage_security_outbound_policies | primary_key | /resource-api/v2/usage/security/outbound-policies/{primary_key} |
| usage_security_profile_group | direction, primary_key | /resource-api/v2/usage/security/profile-group/{direction}/{primary_key} |
| usage_security_recurring_schedules | primary_key | /resource-api/v2/usage/security/recurring-schedules/{primary_key} |
| usage_security_schedule_groups | primary_key | /resource-api/v2/usage/security/schedule-groups/{primary_key} |
| usage_security_service_groups | primary_key | /resource-api/v2/usage/security/service-groups/{primary_key} |
| usage_security_services | primary_key | /resource-api/v2/usage/security/services/{primary_key} |
| usage_security_url_threat_feeds | primary_key | /resource-api/v2/usage/security/url-threat-feeds/{primary_key} |
| private_access_network_configuration | /resource-api/v1/private-access/network-configuration | |
| private_access_service_connections | service_connection_id | /resource-api/v1/private-access/service-connections/{service_connection_id} |
| security_cert_local_certs | primary_key | /resource-api/v1/security/cert/local-certs/{primary_key} |
| security_cert_remote_ca_certs | primary_key | /resource-api/v1/security/cert/remote-ca-certs/{primary_key} |
| security_pki_users | primary_key | /resource-api/v1/security/pki-users/{primary_key} |
Examples
- name: Get FortiSASE Facts
hosts: fortisase
gather_facts: false
tasks:
- name: Query one network dns rule
fortinet.fortisase.fortisase_facts:
selector: "network_dns_rules"
params:
primary_key: "1"
- name: Query all network dns rules
fortinet.fortisase.fortisase_facts:
selector: "network_dns_rules"
params:
primary_key: null
Return Values
- http_code type: intreturned: always
- response type: rawreturned: always