Модуль fortinet.fortimanager.fmgr_firewall_profileprotocoloptions — настройка параметров протокола.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_profileprotocoloptions.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
firewall_profileprotocoloptions dictionary | Набор параметров верхнего уровня. |
|
cifs dictionary |
CIFS. |
|
domain_controller псевдонимы: domain-controller string |
Домен, для которого следует расшифровывать трафик CIFS. |
|
file_filter псевдонимы: file-filter dictionary |
Фильтр файлов. |
|
entries list / elements=dictionary |
Записи. |
|
action string |
Действие, выполняемое для соответствующего файла. Варианты:
|
|
comment string |
Комментарий. |
|
direction string |
Сопоставлять файлы, передаваемые в исходном или ответном направлении сеанса. Варианты:
|
|
file_type псевдонимы: file-type any |
(список) Выберите тип файла. |
|
filter string |
Добавить фильтр файлов. |
|
protocol list / elements=string |
Протоколы, для которых применяется фильтр. Варианты:
|
|
log string |
Включить или отключить ведение журнала фильтра файлов. Варианты:
|
|
status string |
Включить или отключить фильтр файлов. Варианты:
|
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit псевдонимы: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
ports any |
(список) Порты для проверки содержимого |
|
scan_bzip2 псевдонимы: scan-bzip2 string |
Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
server_credential_type псевдонимы: server-credential-type string |
Тип учетных данных сервера CIFS. Варианты:
|
|
server_keytab псевдонимы: server-keytab list / elements=dictionary |
Таблица ключей сервера. |
|
keytab string |
Файл таблицы ключей в кодировке Base64, содержащий учетные данные сервера. |
|
password any |
(список) Пароль для таблицы ключей. |
|
principal string |
Субъект-служба. |
|
status string |
Включить или отключить активное состояние проверки для этого протокола. Варианты:
|
|
tcp_window_maximum псевдонимы: tcp-window-maximum integer |
Максимальный динамический размер окна TCP |
|
tcp_window_minimum псевдонимы: tcp-window-minimum integer |
Минимальный динамический размер окна TCP |
|
tcp_window_size псевдонимы: tcp-window-size integer |
Задать статический размер окна TCP |
|
tcp_window_type псевдонимы: tcp-window-type string |
Укажите тип окна TCP, используемый для этого протокола. Варианты:
|
|
uncompressed_nest_limit псевдонимы: uncompressed-nest-limit integer |
Максимальное количество вложенных уровней сжатия, которые можно распаковать и проверить |
|
uncompressed_oversize_limit псевдонимы: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно проверить |
|
comment string |
Необязательные комментарии. |
|
dns dictionary |
DNS. |
|
ports any |
(список) Порты для проверки содержимого |
|
status string |
Включить или отключить активное состояние проверки для этого протокола. Варианты:
|
|
feature_set псевдонимы: feature-set string |
Набор функций для режима потока или прокси. Варианты:
|
|
ftp dictionary |
FTP. |
|
comfort_amount псевдонимы: comfort-amount integer |
Объем данных, передаваемых за одну передачу для поддержания активности клиента |
|
comfort_interval псевдонимы: comfort-interval integer |
Промежуток времени между началом или последней передачей и следующей передачей данных для поддержания активности клиента |
|
explicit_ftp_tls псевдонимы: explicit-ftp-tls string |
Включить или отключить перенаправление FTP для явного FTPS. Варианты:
|
|
inspect_all псевдонимы: inspect-all string |
Включить или отключить проверку всех портов для протокола. Варианты:
|
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit псевдонимы: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
ports any |
(список) Порты для проверки содержимого |
|
scan_bzip2 псевдонимы: scan-bzip2 string |
Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
ssl_offloaded псевдонимы: ssl-offloaded string |
Расшифровка и шифрование SSL выполняются внешним устройством. Варианты:
|
|
status string |
Включить или отключить активное состояние проверки для этого протокола. Варианты:
|
|
stream_based_uncompressed_limit псевдонимы: stream-based-uncompressed-limit integer |
Максимальный размер распакованных данных в потоке, который будет проверяться |
|
tcp_window_maximum псевдонимы: tcp-window-maximum integer |
Максимальный динамический размер окна TCP. |
|
tcp_window_minimum псевдонимы: tcp-window-minimum integer |
Минимальный динамический размер окна TCP. |
|
tcp_window_size псевдонимы: tcp-window-size integer |
Задать статический размер окна TCP. |
|
tcp_window_type псевдонимы: tcp-window-type string |
Тип окна TCP, используемый для этого протокола. Варианты:
|
|
uncompressed_nest_limit псевдонимы: uncompressed-nest-limit integer |
Максимальная глубина вложенности сжатия, которую можно распаковать и просканировать |
|
uncompressed_oversize_limit псевдонимы: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно просканировать |
|
http dictionary |
HTTP. |
|
address_ip_rating псевдонимы: address-ip-rating string |
Включить или отключить оценку URL на основе IP-адреса. Варианты:
|
|
block_page_status_code псевдонимы: block-page-status-code integer |
Код, возвращаемый для заблокированных страниц HTTP |
|
comfort_amount псевдонимы: comfort-amount integer |
Объем данных, отправляемых за одну передачу для поддержания активности клиента |
|
comfort_interval псевдонимы: comfort-interval integer |
Промежуток времени между началом или последней передачей и следующей передачей данных для поддержания активности клиента |
|
dns_protection псевдонимы: dns-protection string |
Включить или отключить защиту DNS для трафика HTTP/HTTPS. Варианты:
|
|
domain_fronting псевдонимы: domain-fronting string |
Настроить подмену домена в HTTP Варианты:
|
|
encrypted_file псевдонимы: encrypted-file string |
Зашифрованный файл. Варианты:
|
|
encrypted_file_log псевдонимы: encrypted-file-log string |
Журнал зашифрованных файлов. Варианты:
|
|
fortinet_bar псевдонимы: fortinet-bar string |
Включить или отключить панель Fortinet в содержимом HTML. Варианты:
|
|
fortinet_bar_port псевдонимы: fortinet-bar-port integer |
Порт, используемый панелью Fortinet |
|
h2c string |
Включить или отключить обновление HTTP-соединения до h2c. Варианты:
|
|
http_0_9 псевдонимы: http-0.9 string |
Настроить действие при получении HTTP 0. Варианты:
|
|
http_policy псевдонимы: http-policy string |
Включить или отключить проверку политики HTTP. Варианты:
|
|
inspect_all псевдонимы: inspect-all string |
Включить или отключить проверку всех портов для протокола. Варианты:
|
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit псевдонимы: oversize-limit integer |
Максимальный размер файла в памяти, который можно просканировать |
|
ports any |
(список) Порты для сканирования содержимого |
|
post_lang псевдонимы: post-lang list / elements=string |
Идентификаторы кодировок символов для преобразования в UTF-8 при проверке запрещенных слов и данных DLP в HTTP POST-запросах Варианты:
|
|
proxy_after_tcp_handshake псевдонимы: proxy-after-tcp-handshake string |
Проксировать трафик после установления трехстороннего рукопожатия TCP Варианты:
|
|
range_block псевдонимы: range-block string |
Включить или отключить блокировку частичной загрузки. Варианты:
|
|
retry_count псевдонимы: retry-count integer |
Количество попыток повторного подключения по HTTP |
|
scan_bzip2 псевдонимы: scan-bzip2 string |
Включить или отключить сканирование файлов, сжатых с помощью BZip2. Варианты:
|
|
ssl_offloaded псевдонимы: ssl-offloaded string |
Расшифровка и шифрование SSL выполняются внешним устройством. Варианты:
|
|
status string |
Включить или отключить активное сканирование этого протокола. Варианты:
|
|
stream_based_uncompressed_limit псевдонимы: stream-based-uncompressed-limit integer |
Максимальный размер распакованных данных в потоке, подлежащих сканированию |
|
streaming_content_bypass псевдонимы: streaming-content-bypass string |
Включить или отключить обход буферизации потокового содержимого. Варианты:
|
|
strip_x_forwarded_for псевдонимы: strip-x-forwarded-for string |
Включить или отключить удаление заголовка HTTP X-Forwarded-For. Варианты:
|
|
switching_protocols псевдонимы: switching-protocols string |
Исключить из сканирования или заблокировать соединение, пытающееся переключить протокол. Варианты:
|
|
tcp_window_maximum псевдонимы: tcp-window-maximum integer |
Максимальный динамический размер окна TCP |
|
tcp_window_minimum псевдонимы: tcp-window-minimum integer |
Минимальный динамический размер окна TCP |
|
tcp_window_size псевдонимы: tcp-window-size integer |
Задать статический размер окна TCP |
|
tcp_window_type псевдонимы: tcp-window-type string |
Указать тип окна TCP, используемый для этого протокола. Варианты:
|
|
tunnel_non_http псевдонимы: tunnel-non-http string |
Настроить обработку трафика, не относящегося к HTTP, если профиль для HTTP-трафика принимает сеанс, не использующий HTTP. Варианты:
|
|
uncompressed_nest_limit псевдонимы: uncompressed-nest-limit integer |
Максимальная глубина вложенности сжатия, которую можно распаковать и просканировать |
|
uncompressed_oversize_limit псевдонимы: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно просканировать |
|
unknown_content_encoding псевдонимы: unknown-content-encoding string |
Настроить действие, выполняемое устройством FortiGate при обнаружении неизвестной кодировки содержимого. Варианты:
|
|
unknown_http_version псевдонимы: unknown-http-version string |
Как обрабатывать сеансы HTTP, не соответствующие HTTP 0. Варианты:
|
|
verify_dns_for_policy_matching aliases: verify-dns-for-policy-matching string |
Включить или отключить проверку DNS при сопоставлении с политиками. Варианты:
|
|
imap dictionary |
IMAP. |
|
address_ip_rating aliases: address-ip-rating string |
Рейтинг IP-адреса. Варианты:
|
|
inspect_all aliases: inspect-all string |
Включить или отключить проверку всех портов протокола. Варианты:
|
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit aliases: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
ports any |
(список) Порты для проверки содержимого |
|
proxy_after_tcp_handshake aliases: proxy-after-tcp-handshake string |
Проксировать трафик после установления трехэтапного рукопожатия TCP Варианты:
|
|
scan_bzip2 aliases: scan-bzip2 string |
Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
ssl_offloaded aliases: ssl-offloaded string |
Расшифровка и шифрование SSL выполняются внешним устройством. Варианты:
|
|
status string |
Включить или отключить активное сканирование этого протокола. Варианты:
|
|
uncompressed_nest_limit aliases: uncompressed-nest-limit integer |
Максимальный уровень вложенности сжатия, который можно распаковать и проверить |
|
uncompressed_oversize_limit aliases: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно проверить |
|
mail_signature aliases: mail-signature dictionary |
Подпись электронной почты. |
|
signature string |
Подпись, добавляемая к исходящим электронным письмам |
|
status string |
Включить или отключить добавление подписи к сообщениям электронной почты SMTP, проходящим через FortiGate. Варианты:
|
|
mapi dictionary |
MAPI. |
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit aliases: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
ports any |
(список) Порты для проверки содержимого |
|
scan_bzip2 aliases: scan-bzip2 string |
Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
status string |
Включить или отключить активное сканирование этого протокола. Варианты:
|
|
uncompressed_nest_limit aliases: uncompressed-nest-limit integer |
Максимальный уровень вложенности сжатия, который можно распаковать и проверить |
|
uncompressed_oversize_limit aliases: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно проверить |
|
name string / обязательный |
Имя. |
|
nntp dictionary |
NNTP. |
|
inspect_all aliases: inspect-all string |
Включить или отключить проверку всех портов протокола. Варианты:
|
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit aliases: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
ports any |
(список) Порты для проверки содержимого |
|
proxy_after_tcp_handshake aliases: proxy-after-tcp-handshake string |
Проксировать трафик после установления трехэтапного рукопожатия TCP Варианты:
|
|
scan_bzip2 aliases: scan-bzip2 string |
Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
status string |
Включить или отключить активное сканирование этого протокола. Варианты:
|
|
uncompressed_nest_limit aliases: uncompressed-nest-limit integer |
Максимальный уровень вложенности сжатия, который можно распаковать и проверить |
|
uncompressed_oversize_limit aliases: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно проверить |
|
oversize_log aliases: oversize-log string |
Включить или отключить ведение журнала при блокировке антивирусом файлов, превышающих допустимый размер. Варианты:
|
|
pop3 dictionary |
POP3. |
|
inspect_all aliases: inspect-all string |
Включить или отключить проверку всех портов протокола. Варианты:
|
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit aliases: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
ports any |
(список) Порты для проверки содержимого |
|
proxy_after_tcp_handshake aliases: proxy-after-tcp-handshake string |
Проксировать трафик после установления трехэтапного рукопожатия TCP Варианты:
|
|
scan_bzip2 aliases: scan-bzip2 string |
Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
ssl_offloaded aliases: ssl-offloaded string |
Расшифровка и шифрование SSL выполняются внешним устройством. Варианты:
|
|
status string |
Включить или отключить активное сканирование этого протокола. Варианты:
|
|
uncompressed_nest_limit aliases: uncompressed-nest-limit integer |
Максимальный уровень вложенности сжатия, который можно распаковать и проверить |
|
uncompressed_oversize_limit aliases: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно проверить |
|
proxy_redirect aliases: proxy-redirect dictionary |
Перенаправление прокси-сервера. |
|
ports any |
(list) Порты. |
|
status string |
Статус. Варианты:
|
|
replacemsg_group aliases: replacemsg-group string |
Имя группы сообщений-замен для использования |
|
rpc_over_http aliases: rpc-over-http string |
Включить или отключить проверку RPC через HTTP. Варианты:
|
|
rtmp dictionary |
RTMP. |
|
http_tunnel aliases: http-tunnel string |
Включить или отключить HTTP-туннель RTMP. Варианты:
|
|
ports any |
(list) Порты для проверки содержимого |
|
rtmpt string |
Включить или отключить RTMPT. Варианты:
|
|
status string |
Включить или отключить активное сканирование этого протокола. Варианты:
|
|
smtp dictionary |
SMTP. |
|
inspect_all aliases: inspect-all string |
Включить или отключить проверку всех портов протокола. Варианты:
|
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit aliases: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
ports any |
(list) Порты для проверки содержимого |
|
proxy_after_tcp_handshake aliases: proxy-after-tcp-handshake string |
Проксировать трафик после установления трехэтапного TCP-соединения Варианты:
|
|
scan_bzip2 aliases: scan-bzip2 string |
Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
server_busy aliases: server-busy string |
Включить или отключить сообщение о занятости SMTP-сервера, если сервер недоступен. Варианты:
|
|
ssl_offloaded aliases: ssl-offloaded string |
Расшифровка и шифрование SSL выполняются внешним устройством. Варианты:
|
|
status string |
Включить или отключить активное сканирование этого протокола. Варианты:
|
|
uncompressed_nest_limit aliases: uncompressed-nest-limit integer |
Максимальное число вложенных уровней сжатия, которые можно распаковать и проверить |
|
uncompressed_oversize_limit aliases: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно проверить |
|
ssh dictionary |
SSH. |
|
comfort_amount aliases: comfort-amount integer |
Объем данных, передаваемых за один раз для поддержания активности клиента |
|
comfort_interval aliases: comfort-interval integer |
Период между началом или последней передачей и следующей передачей данных для поддержания активности клиента |
|
explicit_ftp_tls aliases: explicit-ftp-tls string |
Явный FTP TLS. Варианты:
|
|
options list / elements=string |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize_limit aliases: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
scan_bzip2 aliases: scan-bzip2 string |
Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
ssl_offloaded aliases: ssl-offloaded string |
Расшифровка и шифрование SSL выполняются внешним устройством. Варианты:
|
|
stream_based_uncompressed_limit aliases: stream-based-uncompressed-limit integer |
Максимальный размер распакованных данных в потоке, подлежащих проверке |
|
tcp_window_maximum aliases: tcp-window-maximum integer |
Максимальный размер динамического окна TCP. |
|
tcp_window_minimum aliases: tcp-window-minimum integer |
Минимальный размер динамического окна TCP. |
|
tcp_window_size aliases: tcp-window-size integer |
Задать статический размер окна TCP. |
|
tcp_window_type aliases: tcp-window-type string |
Тип окна TCP для этого протокола. Варианты:
|
|
uncompressed_nest_limit aliases: uncompressed-nest-limit integer |
Максимальное число вложенных уровней сжатия, которые можно распаковать и проверить |
|
uncompressed_oversize_limit aliases: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно проверить |
|
switching_protocols_log aliases: switching-protocols-log string |
Включить или отключить ведение журнала для протоколов переключения HTTP/HTTPS. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых переопределяются условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, для которых переопределяются условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другие области, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 protocol options.
fortinet.fortimanager.fmgr_firewall_profileprotocoloptions:
bypass_validation: false
adom: ansible
state: present
firewall_profileprotocoloptions:
comment: "ansible-comment"
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 profile protocol options
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_profileprotocoloptions"
params:
adom: "ansible"
profile_protocol_options: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL-адрес запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_profileprotocoloptions_module.html