:source: fmgd_wireless_widsprofile.py :orphan: .. _fmgd_wireless_widsprofile: fmgd_wireless_widsprofile -- Configure wireless intrusion detection system (WIDS) profiles. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiManager device. - Examples include all parameters and values need to be adjusted to data sources before usage. - Tested with FortiManager v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters ---------- .. raw:: html Notes ----- .. note:: - Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded Examples -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure wireless intrusion detection system fortinet.fmgdevice.fmgd_wireless_widsprofile: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # wireless_widsprofile: name: "your value" # Required variable, string # ap_auto_suppress: # ap_bgscan_disable_schedules: # ap_bgscan_duration: # ap_bgscan_idle: # ap_bgscan_intv: # ap_bgscan_period: # ap_bgscan_report_intv: # ap_fgscan_report_intv: # ap_scan: # ap_scan_channel_list_2G_5G: # ap_scan_channel_list_6G: # ap_scan_passive: # ap_scan_threshold: # asleap_attack: # assoc_flood_thresh: # assoc_flood_time: # assoc_frame_flood: # auth_flood_thresh: # auth_flood_time: # auth_frame_flood: # comment: # deauth_broadcast: # deauth_unknown_src_thresh: # eapol_fail_flood: # eapol_fail_intv: # eapol_fail_thresh: # eapol_logoff_flood: # eapol_logoff_intv: # eapol_logoff_thresh: # eapol_pre_fail_flood: # eapol_pre_fail_intv: # eapol_pre_fail_thresh: # eapol_pre_succ_flood: # eapol_pre_succ_intv: # eapol_pre_succ_thresh: # eapol_start_flood: # eapol_start_intv: # eapol_start_thresh: # eapol_succ_flood: # eapol_succ_intv: # eapol_succ_thresh: # invalid_mac_oui: # long_duration_attack: # long_duration_thresh: # null_ssid_probe_resp: # sensor_mode: # spoofed_deauth: # weak_wep_iv: # wireless_bridge: # adhoc_network: # adhoc_valid_ssid: # air_jack: # ap_impersonation: # ap_spoofing: # bcn_flood: # bcn_flood_thresh: # bcn_flood_time: # beacon_wrong_channel: # block_ack_flood: # block_ack_flood_thresh: # block_ack_flood_time: # chan_based_mitm: # client_flood: # client_flood_thresh: # client_flood_time: # cts_flood: # cts_flood_thresh: # cts_flood_time: # disassoc_broadcast: # disconnect_station: # eapol_key_overflow: # fata_jack: # fuzzed_beacon: # fuzzed_probe_request: # fuzzed_probe_response: # hotspotter_attack: # ht_40mhz_intolerance: # ht_greenfield: # invalid_addr_combination: # malformed_association: # malformed_auth: # malformed_ht_ie: # netstumbler: # netstumbler_thresh: # netstumbler_time: # omerta_attack: # overflow_ie: # probe_flood: # probe_flood_thresh: # probe_flood_time: # pspoll_flood: # pspoll_flood_thresh: # pspoll_flood_time: # pwsave_dos_attack: # reassoc_flood: # reassoc_flood_thresh: # reassoc_flood_time: # risky_encryption: # rts_flood: # rts_flood_thresh: # rts_flood_time: # unencrypted_valid: # valid_client_misassociation: # valid_ssid_misuse: # wellenreiter: # wellenreiter_thresh: # wellenreiter_time: # windows_bridge: # wpa_ft_attack: Return Values ------------- Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module: .. raw:: html
  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu)