fortinet.fortimanager.fmgr_system_locallog_setting 模块 – 本地日志记录设置。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_system_locallog_setting。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，在使用前需要调整到数据源。

参数

参数

注释

access_token

字符串

在不使用用户名和密码的情况下访问 FortiManager 的令牌。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。

选项

  • false ←（默认）

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ←（默认）

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

用于底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / elements=整数

将覆盖成功条件的 rc 代码列表。

system_locallog_setting

字典

设置的顶层参数。

log_daemon_crash

别名：log-daemon-crash

字符串

当守护程序崩溃时发送日志消息。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

log_interval_adom_perf_stats

别名：log-interval-adom-perf-stats

整数

记录 adom 性能统计事件的间隔（分钟）。

log_interval_dev_no_logging

别名：log-interval-dev-no-logging

整数

记录从设备接收不到日志事件的间隔（分钟）。

log_interval_disk_full

别名：log-interval-disk-full

整数

记录磁盘已满事件的间隔（分钟）。

log_interval_gbday_exceeded

别名：log-interval-gbday-exceeded

整数

记录超出 GB/天许可事件的间隔（分钟）。

no_log_detection_threshold

别名：no-log-detection-threshold

整数

如果在指定分钟内未收到任何日志数据，则触发本地事件消息的时间间隔（分钟）。

workspace_locking_adom

字符串

要在工作区模式下锁定的 FortiManager 的 ADOM，该值可以是 global 和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最长时间（秒）。

默认值： 300

注意

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此项工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Settings for locallog logging.
      fortinet.fortimanager.fmgr_system_locallog_setting:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        system_locallog_setting:
          log_interval_dev_no_logging: <integer>
          log_interval_disk_full: <integer>
          log_interval_gbday_exceeded: <integer>
          log_daemon_crash: <value in [disable, enable]>
          no_log_detection_threshold: <integer>
          log_interval_adom_perf_stats: <integer>

返回值

常见的返回值记录在此处：此处，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

已返回： 始终

request_url

字符串

请求的完整 URL。

已返回： 始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

已返回： 始终

示例： 0

response_data

列表 / 元素=字符串

API 响应数据。

已返回： 始终

response_message

字符串

API 响应的描述性消息。

已返回： 始终

示例： "OK."

system_information

字典

目标系统的信息。

已返回： 始终

rc

整数

请求的状态。

已返回： 始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数当前 FortiManager 版本不支持，则发出警告。

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)