fortinet.fortimanager.fmgr_system_report_group 模块 – 报告组。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_system_report_group。

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

string

用于访问 FortiManager 而无需使用用户名和密码的令牌。

bypass_validation

boolean

仅当模块架构与 FortiManager API 结构存在差异时才设置为 True，模块将继续执行而不验证参数。

选项

  • false ←（默认）

  • true

enable_log

boolean

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

选项

  • false ←（默认）

  • true

forticloud_access_token

string

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

proposed_method

string

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

state

string / required

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

选项

  • "present"

  • "absent"

system_report_group

dictionary

设置的顶层参数。

adom

string

管理域名称。

case_insensitive

别名：case-insensitive

string

大小写不敏感。

disable - 禁用大小写不敏感匹配。

enable - 启用大小写不敏感匹配。

选项

  • "disable"

  • "enable"

chart_alternative

别名：chart-alternative

list / elements=dictionary

图表替代方案。

chart_name

别名：chart-name

string

图表名称。

chart_replace

别名：chart-replace

string

图表替换。

group_by

别名：group-by

list / elements=dictionary

分组依据。

var_expression

别名：var-expression

string

变量表达式。

var_name

别名：var-name

string

变量名称。

var_type

别名：var-type

string

变量类型。

integer - 整数。

string - 字符串。

enum - 枚举。

ip - IP。

选项

  • "integer"

  • "string"

  • "enum"

  • "ip"

group_id

别名：group-id

integer / required

组 ID。

report_like

别名：report-like

string

报告模式。

workspace_locking_adom

string

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

workspace_locking_timeout

integer

等待其他用户释放工作区锁定的最长时间（以秒为单位）。

默认值： 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 (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 group.
      fortinet.fortimanager.fmgr_system_report_group:
        # 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, ...]
        state: present # <value in [present, absent]>
        system_report_group:
          adom: <string>
          case_insensitive: <value in [disable, enable]>
          chart_alternative:
            -
              chart_name: <string>
              chart_replace: <string>
          group_by:
            -
              var_expression: <string>
              var_name: <string>
              var_type: <value in [integer, string, enum, ...]>
          group_id: <integer>
          report_like: <string>

返回值

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

键

描述

meta

dictionary

请求的结果。

返回：始终

request_url

string

请求的完整 URL。

返回：始终

示例： "/sys/login/user"

response_code

integer

API 请求的状态。

返回：始终

示例： 0

response_data

list / elements=string

API 响应。

返回：始终

response_message

string

API 响应的描述性消息。

返回：始终

示例： "OK."

system_information

dictionary

目标系统的信息。

返回：始终

rc

integer

请求的状态。

返回：始终

示例： 0

版本检查警告

list / elements=string

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)