fortinet.fortimanager.fmgr_system_locallog_disk_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_disk_setting。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前根据数据源调整的参数和值。
参数
参数 |
注释 |
|---|---|
无需用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 FortiCloud API 访问令牌验证 Ansible 客户端。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
设置的顶级参数。 |
|
磁盘满时要应用的策略。 overwrite - 磁盘满时覆盖最旧的日志。 nolog - 磁盘满时停止日志记录。 选项
|
|
将日志磁盘使用率达到此百分比时视为已满。 |
|
控制本地日志大小的配额。 |
|
滚动前日志文件的最大数量。 |
|
滚动前日志文件的最大大小。 |
|
滚动日志的星期几。 sunday - 星期日。 monday - 星期一。 tuesday - 星期二。 wednesday - 星期三。 thursday - 星期四。 friday - 星期五。 saturday - 星期六。 选项
|
|
检查日志文件以进行滚动的频率。 none - 未计划。 daily - 每天。 weekly - 每周。 选项
|
|
(列表或字符串) 滚动日志的时间 |
|
服务器类型。 FTP - 通过 FTP 上传。 SFTP - 通过 SFTP 上传。 SCP - 通过 SCP 上传。 选项
|
|
要记录的最低严重级别。 emergency - 紧急级别。 alert - 警报级别。 critical - 严重级别。 error - 错误级别。 warning - 警告级别。 notification - 通知级别。 information - 信息级别。 debug - 调试级别。 选项
|
|
启用/禁用本地磁盘日志。 disable - 不要记录到本地磁盘。 enable - 记录到本地磁盘。 选项
|
|
滚动时上传日志文件。 disable - 滚动日志文件时禁用上传。 enable - 滚动日志文件时启用上传。 选项
|
|
上传后删除日志文件 disable - 上传后不要删除日志文件。 enable - 上传后删除日志文件。 选项
|
|
(列表或字符串) 上传日志的时间 |
|
日志文件上传远程目录。 |
|
日志上传服务器的 IP 地址。 |
|
(列表) 上传服务器中用户帐户的密码。 |
|
服务器端口 |
|
计划上传 disable - 滚动时上传。 enable - 计划上传。 选项
|
|
需要上传的日志文件类型。 event - 上传事件日志。 选项
|
|
上传服务器中的用户帐户。 |
|
压缩上传日志。 disable - 将日志文件上传为纯文本。 enable - 将压缩后的日志文件上传。 选项
|
|
在工作区模式下运行 FortiManager 时要锁定的 ADOM，该值可以是全局值和其他值，包括 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: Settings for local disk logging.
fortinet.fortimanager.fmgr_system_locallog_disk_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_disk_setting:
diskfull: <value in [overwrite, nolog]>
log_disk_full_percentage: <integer>
max_log_file_size: <integer>
roll_day:
- "sunday"
- "monday"
- "tuesday"
- "wednesday"
- "thursday"
- "friday"
- "saturday"
roll_schedule: <value in [none, daily, weekly]>
roll_time: <list or string>
server_type: <value in [FTP, SFTP, SCP]>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, enable]>
upload: <value in [disable, enable]>
upload_delete_files: <value in [disable, enable]>
upload_time: <list or string>
uploaddir: <string>
uploadip: <string>
uploadpass: <list or string>
uploadport: <integer>
uploadsched: <value in [disable, enable]>
uploadtype:
- "event"
uploaduser: <string>
uploadzip: <value in [disable, enable]>
log_disk_quota: <integer>
max_log_file_num: <integer>
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整URL。 返回：始终 示例： |
|
API请求的状态。 返回：始终 示例： |
|
API响应。 返回：始终 |
|
API响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回：复杂类型 |