Модуль fortinet.fortios.fortios_log_custom_field – Настройка пользовательских полей журналов в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

Для использования в книге команд задайте: fortinet.fortios.fortios_log_custom_field.

Новая функция в fortinet.fortios 2.0.0

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

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создаётся в графическом интерфейсе Fortigate.
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
log_custom_field словарь	Настройка пользовательских полей журнала.
id строка / обязательно	Строка идентификатора поля.
name строка	Имя поля (макс. 15 символов).
value строка	Значение поля (макс. 15 символов).
member_path строка	Путь к атрибуту члена для обработки. Разделяется слешем, если атрибутов несколько. Параметр с member_path допустим для выполнения операций с членом.
member_state строка	Добавить или удалить члена по указанному пути к атрибуту. При указании member_state параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательно	Указывает, необходимо создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальная область, среди ранее определённых. ВД является виртуальным экземпляром FortiGate, который может быть настроен и использован как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure custom log fields.
  fortinet.fortios.fortios_log_custom_field:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      log_custom_field:
          id: "3"
          name: "default_name_4"
          value: "<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_log_custom_field_module.html