fortinet.fortios.fortios_log_custom_field 模块 – 在 Fortinet FortiOS 和 FortiGate 中配置自定义日志字段。
注意
此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 Playbook 中使用它，请指定： fortinet.fortios.fortios_log_custom_field。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够配置 FortiGate 或 FortiOS (FOS) 设备，允许用户设置和修改日志功能和 custom_field 类别。示例包括所有参数和值，需要在使用前调整到数据源。使用 FOS v6.0.0 测试。
要求
在执行此模块的主机上需要满足以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
配置自定义日志字段。 |
|
字段 ID 字符串。 |
|
字段名称（最大：15 个字符）。 |
|
字段值（最大：15 个字符）。 |
|
要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
虚拟域，在先前定义的那些中。vdom 是 FortiGate 的一个虚拟实例，可以配置并用作不同的单元。 默认值： |
说明
注意
旧版 fortiosapi 已被弃用，httpapi 是运行 Playbook 的首选方法
该模块支持 check_mode。
示例
- name: Configure custom log fields.
fortinet.fortios.fortios_log_custom_field:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
log_custom_field:
id: "3"
name: "default_name_4"
value: "<your_own_value>"
返回值
常见的返回值记录在 这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
Fortigate 映像的版本号 已返回： 始终 示例： |
|
最后一次用于将内容配置到 FortiGate 的方法 已返回： 始终 示例： |
|
FortiGate 在上次应用操作时给出的最后结果 已返回： 始终 示例： |
|
上次调用 FortiGate 时使用的主键 (id) 已返回： 成功 示例： |
|
用于满足请求的表名 已返回： 始终 示例： |
|
用于满足请求的表的路径 已返回： 始终 示例： |
|
内部修订号 已返回： 始终 示例： |
|
单元的序列号 已返回： 始终 示例： |
|
操作结果的指示 已返回： 始终 示例： |
|
使用的虚拟域 已返回： 始终 示例： |
|
FortiGate 的版本 已返回： 始终 示例： |