fortinet.fortimanager.fmgr_system_report_group – Группа отчетов.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_report_group.

В версии 2.10: плагина fortinet.fortimanager

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать для данных из источников данных перед использованием.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean			Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров
rc_failed список / элементы=строка				список кодов rc, при которых будут нарушаться условия для завершения выполнения с ошибкой
rc_succeeded список / элементы=строка				список кодов rc, при которых будут нарушаться условия для завершения выполнения успешно
state строка / обязательно			Варианты: present absent	директива для создания, обновления или удаления объекта
system_report_group словарь				установленные параметры верхнего уровня
	adom строка			Имя домена администратора.
	case-insensitive строка		Варианты: выключить включить ←	Без учета регистра. выключить - Выключить соответствие без учета регистра. включить - Включить соответствие без учета регистра.
	chart-alternative список / элементы=строка			нет описания
		chart-name строка		Имя диаграммы.
		chart-replace строка		Замена диаграммы.
	group-by список / элементы=строка			нет описания
		var-expression строка		Выражение переменной.
		var-name строка		Имя переменной.
		var-type строка	Варианты: целое число строка ← перечисление ip	Тип переменной. целое число - Целое число. строка - Строка. перечисление - Перечисление. ip - IP.
	group-id целое число		Значение по умолчанию: 0	Идентификатор группы.
	report-like строка			Шаблон отчета.
workspace_locking_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: Report group.
     fmgr_system_report_group:
        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, ...]
        state: <value in [present, absent]>
        system_report_group:
           adom: <value of string>
           case-insensitive: <value in [disable, enable]>
           chart-alternative:
             -
                 chart-name: <value of string>
                 chart-replace: <value of string>
           group-by:
             -
                 var-expression: <value of string>
                 var-name: <value of string>
                 var-type: <value in [integer, string, enum, ...]>
           group-id: <value of integer>
           report-like: <value of string>

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
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_module.html