Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_firewall_mms_profile — настройка профилей MMS в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

Обзор

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

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

enable_log

boolean

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

Варианты:

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

firewall_mms_profile

dictionary

Настройка профилей MMS.

avnotificationtable

integer

Идентификатор таблицы уведомлений антивируса. Источник: antivirus.notification.id.

bwordtable

integer

Идентификатор таблицы запрещенных слов MMS. Источник: webfilter.content.id.

carrier_endpoint_prefix

string

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

Варианты:

  • "enable"
  • "disable"

carrier_endpoint_prefix_range_max

integer

Максимальная длина значения конечной точки, к которому можно добавить префикс (1–48).

carrier_endpoint_prefix_range_min

integer

Минимальная длина конечной точки, к которой добавляется префикс (1–48).

carrier_endpoint_prefix_string

string

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

carrierendpointbwltable

integer

Идентификатор таблицы фильтров конечных точек оператора связи. Источник: firewall.carrier-endpoint-bwl.id.

comment

string

Комментарий.

dupe

list / elements=dictionary

Конфигурация дублирования.

action1

list / elements=string

Действие при достижении порогового значения.

Варианты:

  • "block"
  • "archive"
  • "log"
  • "archive-first"
  • "alert-notif"

action2

list / elements=string

Действие при достижении порогового значения.

Варианты:

  • "block"
  • "archive"
  • "log"
  • "archive-first"
  • "alert-notif"

action3

list / elements=string

Действие при достижении порогового значения.

Варианты:

  • "block"
  • "archive"
  • "log"
  • "archive-first"
  • "alert-notif"

block_time1

integer

Длительность действия (0–35791 мин).

block_time2

integer

Длительность действия (0–35791 мин).

block_time3

integer

Длительность действия (0–35791 мин).

limit1

integer

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

limit2

integer

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

limit3

integer

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

protocol

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

Протокол.

status1

string

Включить/отключить обнаружение status1.

Варианты:

  • "enable"
  • "disable"

status2

string

Включить/отключить обнаружение status2.

Варианты:

  • "enable"
  • "disable"

status3

string

Включить/отключить обнаружение status3.

Варианты:

  • "enable"
  • "disable"

window1

integer

Интервал для подсчета сообщений (1–2880 мин).

window2

integer

Интервал для подсчета сообщений (1–2880 мин).

window3

integer

Интервал для подсчета сообщений (1–2880 мин).

extended_utm_log

string

Включить/отключить подробные сообщения журнала UTM.

flood

list / elements=dictionary

Конфигурация защиты от перегрузки.

action1

list / elements=string

Действие при достижении порогового значения.

Варианты:

  • "block"
  • "archive"
  • "log"
  • "archive-first"
  • "alert-notif"

action2

list / elements=string

Действие при достижении порогового значения.

Варианты:

  • "block"
  • "archive"
  • "log"
  • "archive-first"
  • "alert-notif"

action3

list / elements=string

Действие при достижении порогового значения.

Варианты:

  • "block"
  • "archive"
  • "log"
  • "archive-first"
  • "alert-notif"

block_time1

integer

Длительность действия (0–35791 мин).

block_time2

integer

Длительность действия (0–35791 мин).

block_time3

integer

Длительность действия (0–35791 мин).

limit1

integer

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

limit2

integer

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

limit3

integer

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

protocol

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

Протокол.

status1

string

Включить/отключить обнаружение status1.

Варианты:

  • "enable"
  • "disable"

status2

string

Включить/отключить обнаружение status2.

Варианты:

  • "enable"
  • "disable"

status3

string

Включить/отключить обнаружение status3.

Варианты:

  • "enable"
  • "disable"

window1

integer

Интервал для подсчета сообщений (1–2880 мин).

window2

integer

Интервал для подсчета сообщений (1–2880 мин).

window3

integer

Интервал для подсчета сообщений (1–2880 мин).

mm1

list / elements=string

Параметры MM1.

Варианты:

  • "avmonitor"
  • "oversize"
  • "quarantine"
  • "scan"
  • "bannedword"
  • "chunkedbypass"
  • "clientcomfort"
  • "servercomfort"
  • "carrier-endpoint-bwl"
  • "remove-blocked"
  • "mms-checksum"

mm1_addr_hdr

string

Поле заголовка HTTP (для MM1), содержащее адрес пользователя.

mm1_addr_source

string

Источник адреса пользователя MM1.

Варианты:

  • "http-header"
  • "cookie"

mm1_convert_hex

string

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

Варианты:

  • "enable"
  • "disable"

mm1_outbreak_prevention

string

Включить службу предотвращения вирусных вспышек.

Варианты:

  • "disabled"
  • "files"
  • "full-archive"

mm1_retr_dupe

string

Включить/отключить проверку дубликатов в сообщениях MM1 retr.

Варианты:

  • "enable"
  • "disable"

mm1_retrieve_scan

string

Включить/отключить проверку сообщений конфигурации MM1 retrieve.

Варианты:

  • "enable"
  • "disable"

mm1comfortamount

integer

Размер комфортного интервала MM1 (0–4294967295).

mm1comfortinterval

integer

Интервал комфорта MM1 (0–4294967295).

mm1oversizelimit

integer

Максимальный размер файла для проверки (1–819200 КБ).

mm3

list / elements=string

Параметры MM3.

Варианты:

  • "avmonitor"
  • "oversize"
  • "quarantine"
  • "scan"
  • "bannedword"
  • "fragmail"
  • "splice"
  • "carrier-endpoint-bwl"
  • "remove-blocked"
  • "mms-checksum"

mm3_outbreak_prevention

string

Включить службу предотвращения распространения вирусов.

Варианты:

  • "disabled"
  • "files"
  • "full-archive"

mm3oversizelimit

integer

Максимальный размер файла для проверки (1–819200 кБ).

mm4

list / elements=string

Параметры MM4.

Варианты:

  • "avmonitor"
  • "oversize"
  • "quarantine"
  • "scan"
  • "bannedword"
  • "fragmail"
  • "splice"
  • "carrier-endpoint-bwl"
  • "remove-blocked"
  • "mms-checksum"

mm4_outbreak_prevention

string

Включить службу предотвращения распространения вирусов.

Варианты:

  • "disabled"
  • "files"
  • "full-archive"

mm4oversizelimit

integer

Максимальный размер файла для проверки (1–819200 кБ).

mm7

list / elements=string

Параметры MM7.

Варианты:

  • "avmonitor"
  • "oversize"
  • "quarantine"
  • "scan"
  • "bannedword"
  • "chunkedbypass"
  • "clientcomfort"
  • "servercomfort"
  • "carrier-endpoint-bwl"
  • "remove-blocked"
  • "mms-checksum"

mm7_addr_hdr

string

Поле заголовка HTTP (для MM7), содержащее адрес пользователя.

mm7_addr_source

string

Источник адреса пользователя MM7.

Варианты:

  • "http-header"
  • "cookie"

mm7_convert_hex

string

Включить или отключить преобразование адреса пользователя из шестнадцатеричной строки для MM7.

Варианты:

  • "enable"
  • "disable"

mm7_outbreak_prevention

string

Включить службу предотвращения распространения вирусов.

Варианты:

  • "disabled"
  • "files"
  • "full-archive"

mm7comfortamount

integer

Количество сообщений MM7 для комфортного режима (0–4294967295).

mm7comfortinterval

integer

Интервал комфортного режима MM7 (0–4294967295).

mm7oversizelimit

integer

Максимальный размер файла для проверки (1–819200 кБ).

mms_antispam_mass_log

string

Включить или отключить ведение журналов массового спама MMS.

Варианты:

  • "enable"
  • "disable"

mms_av_block_log

string

Включить или отключить ведение журналов блокировки файлов антивирусом MMS.

Варианты:

  • "enable"
  • "disable"

mms_av_oversize_log

string

Включить или отключить ведение журналов блокировки антивирусом MMS файлов, превышающих допустимый размер.

Варианты:

  • "enable"
  • "disable"

mms_av_virus_log

string

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

Варианты:

  • "enable"
  • "disable"

mms_carrier_endpoint_filter_log

string

Включить или отключить ведение журналов блокировки фильтром конечных точек MMS.

Варианты:

  • "enable"
  • "disable"

mms_checksum_log

string

Включить или отключить ведение журналов контрольных сумм содержимого MMS.

Варианты:

  • "enable"
  • "disable"

mms_checksum_table

integer

Идентификатор таблицы контрольных сумм содержимого MMS. Источник: antivirus.mms-checksum.id.

mms_notification_log

string

Включить или отключить ведение журналов уведомлений MMS.

Варианты:

  • "enable"
  • "disable"

mms_web_content_log

string

Включить или отключить ведение журналов блокировки веб-содержимого MMS.

Варианты:

  • "enable"
  • "disable"

mmsbwordthreshold

integer

Пороговое значение для запрещённых слов MMS.

name

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

Имя профиля.

notif_msisdn

list / elements=dictionary

Уведомления для MSISDN.

msisdn

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

MSISDN получателя.

threshold

list / elements=string

Пороговые значения, при достижении которых этот MSISDN получит оповещение.

Варианты:

  • "flood-thresh-1"
  • "flood-thresh-2"
  • "flood-thresh-3"
  • "dupe-thresh-1"
  • "dupe-thresh-2"
  • "dupe-thresh-3"

notification

list / elements=dictionary

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

alert_int

integer

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

alert_int_mode

string

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

Варианты:

  • "hours"
  • "minutes"

alert_src_msisdn

string

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

alert_status

string

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

Варианты:

  • "enable"
  • "disable"

bword_int

integer

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

bword_int_mode

string

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

Варианты:

  • "hours"
  • "minutes"

bword_status

string

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

Варианты:

  • "enable"
  • "disable"

carrier_endpoint_bwl_int

integer

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

carrier_endpoint_bwl_int_mode

string

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

Варианты:

  • "hours"
  • "minutes"

carrier_endpoint_bwl_status

string

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

Варианты:

  • "enable"
  • "disable"

days_allowed

list / elements=string

Дни недели, в которые разрешена отправка уведомлений.

Варианты:

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

detect_server

string

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

Варианты:

  • "enable"
  • "disable"

dupe_int

integer

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

dupe_int_mode

string

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

Варианты:

  • "hours"
  • "minutes"

dupe_status

string

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

Варианты:

  • "enable"
  • "disable"

file_block_int

integer

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

file_block_int_mode

string

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

Варианты:

  • "hours"
  • "minutes"

file_block_status

string

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

Варианты:

  • "enable"
  • "disable"

flood_int

integer

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

flood_int_mode

string

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

Варианты:

  • "hours"
  • "minutes"

flood_status

string

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

Варианты:

  • "enable"
  • "disable"

from_in_header

string

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

Варианты:

  • "enable"
  • "disable"

mms_checksum_int

integer

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

mms_checksum_int_mode

string

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

Варианты:

  • "hours"
  • "minutes"

mms_checksum_status

string

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

Варианты:

  • "enable"
  • "disable"

mmsc_hostname

string

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

mmsc_password

string

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

mmsc_port

integer

Порт MMSC для отправки MMS-сообщений (1–65535).

mmsc_url

string

URL-адрес MMSC для отправки MMS-сообщений.

mmsc_username

string

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

msg_protocol

string

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

Варианты:

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

msg_type

string

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

Варианты:

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

protocol

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

Протокол.

rate_limit

integer

Ограничение частоты отправки уведомлений (0–250).

tod_window_duration

string

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

tod_window_end

string

Устарело.

tod_window_start

string

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

user_domain

string

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

vas_id

string

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

vasp_id

string

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

virus_int

integer

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

virus_int_mode

string

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

Варианты:

  • "hours"
  • "minutes"

virus_status

string

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

Варианты:

  • "enable"
  • "disable"

outbreak_prevention

dictionary

Настройка параметров предотвращения вспышек вирусов.

external_blocklist

string

Включить или отключить внешний список блокировки вредоносных программ.

Варианты:

  • "disable"
  • "enable"

ftgd_service

string

Включить или отключить службу FortiGuard для предотвращения вспышек вирусов.

Варианты:

  • "disable"
  • "enable"

remove_blocked_const_length

string

Включить или отключить замену MMS-файла заблокированного файла постоянной длины.

Варианты:

  • "enable"
  • "disable"

replacemsg_group

string

Группа сообщений-заменителей. Источник: system.replacemsg-group.name.

member_path

string

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

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

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

member_state

string

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

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

Варианты:

  • "present"
  • "absent"

state

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

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

Варианты:

  • "present"
  • "absent"

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Configure MMS profiles.
  fortinet.fortios.fortios_firewall_mms_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_mms_profile:
          avnotificationtable: "2147483647"
          bwordtable: "2147483647"
          carrier_endpoint_prefix: "enable"
          carrier_endpoint_prefix_range_max: "24"
          carrier_endpoint_prefix_range_min: "24"
          carrier_endpoint_prefix_string: "<your_own_value>"
          carrierendpointbwltable: "2147483647"
          comment: "Comment."
          dupe:
              -
                  action1: "block"
                  action2: "block"
                  action3: "block"
                  block_time1: "17895"
                  block_time2: "17895"
                  block_time3: "17895"
                  limit1: "1073741823"
                  limit2: "1073741823"
                  limit3: "1073741823"
                  protocol: "<your_own_value>"
                  status1: "enable"
                  status2: "enable"
                  status3: "enable"
                  window1: "1440"
                  window2: "1440"
                  window3: "1440"
          extended_utm_log: "<your_own_value>"
          flood:
              -
                  action1: "block"
                  action2: "block"
                  action3: "block"
                  block_time1: "17895"
                  block_time2: "17895"
                  block_time3: "17895"
                  limit1: "1073741823"
                  limit2: "1073741823"
                  limit3: "1073741823"
                  protocol: "<your_own_value>"
                  status1: "enable"
                  status2: "enable"
                  status3: "enable"
                  window1: "1440"
                  window2: "1440"
                  window3: "1440"
          mm1: "avmonitor"
          mm1_addr_hdr: "<your_own_value>"
          mm1_addr_source: "http-header"
          mm1_convert_hex: "enable"
          mm1_outbreak_prevention: "disabled"
          mm1_retr_dupe: "enable"
          mm1_retrieve_scan: "enable"
          mm1comfortamount: "2147483647"
          mm1comfortinterval: "2147483647"
          mm1oversizelimit: "409600"
          mm3: "avmonitor"
          mm3_outbreak_prevention: "disabled"
          mm3oversizelimit: "409600"
          mm4: "avmonitor"
          mm4_outbreak_prevention: "disabled"
          mm4oversizelimit: "409600"
          mm7: "avmonitor"
          mm7_addr_hdr: "<your_own_value>"
          mm7_addr_source: "http-header"
          mm7_convert_hex: "enable"
          mm7_outbreak_prevention: "disabled"
          mm7comfortamount: "2147483647"
          mm7comfortinterval: "2147483647"
          mm7oversizelimit: "409600"
          mms_antispam_mass_log: "enable"
          mms_av_block_log: "enable"
          mms_av_oversize_log: "enable"
          mms_av_virus_log: "enable"
          mms_carrier_endpoint_filter_log: "enable"
          mms_checksum_log: "enable"
          mms_checksum_table: "2147483647"
          mms_notification_log: "enable"
          mms_web_content_log: "enable"
          mmsbwordthreshold: "1073741823"
          name: "default_name_80"
          notif_msisdn:
              -
                  msisdn: "<your_own_value>"
                  threshold: "flood-thresh-1"
          notification:
              -
                  alert_int: "720"
                  alert_int_mode: "hours"
                  alert_src_msisdn: "<your_own_value>"
                  alert_status: "enable"
                  bword_int: "720"
                  bword_int_mode: "hours"
                  bword_status: "enable"
                  carrier_endpoint_bwl_int: "720"
                  carrier_endpoint_bwl_int_mode: "hours"
                  carrier_endpoint_bwl_status: "enable"
                  days_allowed: "sunday"
                  detect_server: "enable"
                  dupe_int: "720"
                  dupe_int_mode: "hours"
                  dupe_status: "enable"
                  file_block_int: "720"
                  file_block_int_mode: "hours"
                  file_block_status: "enable"
                  flood_int: "720"
                  flood_int_mode: "hours"
                  flood_status: "enable"
                  from_in_header: "enable"
                  mms_checksum_int: "720"
                  mms_checksum_int_mode: "hours"
                  mms_checksum_status: "enable"
                  mmsc_hostname: "myhostname"
                  mmsc_password: "<your_own_value>"
                  mmsc_port: "32767"
                  mmsc_url: "<your_own_value>"
                  mmsc_username: "<your_own_value>"
                  msg_protocol: "mm1"
                  msg_type: "submit-req"
                  protocol: "<your_own_value>"
                  rate_limit: "125"
                  tod_window_duration: "<your_own_value>"
                  tod_window_end: "<your_own_value>"
                  tod_window_start: "<your_own_value>"
                  user_domain: "<your_own_value>"
                  vas_id: "<your_own_value>"
                  vasp_id: "<your_own_value>"
                  virus_int: "720"
                  virus_int_mode: "hours"
                  virus_status: "enable"
          outbreak_prevention:
              external_blocklist: "disable"
              ftgd_service: "disable"
          remove_blocked_const_length: "enable"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"

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

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

Ключ

Описание

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_firewall_mms_profile_module.html

Spec-Zone.ru

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