:source: fmgr_system_log_settings.py :orphan: .. _fmgr_system_log_settings: fmgr_system_log_settings -- Log settings. +++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. warning:: Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case). - Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name`` - New argument name starting in 3.0.0: ``var_name`` FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg. .. 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: v6.0.0 -> 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 tasks: - name: Log settings. fortinet.fortimanager.fmgr_system_log_settings: # workspace_locking_adom: system_log_settings: # FAC_custom_field1: # FAZ_custom_field1: # FCH_custom_field1: # FCT_custom_field1: # FDD_custom_field1: # FGT_custom_field1: # FMG_custom_field1: # FML_custom_field1: # FPX_custom_field1: # FSA_custom_field1: # FWB_custom_field1: # browse_max_logfiles: # dns_resolve_dstip: # download_max_logs: # ha_auto_migrate: # import_max_logfiles: # log_file_archive_name: # rolling_analyzer: # days: ["sun", "mon", "tue", "wed", "thu", "fri", "sat"] # del_files: # directory: # file_size: # gzip_format: # hour: # ip: # ip2: # ip3: # log_format: # min: # password: # password2: # password3: # server_type: # upload: # upload_hour: # upload_mode: # upload_trigger: # username: # username2: # username3: # when: # port: # port2: # port3: # rolling_upgrade_status: # server: # server2: # server3: # rolling_local: # days: ["sun", "mon", "tue", "wed", "thu", "fri", "sat"] # del_files: # directory: # file_size: # gzip_format: # hour: # ip: # ip2: # ip3: # log_format: # min: # password: # password2: # password3: # server_type: # upload: # upload_hour: # upload_mode: # upload_trigger: # username: # username2: # username3: # when: # port: # port2: # port3: # rolling_upgrade_status: # server: # server2: # server3: # rolling_regular: # days: ["sun", "mon", "tue", "wed", "thu", "fri", "sat"] # del_files: # directory: # file_size: # gzip_format: # hour: # ip: # ip2: # ip3: # log_format: # min: # password: # password2: # password3: # server_type: # upload: # upload_hour: # upload_mode: # upload_trigger: # username: # username2: # username3: # when: # port: # port2: # port3: # rolling_upgrade_status: # server: # server2: # server3: # sync_search_timeout: # keep_dev_logs: # device_auto_detect: # unencrypted_logging: # log_interval_dev_no_logging: # log_upload_interval_dev_no_logging: # legacy_auth_mode: # log_process_fast_mode: # FFW_custom_field1: # unencrypted_logging_tcp: # unencrypted_logging_udp: # syslog_over_tls_port: # client_cert_auth: # mode: # tls_port: # trusted_client: # - certificate: # description: # domain: # id: # type: 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)