модуль fortinet.fortios.fortios_report_dataset — настройка набора данных отчёта в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_report_dataset.

Добавлено в fortinet.fortios 2.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию отчётов и категорию набора данных. Примеры содержат все параметры; перед использованием необходимо настроить значения в соответствии с источниками данных. Проверено на FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path подходит для выполнения операций с элементами.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
report_dataset словарь	Настройка набора данных отчёта.
field список / элементы=словарь	Поля.
displayname строка	Отображаемое имя.
id целое число / обязательный	Идентификатор поля (от 1 до количества столбцов в результате SQL-запроса). см. <a href=’#notes’>Примечания</a>.
name строка	Имя.
type строка	Тип поля. Варианты: `"text"` `"integer"` `"double"`
name строка / обязательный	Имя.
parameters список / элементы=словарь	Параметры.
data_type строка	Тип данных. Варианты: `"text"` `"integer"` `"double"` `"long-integer"` `"date-time"`
display_name строка	Отображаемое имя.
field строка	Имя поля SQL.
id целое число / обязательный	Идентификатор параметра (от 1 до количества столбцов в результате SQL-запроса). см. <a href=’#notes’>Примечания</a>.
policy целое число	Используется политикой мониторинга.
query строка	Инструкция SQL-запроса.
state строка / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
Модуль поддерживает check_mode.

Примеры

- name: Report dataset configuration.
  fortinet.fortios.fortios_report_dataset:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_dataset:
          field:
              -
                  displayname: "<your_own_value>"
                  id: "5"
                  name: "default_name_6"
                  type: "text"
          name: "default_name_8"
          parameters:
              -
                  data_type: "text"
                  display_name: "<your_own_value>"
                  field: "<your_own_value>"
                  id: "13"
          policy: "2147483647"
          query: "<your_own_value>"

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

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, возвращённый FortiGate после последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат операции Возвращается: всегда Пример: `"success"`
vdom строка	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_report_dataset_module.html