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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.15

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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). См.
name строка	Имя.
type строка	Тип поля. Варианты: `"text"` `"integer"` `"double"`
name строка / обязательно	Имя.
parameters список / элементы=словарь	Параметры.
data_type строка	Тип данных. Варианты: `"text"` `"integer"` `"double"` `"long-integer"` `"date-time"`
display_name строка	Имя для отображения.
field строка	Имя поля SQL.
id целое число / обязательно	Идентификатор параметра (от 1 до количества столбцов в результате SQL). См.
policy целое число	Используется политикой мониторинга.
query строка	Запрос SQL.
state строка / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальная область (в тех, что определены ранее). VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельная единица. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks
Модуль поддерживает режим проверки (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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_report_dataset_module.html