fortinet.fortimanager.fmgr_system_admin_user_dashboard модуль — Пользовательские виджеты панели мониторинга.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_system_admin_user_dashboard.
Новое в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логическое | Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия неудачи. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
system_admin_user_dashboard словарь | Установленные параметры верхнего уровня. |
|
column целое число |
Идентификатор столбца виджета. |
|
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 строка |
Варианты отображения статистики виджетов мониторинга скорости приема логов. log - Отображение скоростей логов для каждого типа логов. device - Отображение скоростей логов для каждого устройства. Варианты:
|
|
moduleid целое число / обязательно |
Идентификатор виджета. |
|
name строка |
Имя виджета. |
|
num_entries целое число |
Количество записей. |
|
refresh-interval integer |
Устаревшее, пожалуйста, переименуйте на refresh_interval. Интервал обновления виджетов. |
|
res-cpu-display string |
Устаревшее, пожалуйста, переименуйте на res_cpu_display. Тип отображения CPU виджетов. average - Среднее использование процессора. each - Каждое использование процессора. Варианты:
|
|
res-period string |
Устаревшее, пожалуйста, переименуйте на res_period. Период данных виджетов. 10min - Последние 10 минут. hour - Последний час. day - Последние сутки. Варианты:
|
|
res-view-type string |
Устаревшее, пожалуйста, переименуйте на res_view_type. Тип представления данных виджетов. real-time - Реальное время. history - История. Варианты:
|
|
status string |
Состояние виджетов (открыт/закрыт). close - Виджет закрыт. open - Виджет открыт. Варианты:
|
|
tabid integer |
ID вкладки, где отображается виджет. |
|
time-period string |
Устаревшее, пожалуйста, переименуйте на time_period. Период данных виджетов мониторинга базы данных логов. 1hour - 1 час. 8hour - 8 часов. 24hour - 24 часа. Варианты:
|
|
widget-type string |
Устаревшее, пожалуйста, переименуйте на widget_type. Тип виджета. |
user string / обязательно | Параметр (user) в запрошенном URL. |
workspace_locking_adom string | ADOM для блокировки в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют обозначение с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name” на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- Поддержка работы в режиме блокировки рабочего пространства реализована в этом модуле 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 запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на сборки
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_admin_user_dashboard_module.html
