Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_system_alertevent — События оповещений.

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_alertevent.

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

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiManager.
  • В примерах приведены все параметры и значения, которые необходимо настроить для источников данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

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

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия неудачного выполнения.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

state

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

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

system_alertevent

dictionary

Набор параметров верхнего уровня.

alert_destination

псевдонимы: alert-destination

list / elements=dictionary

Назначение оповещения.

from

string

Адрес электронной почты отправителя для писем с оповещениями.

smtp_name

псевдонимы: smtp-name

string

Имя SMTP-сервера.

snmp_name

псевдонимы: snmp-name

string

Имя SNMP-ловушки.

syslog_name

псевдонимы: syslog-name

string

Имя сервера Syslog.

to

string

Адрес электронной почты получателя для писем с оповещениями.

type

string

Тип назначения.

mail — отправить оповещение по электронной почте.

snmp — отправить SNMP-ловушку.

syslog — отправить сообщение Syslog.

Варианты:

  • "mail"
  • "snmp"
  • "syslog"

enable_generic_text

псевдонимы: enable-generic-text

list / elements=string

Включить/отключить сопоставление с произвольным текстом.

enable — включить настройку.

disable — отключить настройку.

Варианты:

  • "enable"
  • "disable"

enable_severity_filter

псевдонимы: enable-severity-filter

list / elements=string

Включить/отключить фильтр уровня серьёзности оповещений.

enable — включить настройку.

disable — отключить настройку.

Варианты:

  • "enable"
  • "disable"

event_time_period

псевдонимы: event-time-period

string

Период времени

1 — 1 час.

3 — 3 часа.

6 — 6 часов.

12 — 12 часов.

24 — 1 день.

72 — 3 дня.

168 — 1 неделя.

Варианты:

  • "0.5"
  • "1"
  • "3"
  • "6"
  • "12"
  • "24"
  • "72"
  • "168"

generic_text

псевдонимы: generic-text

string

Текст, который должен содержаться в журнале, чтобы вызвать оповещение.

name

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

Имя оповещения.

num_events

псевдонимы: num-events

string

Минимальное количество событий за указанный период времени.

1 — 1 событие.

5 — 5 событий.

10 — 10 событий.

50 — 50 событий.

100 — 100 событий.

Варианты:

  • "1"
  • "5"
  • "10"
  • "50"
  • "100"

severity_filter

псевдонимы: severity-filter

string

Необходимый уровень серьёзности журнала для вызова оповещения.

high — оповещение высокого уровня.

medium-high — оповещение средне-высокого уровня.

medium — оповещение среднего уровня.

medium-low — оповещение средне-низкого уровня.

low — оповещение низкого уровня.

Варианты:

  • "high"
  • "medium-high"
  • "medium"
  • "medium-low"
  • "low"

severity_level_comp

псевдонимы: severity-level-comp

list / elements=string

Критерий сравнения порогового уровня серьёзности журнала.

Варианты:

  • ">="
  • "="
  • "<="

severity_level_logs

псевдонимы: severity-level-logs

list / elements=string

Пороговый уровень серьёзности журнала.

no-check — не проверять уровень серьёзности для этого типа журнала.

information — информационный уровень.

notify — уровень уведомления.

warning — уровень предупреждения.

error — уровень ошибки.

critical — критический уровень.

alert — уровень оповещения.

emergency — аварийный уровень.

Варианты:

  • "no-check"
  • "information"
  • "notify"
  • "warning"
  • "error"
  • "critical"
  • "alert"
  • "emergency"

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие значения, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, все входные аргументы именуются по соглашению с подчёркиванием (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнять эту задачу.
  • Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия успешного или неудачного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Чтобы создать или обновить объект, используйте директиву state present.
  • Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Alert events.
      fortinet.fortimanager.fmgr_system_alertevent:
        bypass_validation: false
        state: present
        system_alertevent:
          enable_generic_text:
            - enable
            - disable
          enable_severity_filter:
            - enable
            - disable
          event_time_period: 1 # <value in [0.5, 1, 3, ...]>
          name: ansible-test-sysalert
          num_events: 1 # <value in [1, 5, 10, ...]>
          severity_filter: high # <value in [high, medium-high, medium, ...]>
          # severity_level_comp:
          #  - <=
          severity_level_logs:
            - no-check
            - information
            - notify
            - warning
            - error
            - critical
            - alert
            - emergency

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the alert events
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_alertevent"
          params:
            alert_event: "your_value"

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

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

request_url

string

Полный URL запроса.

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

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

Описание ответа API.

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

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

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

rc

integer

Статус запроса.

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

Пример: 0

version_check_warning

list / elements=string

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

Возвращается: в сложных случаях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortimanager/fmgr_system_alertevent_module.html

Spec-Zone.ru

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