fortinet.fortimanager.fmgr_system_report_group_groupby – Переменные группировки.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_report_group_groupby.
Новое в версии 2.10: плагина fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для использования с источниками данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| Устанавливается в значение True только при несовпадении схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. | |
| group строка / обязательно | Параметр (group) в запрошенном URL. | ||
| rc_failed список / элементы=строка | Список кодов rc, при которых условия выполнения завершаются ошибкой. | ||
| rc_succeeded список / элементы=строка | Список кодов rc, при которых условия выполнения завершаются успешно. | ||
| state строка / обязательно |
| Директива для создания, обновления или удаления объекта. | |
| system_report_group_groupby словарь | Параметры верхнего уровня. | ||
| var-expression строка | Выражение переменной. | ||
| var-name строка | Имя переменной. | ||
| var-type строка |
| Тип переменной. целое число - Целое число. строка - Строка. перечисление - Перечисление. ip - IP-адрес. | |
| workspace_locking_adom строка | Область (adom) для блокировки в режиме работы FortiManager в пространстве рабочего места. Значение может быть глобальным и другими, включая корневой. | ||
| 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: Group-by variables.
fmgr_system_report_group_groupby:
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, ...]
group: <your own value>
state: <value in [present, absent]>
system_report_group_groupby:
var-expression: <value of string>
var-name: <value of string>
var-type: <value in [integer, string, enum, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_report_group_groupby_module.html
