Модуль fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ssh — настройка параметров протоколов SFTP и SCP.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в fortinet.fortimanager 2.1.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_profileprotocoloptions_ssh dictionary	Заданные параметры верхнего уровня.
comfort_amount псевдонимы: comfort-amount integer	Объём данных, отправляемых за одну передачу для поддержания активности клиента
comfort_interval псевдонимы: comfort-interval integer	Период времени между началом или последней передачей и следующей передачей данных для поддержания активности клиента
explicit_ftp_tls псевдонимы: explicit-ftp-tls string	Явный FTP TLS. Варианты: `"disable"` `"enable"`
options list / элементы=string	Один или несколько параметров, которые можно применить к сеансу. Варианты: `"oversize"` `"clientcomfort"` `"servercomfort"`
oversize_limit псевдонимы: oversize-limit integer	Максимальный размер файла в памяти, который можно проверить
scan_bzip2 псевдонимы: scan-bzip2 string	Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты: `"disable"` `"enable"`
ssl_offloaded псевдонимы: ssl-offloaded string	Расшифровка и шифрование SSL выполняются внешним устройством. Варианты: `"no"` `"yes"`
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, используемый для этого протокола. Варианты: `"system"` `"static"` `"dynamic"` `"auto-tuning"`
uncompressed_nest_limit псевдонимы: uncompressed-nest-limit integer	Максимальное количество вложенных уровней сжатия, которые можно распаковать и проверить
uncompressed_oversize_limit псевдонимы: uncompressed-oversize-limit integer	Максимальный размер распакованного файла в памяти, который можно проверить
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
profile-protocol-options string	Устарел, используйте «profile_protocol_options»
profile_protocol_options string	Параметр (profile-protocol-options) в запрашиваемом URL.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия завершения с ошибкой.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного завершения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure SFTP and SCP protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ssh:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile_protocol_options: <your own value>
        firewall_profileprotocoloptions_ssh:
          # comfort_amount: <integer>
          # comfort_interval: <integer>
          # options: ["oversize", "clientcomfort", "servercomfort"]
          # oversize_limit: <integer>
          # scan_bzip2: <value in [disable, enable]>
          # uncompressed_nest_limit: <integer>
          # uncompressed_oversize_limit: <integer>
          # ssl_offloaded: <value in [no, yes]>
          # stream_based_uncompressed_limit: <integer>
          # tcp_window_maximum: <integer>
          # tcp_window_minimum: <integer>
          # tcp_window_size: <integer>
          # tcp_window_type: <value in [system, static, dynamic, ...]>
          # explicit_ftp_tls: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса к API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=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_profileprotocoloptions_ssh_module.html