fortinet.fortimanager.fmgr_system_admin_user_dashboardtabs – Настраиваемая панель мониторинга.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_admin_user_dashboardtabs.
Введено в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, используя источники данных, перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed list / elements=string | список кодов rc, при которых условия будут нарушены | ||
| rc_succeeded list / elements=string | список кодов rc, при которых условия будут выполнены | ||
| state string / required |
| направление для создания, обновления или удаления объекта | |
| system_admin_user_dashboardtabs dictionary | параметры верхнего уровня | ||
| name string | Имя вкладки. | ||
| tabid integer | Значение по умолчанию: 0 | Идентификатор вкладки. | |
| user string / required | параметр (user) в запрошенном URL | ||
| workspace_locking_adom string | адрес, который блокируется для FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая root | ||
| workspace_locking_timeout integer | Значение по умолчанию: 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.
fmgr_system_admin_user_dashboardtabs:
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_dashboardtabs:
name: <value of string>
tabid: <value of integer>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный запрошенный URL Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API |
| response_message string | всегда | Описание ответа 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_dashboardtabs_module.html