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

Примечание

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

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

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

Для использования в playbook укажите: fortinet.fortios.fortios_firewall_mms_profile.

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

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

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ansible>=2.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в GUI Fortigate.
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `true`
firewall_mms_profile dictionary	Настройка профилей MMS.
avnotificationtable integer	ID таблицы уведомлений AntiVirus. Источник antivirus.notification.id.
bwordtable integer	ID таблицы запрещенных слов 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	ID таблицы фильтров конечных точек оператора. Источник 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 / required	Протокол.

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 / required	Протокол.
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. Варианты: `"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. Choices: `"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. Choices: `"http-header"` `"cookie"`
mm7_convert_hex string	Включить/отключить преобразование адреса пользователя из HEX-строки для MM7. Choices: `"enable"` `"disable"`
mm7_outbreak_prevention string	Включить службу предотвращения вирусных вспышек. Choices: `"disabled"` `"files"` `"full-archive"`
mm7comfortamount integer	Сумма комфорта MM7 (0 - 4294967295).
mm7comfortinterval integer	Интервал комфорта MM7 (0 - 4294967295).
mm7oversizelimit integer	Максимальный размер файла для сканирования (1 - 819200 кБ).
mms_antispam_mass_log string	Включить/отключить ведение журнала для массовой антиспам-защиты MMS. Choices: `"enable"` `"disable"`
mms_av_block_log string	Включить/отключить ведение журнала для блокировки файлов антивирусом MMS. Choices: `"enable"` `"disable"`
mms_av_oversize_log string	Включить/отключить ведение журнала для блокировки слишком больших файлов антивирусом MMS. Choices: `"enable"` `"disable"`
mms_av_virus_log string	Включить/отключить ведение журнала для антивирусного сканирования MMS. Choices: `"enable"` `"disable"`
mms_carrier_endpoint_filter_log string	Включить/отключить ведение журнала для блокировки фильтра конечных точек MMS. Choices: `"enable"` `"disable"`
mms_checksum_log string	Включить/отключить ведение журнала контрольной суммы содержимого MMS. Choices: `"enable"` `"disable"`
mms_checksum_table integer	Идентификатор таблицы контрольной суммы содержимого MMS. Источник antivirus.mms-checksum.id.
mms_notification_log string	Включить/отключить ведение журнала для уведомлений MMS. Choices: `"enable"` `"disable"`
mms_web_content_log string	Включить/отключить ведение журнала для блокировки веб-контента MMS. Choices: `"enable"` `"disable"`
mmsbwordthreshold integer	Порог запрещенных слов MMS.
name string / required	Имя профиля.

notif_msisdn list / elements=dictionary	Уведомление для MSISDN.
msisdn string / required	MSISDN получателя.
threshold list / elements=string	Пороги, при которых этот MSISDN будет получать оповещение. Choices: `"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	Режим интервала уведомлений о предупреждениях. Choices: `"hours"` `"minutes"`
alert_src_msisdn string	Укажите адрес отправителя для сообщений о предупреждениях.
alert_status string	Статус уведомлений о предупреждениях. Choices: `"enable"` `"disable"`
bword_int integer	Интервал отправки уведомлений о запрещенных словах.
bword_int_mode string	Режим интервала уведомлений о запрещенных словах. Choices: `"hours"` `"minutes"`
bword_status string	Статус уведомлений о запрещенных словах. Choices: `"enable"` `"disable"`
carrier_endpoint_bwl_int integer	Интервал отправки уведомлений о черном/белом списке конечных точек оператора.
carrier_endpoint_bwl_int_mode string	Режим интервала уведомлений о черном/белом списке конечных точек оператора. Choices: `"hours"` `"minutes"`
carrier_endpoint_bwl_status string	Статус уведомлений о черном/белом списке конечных точек оператора. Choices: `"enable"` `"disable"`
days_allowed list / elements=string	Дни недели, в которые могут отправляться уведомления. Choices: `"sunday"` `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"`
detect_server string	Включить/отключить автоматическое определение адреса сервера. Choices: `"enable"` `"disable"`
dupe_int integer	Интервал отправки дублирующих уведомлений.
dupe_int_mode string	Режим интервала дублирующих уведомлений. Choices: `"hours"` `"minutes"`
dupe_status string	Статус дублирующих уведомлений. Choices: `"enable"` `"disable"`

file_block_int integer	Интервал отправки уведомлений о блокировке файла.
file_block_int_mode string	Режим интервала уведомлений о блокировке файла. Choices: `"hours"` `"minutes"`
file_block_status string	Статус уведомлений о блокировке файла. Choices: `"enable"` `"disable"`
flood_int integer	Интервал отправки уведомлений о потоке.
flood_int_mode string	Режим интервала уведомлений о потоке. Choices: `"hours"` `"minutes"`
flood_status string	Статус уведомлений о потоке. Choices: `"enable"` `"disable"`
from_in_header string	Включить/отключить вставку адреса отправителя в HTTP-заголовок. Choices: `"enable"` `"disable"`
mms_checksum_int integer	Интервал отправки уведомлений о контрольной сумме MMS.
mms_checksum_int_mode string	Режим интервала уведомлений о контрольной сумме MMS. Choices: `"hours"` `"minutes"`
mms_checksum_status string	Статус уведомлений о контрольной сумме MMS. Choices: `"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	Протокол, используемый для отправки уведомлений. Choices: `"mm1"` `"mm3"` `"mm4"` `"mm7"`
msg_type string	Тип сообщения MM7. Choices: `"submit-req"` `"deliver-req"`
protocol string / required	Протокол.
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	Группа сообщений замены. Имя группы сообщений замены исходной системы.
member_path string	Путь к атрибуту элемента для обработки. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный как member_path, действителен для выполнения операции с элементом.
member_state string	Добавить или удалить элемент по указанному пути атрибута. Когда member_state указан, опция state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom string	Виртуальный домен из ранее определенных. VDOM — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельную единицу. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, предпочитаемый способ выполнения playbooks — httpapi

Примеры

- 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 строка	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для подготовки содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name строка	Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_mms_profile_module.html