fortinet.fortimanager.fmgr_system_admin_user_dashboard – Настраиваемые виджеты панели мониторинга.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_admin_user_dashboard.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | Список кодов rc, при которых выполнение будет прервано | ||
| rc_succeeded список / элементы=строка | Список кодов rc, при которых выполнение будет успешно завершено | ||
| state строка / обязательный |
| Директива для создания, обновления или удаления объекта | |
| system_admin_user_dashboard словарь | Набор параметров верхнего уровня | ||
| column целое число | По умолчанию: 0 | Идентификатор колонки виджета. | |
| diskio-content-type строка |
| Тип диаграммы виджета мониторинга дискового ввода-вывода. util - использование полосы пропускания. iops - количество запросов ввода-вывода. blks - объем данных запросов ввода-вывода. | |
| diskio-period строка |
| Период данных виджета мониторинга дискового ввода-вывода. 1час - 1 час. 8час - 8 часов. 24час - 24 часа. | |
| log-rate-period строка |
| Период данных виджета мониторинга приема логов. 2мин - 2 минуты. 1час - 1 час. 6час - 6 часов. | |
| log-rate-topn строка |
| Количество отображаемых элементов виджета мониторинга приема логов. 1 - Топ 1. 2 - Топ 2. 3 - Топ 3. 4 - Топ 4. 5 - Топ 5. | |
| log-rate-type строка |
| Параметры агрегации статистики виджета мониторинга приема логов. лог - Показать скорость логов для каждого типа лога. устройство - Показать скорость логов для каждого устройства. | |
| moduleid целое число | По умолчанию: 0 | Идентификатор виджета. | |
| name строка | Название виджета. | ||
| num-entries целое число | По умолчанию: 10 | Количество записей. | |
| refresh-interval целое число | По умолчанию: 300 | Интервал обновления виджета. | |
| res-cpu-display строка |
| Тип отображения CPU виджета. среднее - Среднее использование CPU. каждое - Использование CPU каждого ядра. | |
| res-period строка |
| Период данных виджета. 10мин - Последние 10 минут. час - Последний час. день - Последний день. | |
| res-view-type строка |
| Тип отображения данных виджета. реальное время - Режим реального времени. история - Режим истории. | |
| status строка |
| Состояние виджета (открыто/закрыто). закрыто - Виджет закрыт. открыто - Виджет открыт. | |
| tabid целое число | По умолчанию: 0 | Идентификатор вкладки, где отображается виджет. | |
| time-period строка |
| Период данных виджета мониторинга базы данных логов. 1час - 1 час. 8час - 8 часов. 24час - 24 часа. | |
| widget-type строка |
| Тип виджета. top-lograte - Мониторинг приема логов. sysres - Системные ресурсы. sysinfo - Информация о системе. licinfo - Информация о лицензиях. jsconsole - Консоль CLI. sysop - Операции с устройствами. alert - Консоль сообщений об ошибках. statistics - Статистика. rpteng - Отчеты. raid - Мониторинг дисков. logrecv - Прием логов/данных. devsummary - Обзор устройств. logdb-perf - Мониторинг производительности базы данных логов. logdb-lag - Задержка базы данных логов. disk-io - Дисковый ввод-вывод. log-rcvd-fwd - Мониторинг приема и пересылки логов. | |
| user строка / обязательный | Параметр (пользователь) в запрошенном URL | ||
| workspace_locking_adom строка | Область (ADOM) для блокировки при работе FortiManager в режиме рабочего пространства. Значение может быть глобальным и другими, включая root. | ||
| workspace_locking_timeout целое число | По умолчанию: 300 | Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. | |
Примечания
Примечание
- Поддерживается работа в режиме блокировки рабочего пространства в этом модуле FortiManager. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого кода rc. Вы также можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Custom dashboard widgets.
fmgr_system_admin_user_dashboard:
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, ...]
user: <your own value>
state: <value in [present, absent]>
system_admin_user_dashboard:
column: <value of integer>
diskio-content-type: <value in [util, iops, blks]>
diskio-period: <value in [1hour, 8hour, 24hour]>
log-rate-period: <value in [2min, 1hour, 6hours]>
log-rate-topn: <value in [1, 2, 3, ...]>
log-rate-type: <value in [log, device]>
moduleid: <value of integer>
name: <value of string>
num-entries: <value of integer>
refresh-interval: <value of integer>
res-cpu-display: <value in [average, each]>
res-period: <value in [10min, hour, day]>
res-view-type: <value in [real-time, history]>
status: <value in [close, open]>
tabid: <value of integer>
time-period: <value in [1hour, 8hour, 24hour]>
widget-type: <value in [top-lograte, sysres, sysinfo, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрос URL Пример: /sys/login/user |
| response_code целое число | всегда | Код состояния запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_admin_user_dashboard_module.html
