fortinet.fortimanager.fmgr_system_logfetch_clientprofile 模块 – 日志提取客户端配置文件设置。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_system_logfetch_clientprofile。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有需要在使用前调整为数据源的参数和值。

参数

参数

注释

access_token

字符串

无需用户名和密码即可访问 FortiManager 的令牌。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必填

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

system_logfetch_clientprofile

字典

设置的顶级参数。

client_adom

别名：client-adom

字符串

日志提取客户端的 ADOM 名称。

data_range

别名：data-range

字符串

提取日志的数据范围。

custom - 指定其他日期和时间范围。

选项

  • "custom"

data_range_value

别名：data-range-value

整数

最近 n 天或 n 小时。

device_filter

别名：device-filter

列表 / 元素=字典

设备过滤器。

adom

字符串

ADOM 名称。

device

字符串

设备名称或序列号。

id

整数

添加或编辑设备过滤器。

vdom

字符串

Vdom 过滤器。

end_time

别名：end-time

任意

(列表) 数据范围的结束日期和时间

id

整数 / 必填

日志提取客户端配置文件 ID。

index_fetch_logs

别名：index-fetch-logs

字符串

启用/禁用提取日志后自动索引日志。

disable - 禁用属性功能。

enable - 启用属性功能。

选项

  • "disable"

  • "enable"

log_filter

别名：log-filter

列表 / 元素=字典

日志过滤器。

field

字符串

字段名称。

id

整数

日志过滤器 ID。

oper

字符串

字段过滤器运算符。

无描述

无描述

contain - 包含

not-contain - 不包含

match - 匹配

选项

  • "="

  • "!="

  • "<"

  • ">"

  • "<="

  • ">="

  • "contain"

  • "not-contain"

  • "match"

value

字符串

字段过滤器操作数或自由文本匹配表达式。

log_filter_logic

别名：log-filter-logic

字符串

日志过滤器的 And/Or 逻辑。

and - 逻辑与。

or - 逻辑或。

选项

  • "and"

  • "or"

log_filter_status

别名：log-filter-status

字符串

启用/禁用日志过滤器。

disable - 禁用属性功能。

enable - 启用属性功能。

选项

  • "disable"

  • "enable"

name

字符串

日志提取客户端配置文件的名称。

password

任意

(列表) 日志提取服务器登录密码。

peer_cert_cn

别名：peer-cert-cn

字符串

日志收集服务器的证书公用名。

secure_connection

别名：secure-connection

字符串

启用/禁用使用TLS/SSL保护日志收集连接。

disable - 禁用属性功能。

enable - 启用属性功能。

选项

  • "disable"

  • "enable"

server_adom

别名：server-adom

字符串

日志收集服务器端的ADOM名称。

server_ip

别名：server-ip

字符串

日志收集服务器IP地址。

start_time

别名：start-time

任意

(列表) 数据范围的开始日期和时间。

sync_adom_config

别名：sync-adom-config

字符串

启用/禁用同步ADOM相关配置。

disable - 禁用属性功能。

enable - 启用属性功能。

选项

  • "disable"

  • "enable"

user

字符串

日志收集服务器登录用户名。

workspace_locking_adom

字符串

在工作区模式下运行FortiManager时要锁定的ADOM，值可以是global和其他包括root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

注释

注意

  • 从2.4.0版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将例如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在ansible.cfg中设置deprecation_warnings=False来忽略此警告。

  • 此FortiManager模块支持在工作区锁定模式下运行，顶级参数workspace_locking_adom和workspace_locking_timeout有助于完成此工作。

  • 要创建或更新对象，请使用state present指令。

  • 要删除对象，请使用state absent指令。

  • 通常，当返回非零rc时，运行一个模块可能会失败。您还可以使用参数rc_failed和rc_succeeded覆盖失败或成功的条件。

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Log-fetch client profile settings.
      fortinet.fortimanager.fmgr_system_logfetch_clientprofile:
        bypass_validation: false
        state: present
        system_logfetch_clientprofile:
          client-adom: ansible
          data-range: custom # <value in [custom]>
          id: 1
          index-fetch-logs: enable
          name: ansible-test-clientprofile
          password: fortinet
          server-ip: "222.222.22.25"
          user: ansible

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the Log-fetch client profile settings
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_logfetch_clientprofile"
          params:
            client-profile: "your_value"

返回值

常见的返回值已在此处记录，以下是此模块特有的字段。

键

描述

meta

字典

请求的结果。

返回值：始终

request_url

字符串

请求的完整URL。

返回值：始终

示例： "/sys/login/user"

response_code

整数

API请求的状态。

返回值：始终

示例： 0

response_data

列表 / 元素=字符串

API响应。

返回值：始终

response_message

字符串

API响应的描述性消息。

返回值：始终

示例： "OK."

system_information

字典

目标系统的信息。

返回值：始终

rc

整数

请求的状态。

返回值：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。

返回值：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑林 (@chillancezen)

  • 沈峰 (@fshen01)

  • 陆宏斌 (@fgtdev-hblu)