fortinet.fortimanager.fmgr_system_log_settings_rollinglocal 模块 – 本地日志的日志滚动策略。

注意

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

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

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

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

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

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

system_log_settings_rollinglocal

字典

设置的顶级参数。

days

列表 / 元素=字符串

日志文件滚动计划

sun - 星期日。

mon - 星期一。

tue - 星期二。

wed - 星期三。

thu - 星期四。

fri - 星期五。

sat - 星期六。

选择

  • "sun"

  • "mon"

  • "tue"

  • "wed"

  • "thu"

  • "fri"

  • "sat"

del_files

别名: del-files

字符串

启用/禁用上传后删除日志文件。

disable - 禁用日志文件删除。

enable - 启用日志文件删除。

选择

  • "disable"

  • "enable"

directory

字符串

上传服务器目录，对于 Unix 服务器，请使用绝对路径

file_size

别名: file-size

整数

当日志文件达到此大小时进行滚动

gzip_format

别名: gzip-format

字符串

启用/禁用上传的日志文件的压缩。

disable - 禁用压缩。

enable - 启用压缩。

选择

  • "disable"

  • "enable"

hour

整数

日志文件滚动计划

ip

字符串

上传服务器 IP 地址。

ip2

字符串

上传服务器 IP2 地址。

ip3

字符串

上传服务器 IP3 地址。

log_format

别名: log-format

字符串

上传的日志文件的格式。

native - 本机格式

text - 文本格式

csv - CSV

选择

  • "native"

  • "text"

  • "csv"

min

整数

日志文件滚动计划

password

any

(列表) 上传服务器登录密码。

password2

any

(列表) 上传服务器登录密码 2。

password3

any

(列表) 上传服务器登录密码 3。

port

整数

上传服务器 IP1 端口号。

port2

整数

上传服务器 IP2 端口号。

port3

整数

上传服务器 IP3 端口号。

rolling_upgrade_status

别名: rolling-upgrade-status

整数

滚动升级状态

server

字符串

上传服务器 FQDN/IP。

server2

字符串

上传服务器 2 FQDN/IP。

server3

字符串

上传服务器 3 FQDN/IP。

server_type

别名: server-type

字符串

上传服务器类型。

ftp - 通过 FTP 上传。

sftp - 通过 SFTP 上传。

scp - 通过 SCP 上传。

选择

  • "ftp"

  • "sftp"

  • "scp"

upload

字符串

启用/禁用日志文件上传。

disable - 禁用日志文件上传。

enable - 启用日志文件上传。

选择

  • "disable"

  • "enable"

upload_hour

别名: upload-hour

整数

日志文件上传计划

upload_mode

别名: upload-mode

字符串

具有多个服务器的上传模式。

backup - 尝试使用服务器，并且在连接失败时一个接一个地使用。

mirror - 尝试并使用所有配置的服务器。

选择

  • "backup"

  • "mirror"

upload_trigger

别名: upload-trigger

字符串

触发日志文件上传的事件。

on-roll - 滚动后上传日志文件。

on-schedule - 每天上传日志文件。

选择

  • "on-roll"

  • "on-schedule"

username

字符串

上传服务器登录用户名。

username2

字符串

上传服务器登录用户名 2。

username3

字符串

上传服务器登录用户名 3。

when

字符串

定期滚动日志文件。

none - 不定期滚动日志文件。

daily - 每天滚动日志文件。

weekly - 在一周的特定几天滚动日志文件。

选择

  • "none"

  • "daily"

  • "weekly"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 adom，该值可以是全局的，也可以是包括 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: Log rolling policy for local logs.
      fortinet.fortimanager.fmgr_system_log_settings_rollinglocal:
        # 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_log_settings_rollinglocal:
          days:
            - "sun"
            - "mon"
            - "tue"
            - "wed"
            - "thu"
            - "fri"
            - "sat"
          del_files: <value in [disable, enable]>
          directory: <string>
          file_size: <integer>
          gzip_format: <value in [disable, enable]>
          hour: <integer>
          ip: <string>
          ip2: <string>
          ip3: <string>
          log_format: <value in [native, text, csv]>
          min: <integer>
          password: <list or string>
          password2: <list or string>
          password3: <list or string>
          server_type: <value in [ftp, sftp, scp]>
          upload: <value in [disable, enable]>
          upload_hour: <integer>
          upload_mode: <value in [backup, mirror]>
          upload_trigger: <value in [on-roll, on-schedule]>
          username: <string>
          username2: <string>
          username3: <string>
          when: <value in [none, daily, weekly]>
          port: <integer>
          port2: <integer>
          port3: <integer>
          rolling_upgrade_status: <integer>
          server: <string>
          server2: <string>
          server3: <string>

返回值

通用返回值已在此处记录 此处，以下是此模块特有的字段

键

描述

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)