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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логический тип	Устанавливается в значение True только при несовпадении схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логический тип	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_profileprotocoloptions_ssh словарь	Настройка параметров верхнего уровня.
comfort_amount целое число	Устарело, пожалуйста, переименуйте на comfort_amount. Количество данных, отправляемых в передаче для подтверждения клиента
comfort_interval целое число	Устарело, пожалуйста, переименуйте на comfort_interval. Период времени между началом или последней передачей и следующей передачей для клиента...
options список / элементы=строка	Один или несколько параметров, которые можно применить к сеансу. Варианты: `"oversize"` `"clientcomfort"` `"servercomfort"`
oversize_limit целое число	Устарело, пожалуйста, переименуйте на oversize_limit. Максимальный размер файла в оперативной памяти, который можно сканировать
scan_bzip2 строка	Устарело, пожалуйста, переименуйте на scan_bzip2. Включение/выключение сканирования файлов, сжатых в формате BZip2. Варианты: `"disable"` `"enable"`
ssl_offloaded строка	Устарело, пожалуйста, переименуйте на ssl_offloaded. Расшифровка и шифрование SSL выполняются внешним устройством. Варианты: `"no"` `"yes"`
stream_based_uncompressed_limit целое число	Устарело, пожалуйста, переименуйте на stream_based_uncompressed_limit. Максимальный размер несжатых данных, основанных на потоках, который будет...
tcp_window_maximum целое число	Устарело, пожалуйста, переименуйте на tcp_window_maximum. Максимальный динамический размер окна TCP.
tcp_window_minimum целое число	Устарело, пожалуйста, переименуйте на tcp_window_minimum. Минимальный динамический размер окна TCP.
tcp_window_size целое число	Устарело, пожалуйста, переименуйте на tcp_window_size. Установка статического размера окна TCP.
tcp_window_type строка	Устарело, пожалуйста, переименуйте на tcp_window_type. Тип окна TCP для использования в этом протоколе. Варианты: `"system"` `"static"` `"dynamic"` `"auto-tuning"`
uncompressed_nest_limit целое число	Устарело, пожалуйста, переименуйте на uncompressed_nest_limit. Максимальное количество вложенных уровней сжатия, которое может быть распаковано и...
uncompressed_oversize_limit целое число	Устарело, пожалуйста, переименуйте на uncompressed_oversize_limit. Максимальный размер несжатого файла в оперативной памяти, который можно сканировать
forticloud_access_token строка	Авторизация клиента 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 список / элементы=целое число	Список кодов rc, при которых условия будут нарушены.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут выполнены.
workspace_locking_adom строка	ADOM для блокировки в режиме работы в рабочей области FortiManager, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure SFTP and SCP protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ssh:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        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, ...]>

Значения возврата

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

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