fortinet.fortimanager.fmgr_system_log_settings 模块 – 日志设置。
注意
此模块是 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。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值，在使用前需要将其调整为数据源。
参数
参数 |
注释 |
|---|---|
用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。 选项
|
|
启用/禁用任务的日志记录。 选项
|
|
使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
设置的顶层参数。 |
|
每个 Adom 的每次日志浏览尝试的最大日志文件数。 |
|
启用/禁用查找在接收到的未加密 syslog 中的设备 ID。 disable - 禁用查找在接收到的未加密 syslog 中的设备 ID。 enable - 启用查找在接收到的未加密 syslog 中的设备 ID。 选项
|
|
启用/禁用通过 DNS 解析目标 IP。 disable - 禁用通过 DNS 解析目标 IP。 enable - 启用通过 DNS 解析目标 IP。 选项
|
|
每次日志下载尝试的最大日志数。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
要索引的自定义日志字段的名称。 |
|
启用/禁用自动将 HA 成员日志合并到 HA 群集。 disable - 禁用自动将 HA 成员日志合并到 HA 群集。 enable - 启用自动将 HA 成员日志合并到 HA 群集。 选项
|
|
每次日志导入尝试的最大日志文件数。 |
|
启用/禁用在删除设备后保留开发日志。 disable - 禁用在删除设备后保留开发日志。 enable - 启用在删除设备后保留开发日志。 选项
|
|
用于存档的日志文件名格式，例如备份、上传或下载。 basic - 日志存档文件名的基本格式，例如。 extended - 日志存档文件名的扩展格式，例如。 选项
|
|
当设备被认为离线时，从设备接收不到日志的间隔时间（分钟）。 |
|
当设备被认为离线时，从设备上传日志的间隔时间（分钟）。 |
|
滚动分析器。 |
|
日志文件滚动计划 sun - 星期日。 mon - 星期一。 tue - 星期二。 wed - 星期三。 thu - 星期四。 fri - 星期五。 sat - 星期六。 选项
|
|
启用/禁用上传后删除日志文件。 disable - 禁用日志文件删除。 enable - 启用日志文件删除。 选项
|
|
上传服务器目录，对于 Unix 服务器，请使用绝对路径 |
|
当日志文件达到此大小时进行滚动 |
|
启用/禁用上传的日志文件压缩。 disable - 禁用压缩。 enable - 启用压缩。 选项
|
|
日志文件滚动计划 |
|
上传服务器 IP 地址。 |
|
上传服务器 IP2 地址。 |
|
上传服务器 IP3 地址。 |
|
上传的日志文件的格式。 native - 原生格式 text - 文本格式 csv - CSV 格式 选项
|
|
日志文件滚动计划 |
|
(list) 上传服务器登录密码。 |
|
(list) 上传服务器登录密码 2。 |
|
(list) 上传服务器登录密码 3。 |
|
上传服务器 IP1 端口号。 |
|
上传服务器 IP2 端口号。 |
|
上传服务器 IP3 端口号。 |
|
滚动升级状态 |
|
上传服务器 FQDN/IP。 |
|
上传服务器 2 FQDN/IP。 |
|
上传服务器 3 FQDN/IP。 |
|
上传服务器类型。 ftp - 通过 FTP 上传。 sftp - 通过 SFTP 上传。 scp - 通过 SCP 上传。 选项
|
|
启用/禁用日志文件上传。 disable - 禁用日志文件上传。 enable - 启用日志文件上传。 选项
|
|
日志文件上传计划 |
|
具有多个服务器的上传模式。 backup - 服务器在连接失败后会依次尝试使用。 mirror - 所有配置的服务器都会尝试并使用。 选项
|
|
触发日志文件上传的事件。 on-roll - 在日志文件滚动后上传。 on-schedule - 每天上传日志文件。 选项
|
|
上传服务器登录用户名。 |
|
上传服务器登录用户名 2。 |
|
上传服务器登录用户名 3。 |
|
定期滚动日志文件。 none - 不定期滚动日志文件。 daily - 每日滚动日志文件。 weekly - 在每周的特定几天滚动日志文件。 选项
|
|
滚动本地。 |
|
日志文件滚动计划 sun - 星期日。 mon - 星期一。 tue - 星期二。 wed - 星期三。 thu - 星期四。 fri - 星期五。 sat - 星期六。 选项
|
|
启用/禁用上传后删除日志文件。 disable - 禁用日志文件删除。 enable - 启用日志文件删除。 选项
|
|
上传服务器目录，对于 Unix 服务器，请使用绝对路径 |
|
当日志文件达到此大小时进行滚动 |
|
启用/禁用上传的日志文件压缩。 disable - 禁用压缩。 enable - 启用压缩。 选项
|
|
日志文件滚动计划 |
|
上传服务器 IP 地址。 |
|
上传服务器 IP2 地址。 |
|
上传服务器 IP3 地址。 |
|
上传的日志文件的格式。 native - 原生格式 text - 文本格式 csv - CSV 格式 选项
|
|
日志文件滚动计划 |
|
(list) 上传服务器登录密码。 |
|
(list) 上传服务器登录密码 2。 |
|
(list) 上传服务器登录密码 3。 |
|
上传服务器 IP1 端口号。 |
|
上传服务器 IP2 端口号。 |
|
上传服务器 IP3 端口号。 |
|
滚动升级状态 |
|
上传服务器 FQDN/IP。 |
|
上传服务器 2 FQDN/IP。 |
|
上传服务器 3 FQDN/IP。 |
|
上传服务器类型。 ftp - 通过 FTP 上传。 sftp - 通过 SFTP 上传。 scp - 通过 SCP 上传。 选项
|
|
启用/禁用日志文件上传。 disable - 禁用日志文件上传。 enable - 启用日志文件上传。 选项
|
|
日志文件上传计划 |
|
具有多个服务器的上传模式。 backup - 服务器在连接失败后会依次尝试使用。 mirror - 所有配置的服务器都会尝试并使用。 选项
|
|
触发日志文件上传的事件。 on-roll - 在日志文件滚动后上传。 on-schedule - 每天上传日志文件。 选项
|
|
上传服务器登录用户名。 |
|
上传服务器登录用户名 2。 |
|
上传服务器登录用户名 3。 |
|
定期滚动日志文件。 none - 不定期滚动日志文件。 daily - 每日滚动日志文件。 weekly - 在每周的特定几天滚动日志文件。 选项
|
|
滚动常规。 |
|
日志文件滚动计划 sun - 星期日。 mon - 星期一。 tue - 星期二。 wed - 星期三。 thu - 星期四。 fri - 星期五。 sat - 星期六。 选项
|
|
启用/禁用上传后删除日志文件。 disable - 禁用日志文件删除。 enable - 启用日志文件删除。 选项
|
|
上传服务器目录，对于 Unix 服务器，请使用绝对路径 |
|
当日志文件达到此大小时进行滚动 |
|
启用/禁用上传的日志文件压缩。 disable - 禁用压缩。 enable - 启用压缩。 选项
|
|
日志文件滚动计划 |
|
上传服务器 IP 地址。 |
|
上传服务器 IP2 地址。 |
|
上传服务器 IP3 地址。 |
|
上传的日志文件的格式。 native - 原生格式 text - 文本格式 csv - CSV 格式 选项
|
|
日志文件滚动计划 |
|
(list) 上传服务器登录密码。 |
|
(list) 上传服务器登录密码 2。 |
|
(list) 上传服务器登录密码 3。 |
|
上传服务器 IP1 端口号。 |
|
上传服务器 IP2 端口号。 |
|
上传服务器 IP3 端口号。 |
|
滚动升级状态 |
|
上传服务器 FQDN/IP。 |
|
上传服务器 2 FQDN/IP。 |
|
上传服务器 3 FQDN/IP。 |
|
上传服务器类型。 ftp - 通过 FTP 上传。 sftp - 通过 SFTP 上传。 scp - 通过 SCP 上传。 选项
|
|
启用/禁用日志文件上传。 disable - 禁用日志文件上传。 enable - 启用日志文件上传。 选项
|
|
日志文件上传计划 |
|
具有多个服务器的上传模式。 backup - 服务器在连接失败后会依次尝试使用。 mirror - 所有配置的服务器都会尝试并使用。 选项
|
|
触发日志文件上传的事件。 on-roll - 在日志文件滚动后上传。 on-schedule - 每天上传日志文件。 选项
|
|
上传服务器登录用户名。 |
|
上传服务器登录用户名 2。 |
|
上传服务器登录用户名 3。 |
|
定期滚动日志文件。 none - 不定期滚动日志文件。 daily - 每日滚动日志文件。 weekly - 在每周的特定几天滚动日志文件。 选项
|
|
同步模式下运行日志搜索会话的最大秒数。 |
|
启用/禁用通过 UDP 接收 syslog disable - 禁用通过 UDP 接收 syslog enable - 启用通过 UDP 接收 syslog 选项
|
|
在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他包括 root 在内的值。 |
|
等待其他用户释放工作区锁定的最大秒数。 默认值: |
说明
注意
从 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 settings.
fortinet.fortimanager.fmgr_system_log_settings:
# 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:
FAC_custom_field1: <string>
FAZ_custom_field1: <string>
FCH_custom_field1: <string>
FCT_custom_field1: <string>
FDD_custom_field1: <string>
FGT_custom_field1: <string>
FMG_custom_field1: <string>
FML_custom_field1: <string>
FPX_custom_field1: <string>
FSA_custom_field1: <string>
FWB_custom_field1: <string>
browse_max_logfiles: <integer>
dns_resolve_dstip: <value in [disable, enable]>
download_max_logs: <integer>
ha_auto_migrate: <value in [disable, enable]>
import_max_logfiles: <integer>
log_file_archive_name: <value in [basic, extended]>
rolling_analyzer:
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>
rolling_local:
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>
rolling_regular:
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>
sync_search_timeout: <integer>
keep_dev_logs: <value in [disable, enable]>
device_auto_detect: <value in [disable, enable]>
unencrypted_logging: <value in [disable, enable]>
log_interval_dev_no_logging: <integer>
log_upload_interval_dev_no_logging: <integer>
返回值
通用返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 始终 |
|
请求的完整 URL。 返回: 始终 示例: |
|
API 请求的状态。 返回: 始终 示例: |
|
API 响应。 返回: 始终 |
|
API 响应的描述性消息。 返回: 始终 示例: |
|
目标系统的信息。 返回: 始终 |
|
请求的状态。 返回: 始终 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。 返回: 复杂 |