Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_firewall_mmsprofile_notification — конфигурация уведомлений.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

Параметр (adom) в запрашиваемом URL.

bypass_validation

boolean

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

Варианты:

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

enable_log

boolean

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

Варианты:

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

firewall_mmsprofile_notification

dictionary

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

alert_int

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

integer

Интервал отправки уведомлений о предупреждениях.

alert_int_mode

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

string

Режим интервала уведомлений о предупреждениях.

Варианты:

  • "hours"
  • "minutes"

alert_src_msisdn

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

string

Укажите адрес отправителя для сообщений о предупреждениях.

alert_status

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

string

Статус уведомлений о предупреждениях.

Варианты:

  • "disable"
  • "enable"

bword_int

псевдонимы: bword-int

integer

Интервал отправки уведомлений о запрещенных словах.

bword_int_mode

псевдонимы: bword-int-mode

string

Режим интервала уведомлений о запрещенных словах.

Варианты:

  • "hours"
  • "minutes"

bword_status

псевдонимы: bword-status

string

Статус уведомлений о запрещенных словах.

Варианты:

  • "disable"
  • "enable"

carrier_endpoint_bwl_int

псевдонимы: carrier-endpoint-bwl-int

integer

Интервал отправки уведомлений о черном/белом списке конечных точек оператора связи.

carrier_endpoint_bwl_int_mode

псевдонимы: carrier-endpoint-bwl-int-mode

string

Режим интервала уведомлений о черном/белом списке конечных точек оператора связи.

Варианты:

  • "hours"
  • "minutes"

carrier_endpoint_bwl_status

псевдонимы: carrier-endpoint-bwl-status

string

Статус уведомлений о черном/белом списке конечных точек оператора связи.

Варианты:

  • "disable"
  • "enable"

days_allowed

псевдонимы: days-allowed

list / элементы=string

Дни недели, в которые можно отправлять уведомления.

Варианты:

  • "sunday"
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"

detect_server

псевдонимы: detect-server

string

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

Варианты:

  • "disable"
  • "enable"

dupe_int

псевдонимы: dupe-int

integer

Интервал отправки уведомлений о дубликатах.

dupe_int_mode

псевдонимы: dupe-int-mode

string

Режим интервала уведомлений о дубликатах.

Варианты:

  • "hours"
  • "minutes"

dupe_status

псевдонимы: dupe-status

string

Статус уведомлений о дубликатах.

Варианты:

  • "disable"
  • "enable"

file_block_int

псевдонимы: file-block-int

integer

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

file_block_int_mode

псевдонимы: file-block-int-mode

string

Режим интервала уведомлений о блокировке файлов.

Варианты:

  • "hours"
  • "minutes"

file_block_status

псевдонимы: file-block-status

string

Статус уведомлений о блокировке файлов.

Варианты:

  • "disable"
  • "enable"

flood_int

псевдонимы: flood-int

integer

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

flood_int_mode

псевдонимы: flood-int-mode

string

Режим интервала уведомлений о массовой рассылке.

Варианты:

  • "hours"
  • "minutes"

flood_status

псевдонимы: flood-status

string

Статус уведомлений о массовой рассылке.

Варианты:

  • "disable"
  • "enable"

from_in_header

псевдонимы: from-in-header

string

Включить/отключить добавление адреса отправителя в HTTP-заголовок.

Варианты:

  • "disable"
  • "enable"

mms_checksum_int

псевдонимы: mms-checksum-int

integer

Интервал отправки уведомлений о контрольной сумме MMS.

mms_checksum_int_mode

псевдонимы: mms-checksum-int-mode

string

Режим интервала уведомлений о контрольной сумме MMS.

Варианты:

  • "hours"
  • "minutes"

mms_checksum_status

псевдонимы: mms-checksum-status

string

Статус уведомлений о контрольной сумме MMS.

Варианты:

  • "disable"
  • "enable"

mmsc_hostname

псевдонимы: mmsc-hostname

string

Имя хоста или IP-адрес MMSC.

mmsc_password

псевдонимы: mmsc-password

any

(список) Пароль, необходимый для аутентификации на MMSC.

mmsc_port

псевдонимы: mmsc-port

integer

Порт MMSC, используемый для отправки MMS-сообщений

mmsc_url

псевдонимы: mmsc-url

string

URL-адрес MMSC, используемый для отправки MMS-сообщений.

mmsc_username

псевдонимы: mmsc-username

string

Имя пользователя, необходимое для аутентификации на MMSC.

msg_protocol

псевдонимы: msg-protocol

string

Протокол для отправки уведомлений.

Варианты:

  • "mm1"
  • "mm3"
  • "mm4"
  • "mm7"

msg_type

псевдонимы: msg-type

string

Тип сообщения MM7.

Варианты:

  • "submit-req"
  • "deliver-req"

protocol

string

Протокол.

rate_limit

псевдонимы: rate-limit

integer

Ограничение скорости отправки уведомлений

tod_window_duration

псевдонимы: tod-window-duration

string

Продолжительность временного окна в течение дня.

tod_window_end

псевдонимы: tod-window-end

string

Устарело.

tod_window_start

псевдонимы: tod-window-start

string

Начало временного окна в течение дня.

user_domain

псевдонимы: user-domain

string

Доменное имя, к которому относятся адреса пользователей.

vas_id

псевдонимы: vas-id

string

Идентификатор VAS.

vasp_id

псевдонимы: vasp-id

string

Идентификатор VASP.

virus_int

псевдонимы: virus-int

integer

Интервал отправки уведомлений о вирусах.

virus_int_mode

псевдонимы: virus-int-mode

string

Режим интервала уведомлений о вирусах.

Варианты:

  • "hours"
  • "minutes"

virus_status

псевдонимы: virus-status

string

Статус уведомления о вирусах.

Варианты:

  • "disable"
  • "enable"

forticloud_access_token

string

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

mms-profile

string

Устарел, используйте «mms_profile»

mms_profile

string

Параметр (mms-profile) в запрашиваемом URL.

proposed_method

string

Метод, переопределяющий метод базового запроса Json RPC.

Варианты:

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

rc_failed

list / элементы=integer

Список кодов rc, для которых переопределяются условия сбоя.

rc_succeeded

list / элементы=integer

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

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая 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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Notification configuration.
      fortinet.fortimanager.fmgr_firewall_mmsprofile_notification:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        mms_profile: <your own value>
        firewall_mmsprofile_notification:
          # alert_int: <integer>
          # alert_int_mode: <value in [hours, minutes]>
          # alert_src_msisdn: <string>
          # alert_status: <value in [disable, enable]>
          # bword_int: <integer>
          # bword_int_mode: <value in [hours, minutes]>
          # bword_status: <value in [disable, enable]>
          # carrier_endpoint_bwl_int: <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: <integer>
          # dupe_int_mode: <value in [hours, minutes]>
          # dupe_status: <value in [disable, enable]>
          # file_block_int: <integer>
          # file_block_int_mode: <value in [hours, minutes]>
          # file_block_status: <value in [disable, enable]>
          # flood_int: <integer>
          # flood_int_mode: <value in [hours, minutes]>
          # flood_status: <value in [disable, enable]>
          # from_in_header: <value in [disable, enable]>
          # mms_checksum_int: <integer>
          # mms_checksum_int_mode: <value in [hours, minutes]>
          # mms_checksum_status: <value in [disable, enable]>
          # mmsc_hostname: <string>
          # mmsc_password: <list or string>
          # mmsc_port: <integer>
          # mmsc_url: <string>
          # mmsc_username: <string>
          # msg_protocol: <value in [mm1, mm3, mm4, ...]>
          # msg_type: <value in [submit-req, deliver-req]>
          # protocol: <string>
          # rate_limit: <integer>
          # tod_window_duration: <string>
          # tod_window_end: <string>
          # tod_window_start: <string>
          # user_domain: <string>
          # vas_id: <string>
          # vasp_id: <string>
          # virus_int: <integer>
          # virus_int_mode: <value in [hours, minutes]>
          # virus_status: <value in [disable, enable]>

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

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

Ключ

Описание

meta

dictionary

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

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

request_url

string

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

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

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

response_code

integer

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

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

Пример: 0

response_data

list / элементы=string

Ответ API.

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

response_message

string

Текстовое описание ответа API.

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

Пример: "OK."

system_information

dictionary

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

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

rc

integer

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

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

Пример: 0

version_check_warning

list / элементы=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_firewall_mmsprofile_notification_module.html

Spec-Zone.ru

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