fortinet.fortimanager.fmgr_firewall_mmsprofile_notification – Настройка уведомлений.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое значение		Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_mmsprofile_notification словарь			установленные параметры верхнего уровня
	alert-int целое число		Интервал отправки уведомлений об оповещениях.
	alert-int-mode строка	Варианты: часы минуты	Режим интервала уведомлений об оповещениях.
	alert-src-msisdn строка		Укажите адрес отправителя для сообщений об оповещениях.
	alert-status строка	Варианты: выключено включено	Статус уведомлений об оповещениях.
	bword-int целое число		Интервал отправки уведомлений о заблокированных словах.
	bword-int-mode строка	Варианты: часы минуты	Режим интервала уведомлений о заблокированных словах.
	bword-status строка	Варианты: выключено включено	Статус уведомлений о заблокированных словах.
	carrier-endpoint-bwl-int целое число		Интервал отправки уведомлений о списках чёрного/белого цвета конечных точек оператора.
	carrier-endpoint-bwl-int-mode строка	Варианты: часы минуты	Режим интервала уведомлений о списках чёрного/белого цвета конечных точек оператора.
	carrier-endpoint-bwl-status строка	Варианты: выключено включено	Статус уведомлений о списках чёрного/белого цвета конечных точек оператора.
	days-allowed список / элементы=строка	Варианты: воскресенье понедельник вторник среда четверг пятница суббота	нет описания
	detect-server строка	Варианты: выключено включено	Включить/выключить автоматическое определение адреса сервера.
	dupe-int целое число		Интервал отправки уведомлений о дубликатах.
	dupe-int-mode строка	Варианты: часы минуты	Режим интервала уведомлений о дубликатах.
	dupe-status строка	Варианты: выключено включено	Статус уведомлений о дубликатах.
	file-block-int целое число		Интервал отправки уведомлений о блокировке файлов.
	file-block-int-mode строка	Варианты: часы минуты	Режим интервала уведомлений о блокировке файлов.
	file-block-status строка	Варианты: выключено включено	Статус уведомлений о блокировке файлов.
	flood-int целое число		Интервал отправки уведомлений о наводнении.
	flood-int-mode строка	Варианты: часы минуты	Режим интервала уведомлений о наводнении.
	flood-status строка	Варианты: выключено включено	Статус уведомлений о наводнении.
	from-in-header строка	Варианты: выключено включено	Включить/выключить вставку адреса отправителя в заголовок HTTP.
	mms-checksum-int целое число		Интервал отправки уведомлений о контрольной сумме MMS.
	mms-checksum-int-mode строка	Варианты: часы минуты	Режим интервала уведомлений о контрольной сумме MMS.
	mms-checksum-status строка	Варианты: выключено включено	Статус уведомлений о контрольной сумме MMS.
	mmsc-hostname строка		Имя хоста или IP-адрес MMSC.
	mmsc-password строка		нет описания
	mmsc-port целое число		Порт, используемый на MMSC для отправки сообщений MMS (1 - 65535).
	mmsc-url строка		URL, используемый на MMSC для отправки сообщений MMS.
	mmsc-username строка		Имя пользователя, необходимое для аутентификации с MMSC.
	msg-protocol строка	Варианты: mm1 mm3 mm4 mm7	Протокол для использования при отправке сообщений об уведомлениях.
	msg-type строка	Варианты: submit-req deliver-req	Тип сообщения MM7.
	protocol строка		Протокол.
	rate-limit целое число		Лимит скорости для отправки сообщений об уведомлениях (0 - 250).
	tod-window-duration строка		Продолжительность временного интервала.
	tod-window-end строка		Устарело.
	tod-window-start строка		Начало временного интервала.
	user-domain строка		Имя домена, к которому относятся адреса пользователей.
	vas-id строка		Идентификатор VAS.
	vasp-id строка		Идентификатор VASП.
	virus-int целое число		Интервал отправки уведомлений о вирусах.
	virus-int-mode строка	Варианты: часы минуты	Режим интервала уведомлений о вирусах.
	virus-status строка	Варианты: выключено включено	Статус уведомлений о вирусах.
mms-profile строка / обязательно			параметр (mms-profile) в запрошенном URL
rc_failed список / элементы=строка			список кодов rc, с которыми будут переопределены условия отказа
rc_succeeded список / элементы=строка			список кодов rc, с которыми будут переопределены условия успеха
state строка / обязательно		Варианты: present absent	направление для создания, обновления или удаления объекта
workspace_locking_adom строка			adom для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корень
workspace_locking_timeout целое число		Значение по умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

В этом модуле FortiManager поддерживается режим блокировки рабочего пространства, верхнеуровневые параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия для завершения успехом или ошибкой с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Notification configuration.
     fmgr_firewall_mmsprofile_notification:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        mms-profile: <your own value>
        firewall_mmsprofile_notification:
           alert-int: <value of integer>
           alert-int-mode: <value in [hours, minutes]>
           alert-src-msisdn: <value of string>
           alert-status: <value in [disable, enable]>
           bword-int: <value of integer>
           bword-int-mode: <value in [hours, minutes]>
           bword-status: <value in [disable, enable]>
           carrier-endpoint-bwl-int: <value of integer>
           carrier-endpoint-bwl-int-mode: <value in [hours, minutes]>
           carrier-endpoint-bwl-status: <value in [disable, enable]>
           days-allowed:
             - sunday
             - monday
             - tuesday
             - wednesday
             - thursday
             - friday
             - saturday
           detect-server: <value in [disable, enable]>
           dupe-int: <value of integer>
           dupe-int-mode: <value in [hours, minutes]>
           dupe-status: <value in [disable, enable]>
           file-block-int: <value of integer>
           file-block-int-mode: <value in [hours, minutes]>
           file-block-status: <value in [disable, enable]>
           flood-int: <value of integer>
           flood-int-mode: <value in [hours, minutes]>
           flood-status: <value in [disable, enable]>
           from-in-header: <value in [disable, enable]>
           mms-checksum-int: <value of integer>
           mms-checksum-int-mode: <value in [hours, minutes]>
           mms-checksum-status: <value in [disable, enable]>
           mmsc-hostname: <value of string>
           mmsc-password: <value of string>
           mmsc-port: <value of integer>
           mmsc-url: <value of string>
           mmsc-username: <value of string>
           msg-protocol: <value in [mm1, mm3, mm4, ...]>
           msg-type: <value in [submit-req, deliver-req]>
           protocol: <value of string>
           rate-limit: <value of integer>
           tod-window-duration: <value of string>
           tod-window-end: <value of string>
           tod-window-start: <value of string>
           user-domain: <value of string>
           vas-id: <value of string>
           vasp-id: <value of string>
           virus-int: <value of integer>
           virus-int-mode: <value in [hours, minutes]>
           virus-status: <value in [disable, enable]>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_mmsprofile_notification_module.html