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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortios.fortios_log_custom_field.

Новое в версии 2.8: of fortinet.fortios

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

Обзор

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

Требования

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

ansible>=2.9.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_token строка			Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate.
log_custom_field словарь			Настройка пользовательских полей журнала.
	id строка / обязательно		Идентификатор поля <строка>.
	name строка		Имя поля (максимум 15 символов).
	state строка	Варианты: present absent	Устарело Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' верхнего уровня. Указывает, нужно ли создать или удалить объект.
	value строка		Значение поля (максимум 15 символов).
state строка добавлено в 2.9 of fortinet.fortios		Варианты: present absent	Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перенесен на этот внешний уровень.
vdom строка		По умолчанию: "root"	Виртуальный домен, среди тех, которые были определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

Устаревший fortiosapi был устаревшим, httpapi — предпочтительный способ запуска книг задач

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure custom log fields.
    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 строка	всегда	Указание результата операции Пример: успех
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_log_custom_field_module.html