Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_firewall_mmsprofile — настройка профилей MMS.

Примечание

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

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

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

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

Добавлено в 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

dictionary

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

avnotificationtable

string

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

bwordtable

string

Идентификатор таблицы запрещённых слов MMS.

carrier_endpoint_prefix

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

string

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

Варианты:

  • "disable"
  • "enable"

carrier_endpoint_prefix_range_max

псевдонимы: carrier-endpoint-prefix-range-max

integer

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

carrier_endpoint_prefix_range_min

псевдонимы: carrier-endpoint-prefix-range-min

integer

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

carrier_endpoint_prefix_string

псевдонимы: carrier-endpoint-prefix-string

string

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

carrierendpointbwltable

string

Идентификатор таблицы фильтров конечных точек оператора.

comment

string

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

dupe

dictionary

Дубликаты.

action1

list / elements=string

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

Варианты:

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

action2

list / elements=string

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

Варианты:

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

action3

list / elements=string

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

Варианты:

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

block_time1

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

integer

Продолжительность действия эффекта.

block_time2

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

integer

Продолжительность действия эффекта.

block_time3

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

integer

Продолжительность действия.

limit1

integer

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

limit2

integer

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

limit3

integer

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

protocol

string

Протокол.

status1

string

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

Варианты:

  • "disable"
  • "enable"

status2

string

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

Варианты:

  • "disable"
  • "enable"

status3

string

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

Варианты:

  • "disable"
  • "enable"

window1

integer

Интервал, за который подсчитываются сообщения.

window2

integer

Интервал, за который подсчитываются сообщения.

window3

integer

Интервал, за который подсчитываются сообщения.

flood

dictionary

Флуд.

action1

list / elements=string

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

Варианты:

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

action2

list / elements=string

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

Варианты:

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

action3

list / elements=string

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

Варианты:

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

block_time1

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

integer

Продолжительность действия эффекта.

block_time2

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

integer

Продолжительность действия эффекта.

block_time3

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

integer

Продолжительность действия.

limit1

integer

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

limit2

integer

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

limit3

integer

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

protocol

string

Протокол.

status1

string

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

Варианты:

  • "disable"
  • "enable"

status2

string

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

Варианты:

  • "disable"
  • "enable"

status3

string

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

Варианты:

  • "disable"
  • "enable"

window1

integer

Интервал, за который подсчитываются сообщения.

window2

integer

Интервал, за который подсчитываются сообщения.

window3

integer

Интервал, за который подсчитываются сообщения.

mm1

list / elements=string

Параметры MM1.

Варианты:

  • "avmonitor"
  • "block"
  • "oversize"
  • "quarantine"
  • "scan"
  • "avquery"
  • "bannedword"
  • "no-content-summary"
  • "archive-summary"
  • "archive-full"
  • "carrier-endpoint-bwl"
  • "remove-blocked"
  • "chunkedbypass"
  • "clientcomfort"
  • "servercomfort"
  • "strict-file"
  • "mms-checksum"

mm1_addr_hdr

псевдонимы: mm1-addr-hdr

string

Поле HTTP-заголовка.

mm1_addr_source

псевдонимы: mm1-addr-source

string

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

Варианты:

  • "http-header"
  • "cookie"

mm1_convert_hex

псевдонимы: mm1-convert-hex

string

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

Варианты:

  • "disable"
  • "enable"

mm1_outbreak_prevention

псевдонимы: mm1-outbreak-prevention

string

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

Варианты:

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

mm1_retr_dupe

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

string

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

Варианты:

  • "disable"
  • "enable"

mm1_retrieve_scan

псевдонимы: mm1-retrieve-scan

string

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

Варианты:

  • "disable"
  • "enable"

mm1comfortamount

integer

Объем комфортного режима MM1

mm1comfortinterval

integer

Интервал комфортного режима MM1

mm1oversizelimit

integer

Максимальный размер файла для сканирования

mm3

list / elements=string

Параметры MM3.

Варианты:

  • "avmonitor"
  • "block"
  • "oversize"
  • "quarantine"
  • "scan"
  • "avquery"
  • "bannedword"
  • "no-content-summary"
  • "archive-summary"
  • "archive-full"
  • "carrier-endpoint-bwl"
  • "remove-blocked"
  • "fragmail"
  • "splice"
  • "mms-checksum"

mm3_outbreak_prevention

aliases: mm3-outbreak-prevention

string

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

Варианты:

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

mm3oversizelimit

integer

Максимальный размер файла для сканирования

mm4

list / elements=string

Параметры MM4.

Варианты:

  • "avmonitor"
  • "block"
  • "oversize"
  • "quarantine"
  • "scan"
  • "avquery"
  • "bannedword"
  • "no-content-summary"
  • "archive-summary"
  • "archive-full"
  • "carrier-endpoint-bwl"
  • "remove-blocked"
  • "fragmail"
  • "splice"
  • "mms-checksum"

mm4_outbreak_prevention

aliases: mm4-outbreak-prevention

string

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

Варианты:

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

mm4oversizelimit

integer

Максимальный размер файла для сканирования

mm7

list / elements=string

Параметры MM7.

Варианты:

  • "avmonitor"
  • "block"
  • "oversize"
  • "quarantine"
  • "scan"
  • "avquery"
  • "bannedword"
  • "no-content-summary"
  • "archive-summary"
  • "archive-full"
  • "carrier-endpoint-bwl"
  • "remove-blocked"
  • "chunkedbypass"
  • "clientcomfort"
  • "servercomfort"
  • "strict-file"
  • "mms-checksum"

mm7_addr_hdr

aliases: mm7-addr-hdr

string

Поле заголовка HTTP

mm7_addr_source

aliases: mm7-addr-source

string

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

Варианты:

  • "http-header"
  • "cookie"

mm7_convert_hex

aliases: mm7-convert-hex

string

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

Варианты:

  • "disable"
  • "enable"

mm7_outbreak_prevention

aliases: mm7-outbreak-prevention

string

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

Варианты:

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

mm7comfortamount

integer

Объем комфортного режима MM7

mm7comfortinterval

integer

Интервал комфортного режима MM7

mm7oversizelimit

integer

Максимальный размер файла для сканирования

mms_antispam_mass_log

aliases: mms-antispam-mass-log

string

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

Варианты:

  • "disable"
  • "enable"

mms_av_block_log

aliases: mms-av-block-log

string

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

Варианты:

  • "disable"
  • "enable"

mms_av_oversize_log

aliases: mms-av-oversize-log

string

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

Варианты:

  • "disable"
  • "enable"

mms_av_virus_log

aliases: mms-av-virus-log

string

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

Варианты:

  • "disable"
  • "enable"

mms_carrier_endpoint_filter_log

aliases: mms-carrier-endpoint-filter-log

string

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

Варианты:

  • "disable"
  • "enable"

mms_checksum_log

aliases: mms-checksum-log

string

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

Варианты:

  • "disable"
  • "enable"

mms_checksum_table

aliases: mms-checksum-table

string

Идентификатор таблицы контрольных сумм содержимого MMS.

mms_notification_log

aliases: mms-notification-log

string

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

Варианты:

  • "disable"
  • "enable"

mms_web_content_log

aliases: mms-web-content-log

string

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

Варианты:

  • "disable"
  • "enable"

mmsbwordthreshold

integer

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

name

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

Имя профиля.

notif_msisdn

aliases: 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

dictionary

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

alert_int

aliases: alert-int

integer

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

alert_int_mode

aliases: alert-int-mode

string

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

Варианты:

  • "hours"
  • "minutes"

alert_src_msisdn

aliases: alert-src-msisdn

string

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

alert_status

aliases: alert-status

string

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

Варианты:

  • "disable"
  • "enable"

bword_int

aliases: bword-int

integer

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

bword_int_mode

aliases: bword-int-mode

string

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

Варианты:

  • "hours"
  • "minutes"

bword_status

aliases: bword-status

string

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

Варианты:

  • "disable"
  • "enable"

carrier_endpoint_bwl_int

aliases: carrier-endpoint-bwl-int

integer

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

carrier_endpoint_bwl_int_mode

aliases: carrier-endpoint-bwl-int-mode

string

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

Варианты:

  • "hours"
  • "minutes"

carrier_endpoint_bwl_status

aliases: carrier-endpoint-bwl-status

string

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

Варианты:

  • "disable"
  • "enable"

days_allowed

aliases: days-allowed

list / elements=string

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

Варианты:

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

detect_server

aliases: detect-server

string

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

Варианты:

  • "disable"
  • "enable"

dupe_int

aliases: dupe-int

integer

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

dupe_int_mode

aliases: dupe-int-mode

string

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

Варианты:

  • "hours"
  • "minutes"

dupe_status

aliases: dupe-status

string

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

Варианты:

  • "disable"
  • "enable"

file_block_int

aliases: file-block-int

integer

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

file_block_int_mode

aliases: file-block-int-mode

string

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

Варианты:

  • "hours"
  • "minutes"

file_block_status

aliases: file-block-status

string

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

Варианты:

  • "disable"
  • "enable"

flood_int

aliases: flood-int

integer

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

flood_int_mode

aliases: flood-int-mode

string

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

Варианты:

  • "hours"
  • "minutes"

flood_status

aliases: flood-status

string

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

Варианты:

  • "disable"
  • "enable"

from_in_header

aliases: from-in-header

string

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

Варианты:

  • "disable"
  • "enable"

mms_checksum_int

aliases: mms-checksum-int

integer

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

mms_checksum_int_mode

aliases: mms-checksum-int-mode

string

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

Варианты:

  • "hours"
  • "minutes"

mms_checksum_status

aliases: mms-checksum-status

string

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

Варианты:

  • "disable"
  • "enable"

mmsc_hostname

aliases: mmsc-hostname

string

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

mmsc_password

aliases: mmsc-password

any

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

mmsc_port

aliases: mmsc-port

integer

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

mmsc_url

aliases: mmsc-url

string

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

mmsc_username

aliases: mmsc-username

string

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

msg_protocol

aliases: msg-protocol

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

Варианты:

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

protocol

string

Протокол.

rate_limit

aliases: rate-limit

integer

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

tod_window_duration

aliases: tod-window-duration

string

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

tod_window_end

aliases: tod-window-end

string

Устарело.

tod_window_start

aliases: tod-window-start

string

Начало временного окна.

user_domain

aliases: user-domain

string

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

vas_id

aliases: vas-id

string

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

vasp_id

aliases: vasp-id

string

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

virus_int

aliases: virus-int

integer

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

virus_int_mode

aliases: virus-int-mode

string

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

Варианты:

  • "hours"
  • "minutes"

virus_status

aliases: virus-status

string

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

Варианты:

  • "disable"
  • "enable"

outbreak_prevention

aliases: outbreak-prevention

dictionary

Защита от вспышек вирусной активности.

external_blocklist

aliases: external-blocklist

string

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

Варианты:

  • "disable"
  • "enable"

ftgd_service

aliases: ftgd-service

string

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

Варианты:

  • "disable"
  • "enable"

remove_blocked_const_length

aliases: remove-blocked-const-length

string

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

Варианты:

  • "disable"
  • "enable"

replacemsg_group

aliases: replacemsg-group

string

Группа сообщений-заменителей.

forticloud_access_token

string

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

proposed_method

string

Переопределенный метод для базового запроса Json RPC.

Варианты:

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

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия возникновения ошибки.

rc_succeeded

list / elements=integer

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

revision_note

string

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

state

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

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

Варианты:

  • "present"
  • "absent"

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.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure MMS profiles.
      fortinet.fortimanager.fmgr_firewall_mmsprofile:
        bypass_validation: false
        adom: FortiCarrier # FortiCarrier only object, need a FortiCarrier adom
        state: present
        firewall_mmsprofile:
          comment: "ansible-comment"
          # extended_utm_log: disable
          mm1:
            - avmonitor
            - block
            - oversize
            - quarantine
            - scan
            - avquery
            - bannedword
            - no-content-summary
            - archive-summary
            - archive-full
            - carrier-endpoint-bwl
            - remove-blocked
            - chunkedbypass
            - clientcomfort
            - servercomfort
            - strict-file
            - mms-checksum
          mm3:
            - avmonitor
            - block
            - oversize
            - quarantine
            - scan
            - avquery
            - bannedword
            - no-content-summary
            - archive-summary
            - archive-full
            - carrier-endpoint-bwl
            - remove-blocked
            - fragmail
            - splice
            - mms-checksum
          mm4:
            - avmonitor
            - block
            - oversize
            - quarantine
            - scan
            - avquery
            - bannedword
            - no-content-summary
            - archive-summary
            - archive-full
            - carrier-endpoint-bwl
            - remove-blocked
            - fragmail
            - splice
            - mms-checksum
          mm7:
            - avmonitor
            - block
            - oversize
            - quarantine
            - scan
            - avquery
            - bannedword
            - no-content-summary
            - archive-summary
            - archive-full
            - carrier-endpoint-bwl
            - remove-blocked
            - chunkedbypass
            - clientcomfort
            - servercomfort
            - strict-file
            - mms-checksum
          name: "ansible-test"

- 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 MMS profiles
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_mmsprofile"
          params:
            adom: "FortiCarrier" # FortiCarrier only object, need a FortiCarrier adom
            mms_profile: "your_value"

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

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

Ключ

Описание

meta

dictionary

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

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

request_url

string

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

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

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

response_code

integer

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

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

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

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

Пример: "OK."

system_information

dictionary

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

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

rc

integer

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

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

Пример: 0

version_check_warning

list / elements=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_module.html

Spec-Zone.ru

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