fortinet.fortimanager.fmgr_system_admin_user_dashboard 模块 – 自定义仪表板小部件。

注意

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

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

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

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

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_admin_user_dashboard

字典

设置的顶级参数。

column

整数

小部件列 ID。

diskio_content_type

别名：diskio-content-type

字符串

磁盘 I/O 监控小部件图表类型。

util - 带宽利用率。

iops - I/O 请求数量。

blks - I/O 请求的数据量。

选项

  • "util"

  • "iops"

  • "blks"

diskio_period

别名：diskio-period

字符串

磁盘 I/O 监控小部件数据周期。

1hour - 1 小时。

8hour - 8 小时。

24hour - 24 小时。

选项

  • "1hour"

  • "8hour"

  • "24hour"

log_rate_period

别名：log-rate-period

字符串

日志接收监控小部件数据周期。

2min - 2 分钟。

1hour - 1 小时。

6hours - 6 小时。

选项

  • "2min"

  • "1hour"

  • "6hours"

log_rate_topn

别名：log-rate-topn

字符串

日志接收监控小部件要显示的顶级项目数量。

1 - 前 1 名。

2 - 前 2 名。

3 - 前 3 名。

4 - 前 4 名。

5 - 前 5 名。

选项

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

log_rate_type

别名：log-rate-type

字符串

日志接收监控小部件统计细分选项。

log - 显示每种日志类型的日志速率。

device - 显示每台设备的日志速率。

选项

  • "log"

  • "device"

moduleid

整数 / 必填

小部件 ID。

name

字符串

小部件名称。

num_entries

别名：num-entries

整数

条目数。

refresh_interval

别名：refresh-interval

整数

小部件刷新间隔。

res_cpu_display

别名：res-cpu-display

字符串

小部件 CPU 显示类型。

average - CPU 平均使用率。

each - CPU 各个核心的使用率。

选项

  • "average"

  • "each"

res_period

别名：res-period

字符串

小部件数据周期。

10min - 过去 10 分钟。

hour - 过去 1 小时。

day - 过去 1 天。

选项

  • "10min"

  • "hour"

  • "day"

res_view_type

别名：res-view-type

字符串

小部件数据视图类型。

real-time - 实时视图。

history - 历史视图。

选项

  • "real-time"

  • "history"

status

字符串

小部件打开/关闭状态。

close - 小部件关闭。

open - 小部件打开。

选项

  • "close"

  • "open"

tabid

整数

显示小部件的选项卡 ID。

time_period

别名：time-period

字符串

日志数据库监控小部件数据周期。

1hour - 1 小时。

8hour - 8 小时。

24hour - 24 小时。

选项

  • "1hour"

  • "8hour"

  • "24hour"

widget_type

别名：widget-type

字符串

小部件类型。

top-lograte - 日志接收监控。

sysres - 系统资源。

sysinfo - 系统信息。

licinfo - 许可证信息。

jsconsole - CLI 控制台。

sysop - 单位操作。

alert - 警报消息控制台。

statistics - 统计信息。

rpteng - 报表引擎。

raid - 磁盘监控。

logrecv - 日志/数据接收。

devsummary - 设备摘要。

logdb-perf - 日志数据库性能监控。

logdb-lag - 日志数据库延迟时间。

disk-io - 磁盘I/O。

log-rcvd-fwd - 日志接收和转发监控。

选项

  • "top-lograte"

  • "sysres"

  • "sysinfo"

  • "licinfo"

  • "jsconsole"

  • "sysop"

  • "alert"

  • "statistics"

  • "rpteng"

  • "raid"

  • "logrecv"

  • "devsummary"

  • "logdb-perf"

  • "logdb-lag"

  • "disk-io"

  • "log-rcvd-fwd"

用户

字符串 / 必填

请求URL中的参数 (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: Custom dashboard widgets.
      fortinet.fortimanager.fmgr_system_admin_user_dashboard:
        bypass_validation: false
        user: ansible-test
        state: present
        system_admin_user_dashboard:
          column: 1
          diskio-content-type: util # <value in [util, iops, blks]>
          diskio-period: 1hour # <value in [1hour, 8hour, 24hour]>
          log-rate-period: 1hour # <value in [2min , 1hour, 6hours]>
          log-rate-topn: 5 # <value in [1, 2, 3, ...]>
          log-rate-type: device # <value in [log, device]>
          moduleid: 10
          name: ansible-test-dashboard
          num-entries: 10
          refresh-interval: 0
          res-cpu-display: "each" # <value in [average , each]>
          res-period: 10min # <value in [10min , hour, day]>
          res-view-type: history # <value in [real-time , history]>
          status: open # <value in [close, open]>
          tabid: 1
          time-period: 1hour # <value in [1hour, 8hour, 24hour]>
          widget-type: sysres # <value in [top-lograte, sysres, sysinfo, ...]>

- 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 dashboard widgets
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_user_dashboard"
          params:
            user: "ansible-test"
            dashboard: "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)