fortinet.fortimanager.fmgr_system_report_setting 模块 – 报告设置。

注意

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

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

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

要在 Playbook 中使用它，请指定： fortinet.fortimanager.fmgr_system_report_setting。

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 代码列表。

system_report_setting

字典

设置的顶层参数。

aggregate_report

别名: aggregate-report

字符串

启用/禁用包括组报告以及每个设备的报告。

disable - 排除组报告以及每个设备的报告。

enable - 包括组报告以及每个设备的报告。

选项

  • "disable"

  • "enable"

capwap_port

别名: capwap-port

整数

按端口排除 capwap 流量。

capwap_service

别名: capwap-service

字符串

按服务排除 capwap 流量。

exclude_capwap

别名: exclude-capwap

字符串

排除 capwap 流量。

disable - 禁用。

by-port - 按端口。

by-service - 按服务。

选项

  • "disable"

  • "by-port"

  • "by-service"

hcache_lossless

别名: hcache-lossless

字符串

准备就绪且有损的 hcaches 的可用性。

disable - 使用准备就绪且有损的 hcaches。

enable - 不使用准备就绪且有损的 hcaches。

选项

  • "disable"

  • "enable"

ldap_cache_timeout

别名: ldap-cache-timeout

整数

LDAP 缓存超时时间（以分钟为单位），默认值为 60，0 表示不使用缓存。

max_rpt_pdf_rows

别名: max-rpt-pdf-rows

整数

单个 pdf 中可生成的最大行数。

max_table_rows

别名: max-table-rows

整数

单个表中可生成的最大行数。

report_priority

别名: report-priority

字符串

SQL 报告的优先级。

high - 高

low - 低

auto - 自动

选项

  • "high"

  • "low"

  • "auto"

template_auto_install

别名: template-auto-install

字符串

新 ADOM 使用的语言

default - 默认。

english - 英语。

选项

  • "default"

  • "english"

week_start

别名: week-start

字符串

一周开始的星期几。

sun - 星期日。

mon - 星期一。

选项

  • "sun"

  • "mon"

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 可帮助完成此工作。

  • 通常，当返回非零 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: Report settings.
      fortinet.fortimanager.fmgr_system_report_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_report_setting:
          aggregate_report: <value in [disable, enable]>
          hcache_lossless: <value in [disable, enable]>
          ldap_cache_timeout: <integer>
          max_table_rows: <integer>
          report_priority: <value in [high, low, auto]>
          template_auto_install: <value in [default, english]>
          week_start: <value in [sun, mon]>
          capwap_port: <integer>
          capwap_service: <string>
          exclude_capwap: <value in [disable, by-port, by-service]>
          max_rpt_pdf_rows: <integer>

返回值

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

键

描述

元数据

字典

请求的结果。

返回: 始终

request_url

字符串

请求的完整 URL。

返回: 始终

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 始终

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回: 始终

response_message

字符串

API 响应的描述性消息。

返回: 始终

示例: "OK."

system_information

字典

目标系统的信息。

返回: 始终

rc

整数

请求的状态。

返回: 始终

示例: 0

version_check_warning

列表 / 元素=字符串

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑 लिंक (@chillancezen)

  • 沈Frank (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)