Модуль fortinet.fortimanager.fmgr_firewall_mmsprofile – Настройка профилей MMS.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
firewall_mmsprofile dictionary	Набор параметров верхнего уровня.
avnotificationtable string	Идентификатор таблицы уведомлений AntiVirus.
bwordtable string	Идентификатор таблицы запрещенных слов MMS.
carrier-endpoint-prefix string	Устарело, переименуйте в carrier_endpoint_prefix. Включить/отключить добавление префикса к значениям конечной точки. Варианты: `"disable"` `"enable"`
carrier-endpoint-prefix-range-max integer	Устарело, переименуйте в carrier_endpoint_prefix_range_max. Максимальная длина значения конечной точки, к которой можно добавить префикс.
carrier-endpoint-prefix-range-min integer	Устарело, переименуйте в carrier_endpoint_prefix_range_min. Минимальная длина конечной точки, к которой будет добавлен префикс.
carrier-endpoint-prefix-string string	Устарело, переименуйте в carrier_endpoint_prefix_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 integer	Устарело, переименуйте в block_time1. Продолжительность действия действия.
block-time2 integer	Устарело, переименуйте в block_time2. Продолжительность действия действия.
block-time3 integer	Устарело, переименуйте в block_time3. Продолжительность действия.
limit1 integer	Максимальное количество разрешенных сообщений.
limit2 integer	Максимальное количество разрешенных сообщений.
limit3 integer	Максимальное количество разрешенных сообщений.
protocol string	Протокол.
status1 string	Включить/отключить обнаружение status1. Варианты: `"disable"` `"enable"`
status2 string	Включить/отключить обнаружение status2. Варианты: `"disable"` `"enable"`

status3 string	Включить/выключить обнаружение status3. Choices: `"disable"` `"enable"`
window1 integer	Окно для подсчета сообщений
window2 integer	Окно для подсчета сообщений
window3 integer	Окно для подсчета сообщений
flood dictionary	Защита от потоковых атак.
action1 list / elements=string	Действие при достижении порога. Choices: `"log"` `"archive"` `"intercept"` `"block"` `"archive-first"` `"alert-notif"`
action2 list / elements=string	Действие при достижении порога. Choices: `"log"` `"archive"` `"intercept"` `"block"` `"archive-first"` `"alert-notif"`
action3 list / elements=string	Действие при достижении порога. Choices: `"log"` `"archive"` `"intercept"` `"block"` `"archive-first"` `"alert-notif"`
block-time1 integer	Устарело, пожалуйста, переименуйте в block_time1. Продолжительность действия.
block-time2 integer	Устарело, пожалуйста, переименуйте в block_time2. Продолжительность действия.
block-time3 integer	Устарело, пожалуйста, переименуйте в block_time3. Продолжительность действия.
limit1 integer	Максимальное количество разрешенных сообщений.
limit2 integer	Максимальное количество разрешенных сообщений.
limit3 integer	Максимальное количество разрешенных сообщений.
protocol string	Протокол.
status1 string	Включить/выключить обнаружение status1. Choices: `"disable"` `"enable"`
status2 string	Включить/выключить обнаружение status2. Choices: `"disable"` `"enable"`
status3 string	Включить/выключить обнаружение status3. Choices: `"disable"` `"enable"`
window1 integer	Окно для подсчета сообщений
window2 integer	Окно для подсчета сообщений
window3 integer	Окно для подсчета сообщений
mm1 list / elements=string	Параметры MM1. Choices: `"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 string	Устарело, пожалуйста, переименуйте в mm1_addr_hdr. Поле HTTP-заголовка
mm1-addr-source string	Устарело, пожалуйста, переименуйте в mm1_addr_source. Источник адреса пользователя MM1. Choices: `"http-header"` `"cookie"`
mm1-convert-hex string	Устарело, пожалуйста, переименуйте в mm1_convert_hex. Включить/выключить преобразование адреса пользователя из HEX строки для MM1. Choices: `"disable"` `"enable"`

mm1-outbreak-prevention string	Устарело, переименуйте в mm1_outbreak_prevention. Включить службу предотвращения вирусных вспышек FortiGuard. Choices: `"disabled"` `"files"` `"full-archive"`
mm1-retr-dupe string	Устарело, переименуйте в mm1_retr_dupe. Включить/отключить повторное сканирование MM1 retr. Choices: `"disable"` `"enable"`
mm1-retrieve-scan string	Устарело, переименуйте в mm1_retrieve_scan. Включить/отключить сканирование сообщений конфигурации извлечения MM1. Choices: `"disable"` `"enable"`
mm1comfortamount integer	Количество MM1 comfort
mm1comfortinterval integer	Интервал MM1 comfort
mm1oversizelimit integer	Максимальный размер файла для сканирования
mm3 list / elements=string	Параметры MM3. Choices: `"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 string	Устарело, переименуйте в mm3_outbreak_prevention. Включить службу предотвращения вирусных вспышек FortiGuard. Choices: `"disabled"` `"files"` `"full-archive"`
mm3oversizelimit integer	Максимальный размер файла для сканирования
mm4 list / elements=string	Параметры MM4. Choices: `"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 string	Устарело, переименуйте в mm4_outbreak_prevention. Включить службу предотвращения вирусных вспышек FortiGuard. Choices: `"disabled"` `"files"` `"full-archive"`
mm4oversizelimit integer	Максимальный размер файла для сканирования
mm7 list / elements=string	Параметры MM7. Choices: `"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 string	Устарело, переименуйте в mm7_addr_hdr. Поле заголовка HTTP
mm7-addr-source string	Устарело, переименуйте в mm7_addr_source. Источник адреса пользователя MM7. Choices: `"http-header"` `"cookie"`
mm7-convert-hex string	Устарело, переименуйте в mm7_convert_hex. Включить/отключить преобразование адреса пользователя из HEX строки для MM7. Choices: `"disable"` `"enable"`
mm7-outbreak-prevention string	Устарело, переименуйте в mm7_outbreak_prevention. Включить службу предотвращения вирусных вспышек FortiGuard. Choices: `"disabled"` `"files"` `"full-archive"`
mm7comfortamount integer	Количество MM7 comfort
mm7comfortinterval integer	Интервал MM7 comfort
mm7oversizelimit integer	Максимальный размер файла для сканирования
mms-antispam-mass-log string	Устарело, переименуйте в mms_antispam_mass_log. Включить/отключить ведение журнала для массовой антиспам-защиты MMS. Choices: `"disable"` `"enable"`
mms-av-block-log string	Устарело, переименуйте в mms_av_block_log. Включить/отключить ведение журнала для блокировки файлов антивирусом MMS. Choices: `"disable"` `"enable"`

mms-av-oversize-log string	Устарело, переименуйте в mms_av_oversize_log. Включить/отключить ведение журнала для блокировки файлов чрезмерного размера антивирусом MMS. Choices: `"disable"` `"enable"`
mms-av-virus-log string	Устарело, переименуйте в mms_av_virus_log. Включить/отключить ведение журнала для сканирования антивирусом MMS. Choices: `"disable"` `"enable"`
mms-carrier-endpoint-filter-log string	Устарело, переименуйте в mms_carrier_endpoint_filter_log. Включить/отключить ведение журнала для блокировки фильтра конечной точки MMS. Choices: `"disable"` `"enable"`
mms-checksum-log string	Устарело, переименуйте в mms_checksum_log. Включить/отключить ведение журнала контрольной суммы контента MMS. Choices: `"disable"` `"enable"`
mms-checksum-table string	Устарело, переименуйте в mms_checksum_table. ID таблицы контрольных сумм контента MMS.
mms-notification-log string	Устарело, переименуйте в mms_notification_log. Включить/отключить ведение журнала для уведомлений MMS. Choices: `"disable"` `"enable"`
mms-web-content-log string	Устарело, переименуйте в mms_web_content_log. Включить/отключить ведение журнала для блокировки веб-контента MMS. Choices: `"disable"` `"enable"`
mmsbwordthreshold integer	Порог запрещенных слов MMS.
name string / required	Имя профиля.
notif-msisdn list / elements=dictionary	Устарело, переименуйте в notif_msisdn. Notif msisdn.
msisdn string	Получатель 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 dictionary	Уведомление.
alert-int integer	Устарело, переименуйте в alert_int. Интервал отправки уведомлений о предупреждениях.
alert-int-mode string	Устарело, переименуйте в alert_int_mode. Режим интервала уведомлений о предупреждениях. Choices: `"hours"` `"minutes"`
alert-src-msisdn string	Устарело, переименуйте в alert_src_msisdn. Укажите адрес отправителя для сообщений предупреждений.
alert-status string	Устарело, переименуйте в alert_status. Статус уведомлений о предупреждениях. Choices: `"disable"` `"enable"`
bword-int integer	Устарело, переименуйте в bword_int. Интервал отправки уведомлений о запрещенных словах.
bword-int-mode string	Устарело, переименуйте в bword_int_mode. Режим интервала уведомлений о запрещенных словах. Choices: `"hours"` `"minutes"`
bword-status string	Устарело, переименуйте в bword_status. Статус уведомлений о запрещенных словах. Choices: `"disable"` `"enable"`
carrier-endpoint-bwl-int integer	Устарело, переименуйте в carrier_endpoint_bwl_int. Интервал отправки уведомлений черного/белого списка конечных точек оператора…
carrier-endpoint-bwl-int-mode string	Устарело, переименуйте в carrier_endpoint_bwl_int_mode. Режим интервала уведомлений черного/белого списка конечных точек оператора… Choices: `"hours"` `"minutes"`
carrier-endpoint-bwl-status string	Устарело, переименуйте в carrier_endpoint_bwl_status. Статус уведомлений черного/белого списка конечных точек оператора. Choices: `"disable"` `"enable"`

days-allowed list / elements=string	Устарело, переименуйте в days_allowed. Будни, в которые могут отправляться уведомления. Choices: `"sunday"` `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"`
detect-server string	Устарело, переименуйте в detect_server. Включить/выключить автоматическое определение адреса сервера. Choices: `"disable"` `"enable"`
dupe-int integer	Устарело, переименуйте в dupe_int. Интервал отправки повторяющихся уведомлений.
dupe-int-mode string	Устарело, переименуйте в dupe_int_mode. Режим интервала повторяющихся уведомлений. Choices: `"hours"` `"minutes"`
dupe-status string	Устарело, переименуйте в dupe_status. Статус повторяющихся уведомлений. Choices: `"disable"` `"enable"`
file-block-int integer	Устарело, переименуйте в file_block_int. Интервал отправки уведомлений о блокировке файлов.
file-block-int-mode string	Устарело, переименуйте в file_block_int_mode. Режим интервала уведомлений о блокировке файлов. Choices: `"hours"` `"minutes"`
file-block-status string	Устарело, переименуйте в file_block_status. Статус уведомлений о блокировке файлов. Choices: `"disable"` `"enable"`
flood-int integer	Устарело, переименуйте в flood_int. Интервал отправки уведомлений о потоке.
flood-int-mode string	Устарело, переименуйте в flood_int_mode. Режим интервала уведомлений о потоке. Choices: `"hours"` `"minutes"`
flood-status string	Устарело, переименуйте в flood_status. Статус уведомлений о потоке. Choices: `"disable"` `"enable"`
from-in-header string	Устарело, переименуйте в from_in_header. Включить/выключить вставку адреса отправителя в HTTP-заголовок. Choices: `"disable"` `"enable"`
mms-checksum-int integer	Устарело, переименуйте в mms_checksum_int. Интервал отправки уведомлений о контрольной сумме MMS.
mms-checksum-int-mode string	Устарело, переименуйте в mms_checksum_int_mode. Режим интервала уведомлений о контрольной сумме MMS. Choices: `"hours"` `"minutes"`
mms-checksum-status string	Устарело, переименуйте в mms_checksum_status. Статус уведомлений о контрольной сумме MMS. Choices: `"disable"` `"enable"`
mmsc-hostname string	Устарело, переименуйте в mmsc_hostname. Имя хоста или IP-адрес MMSC.
mmsc-password any	(list) Устарело, переименуйте в mmsc_password. Пароль, необходимый для аутентификации с MMSC.
mmsc-port integer	Устарело, переименуйте в mmsc_port. Порт, используемый на MMSC для отправки сообщений MMS.
mmsc-url string	Устарело, переименуйте в mmsc_url. URL-адрес, используемый на MMSC для отправки сообщений MMS.
mmsc-username string	Устарело, переименуйте в mmsc_username. Имя пользователя, необходимое для аутентификации с MMSC.
msg-protocol string	Устарело, переименуйте в msg_protocol. Протокол, используемый для отправки уведомлений. Choices: `"mm1"` `"mm3"` `"mm4"` `"mm7"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения MM7. Choices: `"submit-req"` `"deliver-req"`
protocol string	Протокол.
rate-limit integer	Устарело, переименуйте в rate_limit. Лимит скорости отправки уведомлений.

tod-window-duration string	Устарело, переименуйте в tod_window_duration. Продолжительность временного окна.
tod-window-end string	Устарело, переименуйте в tod_window_end. Устарело.
tod-window-start string	Устарело, переименуйте в tod_window_start. Начало временного окна.
user-domain string	Устарело, переименуйте в user_domain. Имя домена, к которому принадлежат адреса пользователей.
vas-id string	Устарело, переименуйте в vas_id. Идентификатор VAS.
vasp-id string	Устарело, переименуйте в vasp_id. Идентификатор VASP.
virus-int integer	Устарело, переименуйте в virus_int. Интервал отправки уведомлений о вирусах.
virus-int-mode string	Устарело, переименуйте в virus_int_mode. Режим интервала уведомлений о вирусах. Варианты: `"hours"` `"minutes"`
virus-status string	Устарело, переименуйте в virus_status. Статус уведомлений о вирусах. Варианты: `"disable"` `"enable"`
outbreak-prevention dictionary	Устарело, переименуйте в outbreak_prevention. Предотвращение вспышек.
external-blocklist string	Устарело, переименуйте в external_blocklist. Включить/выключить внешний вредоносный блокировщик. Варианты: `"disable"` `"enable"`
ftgd-service string	Устарело, переименуйте в ftgd_service. Включить/выключить службу предотвращения вспышек вирусов FortiGuard. Варианты: `"disable"` `"enable"`
remove-blocked-const-length string	Устарело, переименуйте в remove_blocked_const_length. Включить/выключить замену заблокированного файла MMS постоянной длиной. Варианты: `"disable"` `"enable"`
replacemsg-group string	Устарело, переименуйте в replacemsg_group. Группа замещающих сообщений.
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, с которыми будут переопределены условия успеха.
state string / required	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая 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 помогают выполнить эту работу.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачей, если возвращается ненулевой rc. Вы также можете переопределить условия сбоя или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_mmsprofile_module.html