Модуль fortinet.fortios.fortios_log_syslogd2_setting — Глобальные настройки удаленного сервера syslog в 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_syslogd2_setting.
Добавлен в fortinet.fortios 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры и категории функций log_syslogd2. Примеры включают в себя все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось на FOS v6.0.0
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
log_syslogd2_setting словарь | Глобальные настройки удаленного сервера syslog. |
|
certificate строка |
Сертификат, используемый для связи с сервером Syslog. Источник сертификата.local.name. |
|
custom_field_name список / элементы=словарь |
Пользовательское имя поля для ведения журнала в формате CEF. |
|
custom строка |
Пользовательское имя поля [A-Za-z0-9_]. |
|
id целое число / обязательно |
Идентификатор записи. см. <a href=’#notes’>Примечания</a>. |
|
name строка |
Имя поля [A-Za-z0-9_]. |
|
enc_algorithm строка |
Включить/выключить надежное syslogging с шифрованием TLS. Варианты:
|
|
facility строка |
Удобство удаленного syslog. Варианты:
|
|
format строка |
Формат журнала. Варианты:
|
|
interface строка |
Укажите исходящий интерфейс для подключения к серверу. Источник системы.интерфейс.имя. |
|
interface_select_method строка |
Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты:
|
|
max_log_rate целое число |
Максимальная скорость журнала syslog в Мбит/с (0 = без ограничений). |
|
mode строка |
Удаленное ведение журнала syslog через UDP/Надежный TCP. Варианты:
|
|
port целое число |
Порт прослушивания сервера. |
|
priority строка |
Установите приоритет передачи журнала. Варианты:
|
|
server строка |
Адрес удаленного сервера syslog. |
|
source_ip строка |
Исходный IP-адрес syslog. |
|
ssl_min_proto_version строка |
Минимальная поддерживаемая версия протокола для соединений SSL/TLS. Варианты:
|
|
status string |
Включить/отключить удалённый журнал syslog. Варианты:
|
|
syslog_type integer |
Скрытый индекс настроек Syslog. |
member_path string | Путь к атрибуту члена для обработки. Разделяется символом слэша, если атрибутов несколько. Параметр, помеченный member_path, допустим для выполнения операций с членами. |
member_state string | Добавить или удалить члена по указанному пути к атрибуту. Когда указан member_state, параметр state игнорируется. Варианты:
|
vdom string | Виртуальная область (vdom) из ранее определённых. Vdom — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. Значение по умолчанию: |
Примечания
Примечание
- Модуль fortiosapi устарел, рекомендуется использовать httpapi для выполнения playbooks
Примеры
- name: Global settings for remote syslog server.
fortinet.fortios.fortios_log_syslogd2_setting:
vdom: "{{ vdom }}"
log_syslogd2_setting:
certificate: "<your_own_value> (source certificate.local.name)"
custom_field_name:
-
custom: "<your_own_value>"
id: "6"
name: "default_name_7"
enc_algorithm: "high-medium"
facility: "kernel"
format: "default"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
max_log_rate: "0"
mode: "udp"
port: "514"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "2147483647"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, полученный от FortiGate при последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), использованный при последнем запросе к FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер версии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Использованная виртуальная область Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на сборку
© 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_syslogd2_setting_module.html