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 设备。
示例包括在使用前需要调整到数据源的所有参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。 选择
|
|
启用/禁用任务日志记录。 选择
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
用于底层 Json RPC 请求的重写方法。 选择
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选择
|
|
设置的顶层参数。 |
|
小部件列 ID。 |
|
磁盘 I/O 监视器小部件图表类型。 util - 带宽利用率。 iops - I/O 请求的数量。 blks - I/O 请求的数据量。 选择
|
|
磁盘 I/O 监视器小部件数据周期。 1hour - 1 小时。 8hour - 8 小时。 24hour - 24 小时。 选择
|
|
日志接收监视器小部件数据周期。 2min - 2 分钟。 1hour - 1 小时。 6hours - 6 小时。 选择
|
|
日志接收监视器小部件要显示的顶部项目数。 1 - 前 1 名。 2 - 前 2 名。 3 - 前 3 名。 4 - 前 4 名。 5 - 前 5 名。 选择
|
|
日志接收监视器小部件统计信息细分选项。 log - 显示每种日志类型的日志速率。 device - 显示每个设备的日志速率。 选择
|
|
小部件 ID。 |
|
小部件名称。 |
|
条目数。 |
|
小部件刷新间隔。 |
|
小部件 CPU 显示类型。 average - CPU 的平均使用率。 each - CPU 的每次使用率。 选择
|
|
小部件数据周期。 10min - 最近 10 分钟。 hour - 最近一小时。 day - 最近一天。 选择
|
|
小部件数据视图类型。 real-time - 实时视图。 history - 历史视图。 选择
|
|
小部件打开/关闭状态。 close - 小部件已关闭。 open - 小部件已打开。 选择
|
|
显示小部件的选项卡的 ID。 |
|
日志数据库监视器小部件数据周期。 1hour - 1 小时。 8hour - 8 小时。 24hour - 24 小时。 选择
|
|
小部件类型。 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 - 日志接收和转发监视器。 选择
|
|
请求 URL 中的参数 (user)。 |
|
在工作区模式下运行的 FortiManager 要锁定的 ADOM，值可以是 global 和其他包括 root。 |
|
等待其他用户释放工作区锁的最长时间，以秒为单位。 默认值: |
说明
注意
从 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"
返回值
常见返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
API 请求的状态。 返回: 总是 示例: |
|
API 响应。 返回: 总是 |
|
API 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回: 复杂 |