:source: fmgd_system_fortiguard.py :orphan: .. _fmgd_system_fortiguard: fmgd_system_fortiguard -- Configure FortiGuard services. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.1.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.4.8 -> v7.4.10, v7.6.4 -> 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 FortiGuard services. fortinet.fmgdevice.fmgd_system_fortiguard: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: system_fortiguard: # antispam_cache: # antispam_cache_mpercent: # antispam_cache_ttl: # antispam_expiration: # antispam_force_off: # antispam_license: # antispam_timeout: # anycast_sdns_server_ip: # anycast_sdns_server_port: # auto_firmware_upgrade: # auto_firmware_upgrade_day: # - "sunday" # - "monday" # - "tuesday" # - "wednesday" # - "thursday" # - "friday" # - "saturday" # auto_firmware_upgrade_delay: # auto_firmware_upgrade_end_hour: # auto_firmware_upgrade_start_hour: # auto_join_forticloud: # ddns_server_ip: # ddns_server_ip6: # ddns_server_port: # dlp_expiration: # dlp_license: # fnbi_expiration: # fnbi_license: # fortiguard_anycast: # fortiguard_anycast_source: # gui_prompt_auto_upgrade: # ia_expiration: # ia_license: # interface: # interface_select_method: # load_balance_servers: # outbreak_prevention_cache: # outbreak_prevention_cache_mpercent: # outbreak_prevention_cache_ttl: # outbreak_prevention_expiration: # outbreak_prevention_force_off: # outbreak_prevention_license: # outbreak_prevention_timeout: # persistent_connection: # port: # protocol: # proxy_password: # proxy_server_ip: # proxy_server_port: # proxy_username: # sandbox_inline_scan: # sandbox_region: # sdns_options: # - "include-question-section" # sdns_server_ip: # sdns_server_port: # service_account_id: # source_ip: # source_ip6: # update_build_proxy: # update_dldb: # update_extdb: # update_ffdb: # update_server_location: # update_uwdb: # vdom: # videofilter_expiration: # videofilter_license: # webfilter_cache: # webfilter_cache_ttl: # webfilter_expiration: # webfilter_force_off: # webfilter_license: # webfilter_timeout: # antispam_cache_mpermille: # FDS_license_expiring_days: # outbreak_prevention_cache_mpermille: # vrf_select: # subscribe_update_notification: 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)