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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation булево	Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Проверка подлинности клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, которые будут использоваться для определения условий неудачи.
rc_succeeded список / элементы=целое число	Список кодов rc, которые будут использоваться для определения условий успеха.
state строка / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_alertevent словарь	Установленные параметры верхнего уровня.
alert_destination список / элементы=словарь	Устарело, пожалуйста, переименуйте на alert_destination. Назначение оповещений.
from строка	Адрес отправителя электронной почты для использования в электронных письмах с оповещениями.
smtp_name строка	Устарело, пожалуйста, переименуйте на smtp_name. Имя SMTP-сервера.
snmp_name строка	Устарело, пожалуйста, переименуйте на snmp_name. Имя SNMP-ловушки.
syslog_name строка	Устарело, пожалуйста, переименуйте на syslog_name. Имя сервера syslog.
to строка	Адрес получателя электронной почты для использования в электронных письмах с оповещениями.
type строка	Тип назначения. mail - Отправка оповещения по электронной почте. snmp - Отправка SNMP-ловушки. syslog - Отправка сообщения syslog. Варианты: `"mail"` `"snmp"` `"syslog"`
enable_generic_text список / элементы=строка	Устарело, пожалуйста, переименуйте на enable_generic_text. Включить/отключить соответствие по общему тексту. enable - Включить настройку. disable - Отключить настройку. Варианты: `"enable"` `"disable"`
enable_severity_filter список / элементы=строка	Устарело, пожалуйста, переименуйте на enable_severity_filter. Включить/отключить фильтр уровня события. enable - Включить настройку. disable - Отключить настройку. Варианты: `"enable"` `"disable"`
event_time_period строка	Устарело, пожалуйста, переименуйте на event_time_period. Период времени 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 string	Устаревшее, пожалуйста, переименуйте его на generic_text. Текст, который должен содержаться в журнале, чтобы сработать оповещение.
name string / обязательно	Имя оповещения.
num-events string	Устаревшее, пожалуйста, переименуйте его на num_events. Минимальное количество событий, необходимых в течение периода времени. 1 - 1 событие. 5 - 5 событий. 10 - 10 событий. 50 - 50 событий. 100 - 100 событий. Варианты: `"1"` `"5"` `"10"` `"50"` `"100"`
severity-filter string	Устаревшее, пожалуйста, переименуйте его на severity_filter. Требуемая степень серьезности журнала для срабатывания оповещения. high - Оповещение высокого уровня. medium-high - Оповещение среднего уровня с высоким приоритетом. medium - Оповещение среднего уровня. medium-low - Оповещение среднего уровня с низким приоритетом. low - Оповещение низкого уровня. Варианты: `"high"` `"medium-high"` `"medium"` `"medium-low"` `"low"`
severity-level-comp list / элементы=строка	Устаревшее, пожалуйста, переименуйте его на severity_level_comp. Критерий сравнения порогового значения серьезности журнала. Варианты: `">="` `"="` `"<="`
severity-level-logs list / элементы=строка	Устаревшее, пожалуйста, переименуйте его на severity_level_logs. Уровень порога серьезности журнала. no-check - Не проверять уровень серьезности для данного типа журнала. information - Уровень информации. notify - Уровень оповещения. warning - Уровень предупреждения. error - Уровень ошибки. critical - Критический уровень. alert - Уровень тревоги. emergency - Уровень чрезвычайной ситуации. Варианты: `"no-check"` `"information"` `"notify"` `"warning"` `"error"` `"critical"` `"alert"` `"emergency"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание сообщения ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_alertevent_module.html