fortinet.fortimanager.fmgr_system_locallog_syslogd2_setting 模块 – 远程syslog服务器设置。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_system_locallog_syslogd2_setting。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
|---|---|
无需用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
设置的顶级参数。 |
|
选择用于安全连接的本地证书。 |
|
CSV 格式。 disable - 禁用 CSV 格式。 enable - 启用 CSV 格式。 选项
|
|
远程 syslog 设施。 kernel - 内核消息。 user - 随机用户级消息。 ntp - NTP 守护进程。 audit - 日志审计。 alert - 日志警报。 clock - 时钟守护进程。 mail - 邮件系统。 daemon - 系统守护进程。 auth - 安全/授权消息。 syslog - syslog 守护进程内部生成的邮件。 lpr - 行打印机子系统。 news - 网络新闻子系统。 uucp - 网络新闻子系统。 cron - 时钟守护进程。 authpriv - 安全/授权消息 ftp - FTP 守护进程。 local0 - 保留供本地使用。 local1 - 保留供本地使用。 local2 - 保留供本地使用。 local3 - 保留供本地使用。 local4 - 保留供本地使用。 local5 - 保留供本地使用。 local6 - 保留供本地使用。 local7 - 保留供本地使用。 选项
|
|
启用/禁用可靠的实时日志记录。 disable - 禁用可靠的实时日志记录。 enable - 启用可靠的实时日志记录。 选项
|
|
启用/禁用通过 TLS/SSL 保护的连接。 disable - 禁用 SSL 连接。 enable - 启用 SSL 连接。 选项
|
|
要记录的最低严重级别。 emergency - 紧急级别。 alert - 警报级别。 critical - 严重级别。 error - 错误级别。 warning - 警告级别。 notification - 通知级别。 information - 信息级别。 debug - 调试级别。 选项
|
|
远程 syslog 日志。 disable - 不要记录到远程 syslog 服务器。 enable - 记录到远程 syslog 服务器。 选项
|
|
远程 syslog 服务器名称。 |
|
在工作区模式下运行 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 remote syslog server.
fortinet.fortimanager.fmgr_system_locallog_syslogd2_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_syslogd2_setting:
csv: <value in [disable, enable]>
facility: <value in [kernel, user, ntp, ...]>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, enable]>
syslog_name: <string>
cert: <string>
reliable: <value in [disable, enable]>
secure_connection: <value in [disable, enable]>
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段：
键 |
描述 |
|---|---|
请求的结果。 返回值：始终 |
|
请求的完整 URL。 返回值：始终 示例： |
|
API 请求的状态。 返回值：始终 示例： |
|
API 响应。 返回值：始终 |
|
API 响应的描述性消息。 返回值：始终 示例： |
|
目标系统的信息。 返回值：始终 |
|
请求的状态。 返回值：始终 示例： |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回值：复杂类型 |