Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_firewall_sslsshprofile_smtps — настройка параметров SMTPS.

Примечание

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

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

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

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

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

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

Описание

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

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

строка / обязательный

Параметр (adom) в запрашиваемом URL.

bypass_validation

логический

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

логический

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

Варианты:

  • false ← (по умолчанию)
  • true

firewall_sslsshprofile_smtps

словарь

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

allow_invalid_server_cert

псевдонимы: allow-invalid-server-cert

строка

Если параметр включен, разрешаются SSL-сеансы, проверка сертификата сервера которых завершилась ошибкой.

Варианты:

  • "disable"
  • "enable"

cert_validation_failure

псевдонимы: cert-validation-failure

строка

Действие при ошибке проверки сертификата.

Варианты:

  • "allow"
  • "block"
  • "ignore"

cert_validation_timeout

псевдонимы: cert-validation-timeout

строка

Действие при превышении времени ожидания проверки сертификата.

Варианты:

  • "allow"
  • "block"
  • "ignore"

client_cert_request

псевдонимы: client-cert-request

строка

Действие при запросе сертификата клиента.

Варианты:

  • "bypass"
  • "inspect"
  • "block"

client_certificate

псевдонимы: client-certificate

строка

Действие на основании полученного сертификата клиента.

Варианты:

  • "bypass"
  • "inspect"
  • "block"
  • "bypass-on-cert-req"

expired_server_cert

псевдонимы: expired-server-cert

строка

Действие при истечении срока действия сертификата сервера.

Варианты:

  • "allow"
  • "block"
  • "ignore"

invalid_server_cert

псевдонимы: invalid-server-cert

строка

Разрешить или блокировать SSL-сеанс с недействительным сертификатом сервера.

Варианты:

  • "allow"
  • "block"

min_allowed_ssl_version

псевдонимы: min-allowed-ssl-version

строка

Минимальная разрешенная версия SSL.

Варианты:

  • "ssl-3.0"
  • "tls-1.0"
  • "tls-1.1"
  • "tls-1.2"
  • "tls-1.3"

ports

любой тип

(список) Порты для сканирования

proxy_after_tcp_handshake

псевдонимы: proxy-after-tcp-handshake

строка

Проксировать трафик после установления трехэтапного рукопожатия TCP

Варианты:

  • "disable"
  • "enable"

revoked_server_cert

псевдонимы: revoked-server-cert

строка

Действие при отзыве сертификата сервера.

Варианты:

  • "allow"
  • "block"
  • "ignore"

sni_server_cert_check

псевдонимы: sni-server-cert-check

строка

Проверять SNI в сообщении ClientHello по полям CN или SAN в полученном сертификате сервера.

Варианты:

  • "disable"
  • "enable"
  • "strict"

status

строка

Настройка состояния проверки протокола.

Варианты:

  • "disable"
  • "deep-inspection"

unsupported_ssl

псевдонимы: unsupported-ssl

строка

Действие, если используется неподдерживаемое SSL-шифрование.

Варианты:

  • "bypass"
  • "inspect"
  • "block"

unsupported_ssl_cipher

псевдонимы: unsupported-ssl-cipher

строка

Действие, если используется неподдерживаемый алгоритм шифрования SSL.

Варианты:

  • "allow"
  • "block"

unsupported_ssl_negotiation

псевдонимы: unsupported-ssl-negotiation

строка

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

Варианты:

  • "allow"
  • "block"

unsupported_ssl_version

псевдонимы: unsupported-ssl-version

строка

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

Варианты:

  • "block"
  • "allow"
  • "inspect"

untrusted_cert

псевдонимы: untrusted-cert

строка

Разрешить, игнорировать или блокировать SSL-сеанс с недоверенным сертификатом сервера.

Варианты:

  • "allow"
  • "block"
  • "ignore"

untrusted_server_cert

псевдонимы: untrusted-server-cert

строка

Разрешить, игнорировать или блокировать SSL-сеанс с недоверенным сертификатом сервера.

Варианты:

  • "allow"
  • "block"
  • "ignore"

forticloud_access_token

строка

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

proposed_method

строка

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

Варианты:

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

rc_failed

список / элементы=целое число

Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.

rc_succeeded

список / элементы=целое число

Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.

revision_note

строка

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

ssl-ssh-profile

строка

Устарел, используйте “ssl_ssh_profile”

ssl_ssh_profile

строка

Параметр (ssl-ssh-profile) в запрашиваемом URL.

workspace_locking_adom

строка

ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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
  gather_facts: false
  tasks:
    - name: Configure SMTPS options.
      fortinet.fortimanager.fmgr_firewall_sslsshprofile_smtps:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        ssl_ssh_profile: <your own value>
        firewall_sslsshprofile_smtps:
          # allow_invalid_server_cert: <value in [disable, enable]>
          # client_cert_request: <value in [bypass, inspect, block]>
          # ports: <list or integer>
          # status: <value in [disable, deep-inspection]>
          # unsupported_ssl: <value in [bypass, inspect, block]>
          # untrusted_cert: <value in [allow, block, ignore]>
          # invalid_server_cert: <value in [allow, block]>
          # sni_server_cert_check: <value in [disable, enable, strict]>
          # untrusted_server_cert: <value in [allow, block, ignore]>
          # cert_validation_failure: <value in [allow, block, ignore]>
          # cert_validation_timeout: <value in [allow, block, ignore]>
          # client_certificate: <value in [bypass, inspect, block, ...]>
          # expired_server_cert: <value in [allow, block, ignore]>
          # proxy_after_tcp_handshake: <value in [disable, enable]>
          # revoked_server_cert: <value in [allow, block, ignore]>
          # unsupported_ssl_cipher: <value in [allow, block]>
          # unsupported_ssl_negotiation: <value in [allow, block]>
          # unsupported_ssl_version: <value in [block, allow, inspect]>
          # min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>

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

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

Ключ

Описание

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–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_sslsshprofile_smtps_module.html

Spec-Zone.ru

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