Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_alarm — настройка сигнализации в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

Обзор

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

system_alarm

dictionary

Настройка сигнализации.

audible

string

Включить или отключить звуковую сигнализацию.

Варианты:

  • "enable"
  • "disable"

groups

list / elements=dictionary

Группы сигнализации.

admin_auth_failure_threshold

integer

Порог неудачных попыток аутентификации администратора.

admin_auth_lockout_threshold

integer

Порог блокировки при аутентификации администратора.

decryption_failure_threshold

integer

Порог ошибок расшифрования.

encryption_failure_threshold

integer

Порог ошибок шифрования.

fw_policy_id

integer

Идентификатор политики брандмауэра.

fw_policy_id_threshold

integer

Порог идентификатора политики брандмауэра.

fw_policy_violations

list / elements=dictionary

Нарушения политик брандмауэра.

dst_ip

string

IP-адрес назначения (0 = все).

dst_port

integer

Порт назначения (0 = все).

id

integer / обязательный

Идентификатор нарушения политики брандмауэра. см. <a href=’#notes’>Примечания</a>.

src_ip

string

IP-адрес источника (0 = все).

src_port

integer

Порт источника (0 = все).

threshold

integer

Порог нарушений политики брандмауэра.

id

integer / обязательный

Идентификатор группы. см. <a href=’#notes’>Примечания</a>.

log_full_warning_threshold

integer

Порог предупреждения о заполнении журнала.

period

integer

Период времени в секундах (0 = с момента запуска).

replay_attempt_threshold

integer

Порог попыток повтора.

self_test_failure_threshold

integer

Порог ошибок самопроверки.

user_auth_failure_threshold

integer

Порог неудачных попыток аутентификации пользователя.

user_auth_lockout_threshold

integer

Порог блокировки при аутентификации пользователя.

status

string

Включить или отключить сигнализацию.

Варианты:

  • "enable"
  • "disable"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

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

Примеры

- name: Configure alarm.
  fortinet.fortios.fortios_system_alarm:
      vdom: "{{ vdom }}"
      system_alarm:
          audible: "enable"
          groups:
              -
                  admin_auth_failure_threshold: "0"
                  admin_auth_lockout_threshold: "0"
                  decryption_failure_threshold: "0"
                  encryption_failure_threshold: "0"
                  fw_policy_id: "0"
                  fw_policy_id_threshold: "0"
                  fw_policy_violations:
                      -
                          dst_ip: "<your_own_value>"
                          dst_port: "0"
                          id: "14"
                          src_ip: "<your_own_value>"
                          src_port: "0"
                          threshold: "0"
                  id: "18"
                  log_full_warning_threshold: "0"
                  period: "0"
                  replay_attempt_threshold: "0"
                  self_test_failure_threshold: "0"
                  user_auth_failure_threshold: "0"
                  user_auth_lockout_threshold: "0"
          status: "enable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи данных в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Результат последней операции, возвращённый FortiGate

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный в последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия 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_system_alarm_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API