fortinet.fortimanager.fmgr_system_locallog_syslogd3_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_syslogd3_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_syslogd3_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_syslogd3_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 版本支持。 返回: complex |