fortios_firewall_ssl_ssh_profile – Настройка параметров протоколов SSL/SSH в FortiOS и FortiGate Fortinet

Новая версия с 2.8.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры брандмауэра и категорию ssl_ssh_profile. Примеры включают все параметры и значения, которые нужно скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.5

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

fortiosapi>=0.9.8

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
firewall_ssl_ssh_profile dictionary			Значение по умолчанию: null	Настройка параметров протоколов SSL/SSH.
	caname string			Сертификат центра сертификации, используемый проверкой SSL. Источник vpn.certificate.local.name.
	comment string			Необязательные комментарии.
	ftps dictionary			Настройка параметров FTPS.
		allow_invalid_server_cert string	Варианты: enable disable	При включении разрешает сеансы SSL, проверка сертификата сервера для которых завершилась неудачей.
		client_cert_request string	Варианты: bypass inspect block	Действие на основе запроса клиентского сертификата.
		ports integer		Порты для сканирования (1 - 65535).
		status string	Варианты: disable deep-inspection	Настройка состояния проверки протокола.
		unsupported_ssl string	Варианты: bypass inspect block	Действие на основе используемого шифрования SSL, которое не поддерживается.
		untrusted_cert string	Варианты: allow block ignore	Разрешить, игнорировать или блокировать недоверенный серверный сертификат сеанса SSL.
	https dictionary			Настройка параметров HTTPS.
		allow_invalid_server_cert string	Варианты: enable disable	При включении разрешает сеансы SSL, проверка сертификата сервера для которых завершилась неудачей.
		client_cert_request string	Варианты: bypass inspect block	Действие на основе запроса клиентского сертификата.
		ports integer		Порты для сканирования (1 - 65535).
		status string	Варианты: disable certificate-inspection deep-inspection	Настройка состояния проверки протокола.
		unsupported_ssl string	Варианты: bypass inspect block	Действие на основе используемого шифрования SSL, которое не поддерживается.
		untrusted_cert string	Варианты: allow block ignore	Разрешить, игнорировать или блокировать недоверенный серверный сертификат сеанса SSL.
	imaps dictionary			Настройка параметров IMAPS.
		allow_invalid_server_cert string	Варианты: enable disable	При включении разрешает сеансы SSL, проверка сертификата сервера для которых завершилась неудачей.
		client_cert_request string	Варианты: bypass inspect block	Действие на основе запроса клиентского сертификата.
		ports integer		Порты для сканирования (1 - 65535).
		status string	Варианты: disable deep-inspection	Настройка состояния проверки протокола.
		unsupported_ssl string	Варианты: bypass inspect block	Действие на основе используемого шифрования SSL, которое не поддерживается.
		untrusted_cert string	Варианты: allow block ignore	Разрешить, игнорировать или блокировать недоверенный серверный сертификат сеанса SSL.
	mapi_over_https string		Варианты: enable disable	Включить/выключить проверку MAPI через HTTPS.
	name string / required			Имя.
	pop3s dictionary			Настройка параметров POP3S.
		allow_invalid_server_cert string	Варианты: enable disable	При включении разрешает сеансы SSL, проверка сертификата сервера для которых завершилась неудачей.
		client_cert_request string	Варианты: bypass inspect block	Действие на основе запроса клиентского сертификата.
		ports integer		Порты для сканирования (1 - 65535).
		status string	Варианты: disable deep-inspection	Настройка состояния проверки протокола.
		unsupported_ssl string	Варианты: bypass inspect block	Действие на основе используемого шифрования SSL, которое не поддерживается.
		untrusted_cert string	Варианты: allow block ignore	Разрешить, игнорировать или блокировать недоверенный серверный сертификат сеанса SSL.
	rpc_over_https string		Варианты: enable disable	Включить/выключить проверку RPC через HTTPS.

server_cert string			Сертификат, используемый SSL-инспекцией для замены серверного сертификата. Источник vpn.certificate.local.name.
server_cert_mode string		Варианты: re-sign replace	Переподписывание или замена сертификата сервера.
smtps dictionary			Настройка параметров SMTPS.
	allow_invalid_server_cert string	Варианты: enable disable	При включении разрешает SSL-сессии, в которых проверка серверного сертификата завершилась с ошибкой.
	client_cert_request string	Варианты: bypass inspect block	Действие, основанное на запросе клиента о сертификате.
	ports integer		Порты для сканирования (1 - 65535).
	status string	Варианты: disable deep-inspection	Настройка статуса инспекции протокола.
	unsupported_ssl string	Варианты: bypass inspect block	Действие, основанное на том, что используемое SSL-шифрование не поддерживается.
	untrusted_cert string	Варианты: allow block ignore	Разрешить, игнорировать или заблокировать серверный сертификат недоверенной SSL-сессии.
ssh dictionary			Настройка параметров SSH.
	inspect_all string	Варианты: disable deep-inspection	Уровень SSL-инспекции.
	ports integer		Порты для сканирования (1 - 65535).
	ssh_algorithm string	Варианты: compatible high-encryption	Относительная сила алгоритмов шифрования, принимаемых во время переговоров.
	ssh_policy_check string	Варианты: disable enable	Включить/выключить проверку политики SSH.
	ssh_tun_policy_check string	Варианты: disable enable	Включить/выключить проверку политики SSH-туннеля.
	status string	Варианты: disable deep-inspection	Настройка статуса инспекции протокола.
	unsupported_version string	Варианты: bypass block	Действие, основанное на том, что версия SSH не поддерживается.
ssl dictionary			Настройка параметров SSL.
	allow_invalid_server_cert string	Варианты: enable disable	При включении разрешает SSL-сессии, в которых проверка серверного сертификата завершилась с ошибкой.
	client_cert_request string	Варианты: bypass inspect block	Действие, основанное на запросе клиента о сертификате.
	inspect_all string	Варианты: disable certificate-inspection deep-inspection	Уровень SSL-инспекции.
	unsupported_ssl string	Варианты: bypass inspect block	Действие, основанное на том, что используемое SSL-шифрование не поддерживается.
	untrusted_cert string	Варианты: allow block ignore	Разрешить, заблокировать или проигнорировать серверный сертификат недоверенной SSL-сессии.
ssl_anomalies_log string		Варианты: disable enable	Включить/выключить протоколирование аномалий SSL.
ssl_exempt list			Серверы, исключенные из SSL-инспекции.
	address string		Объект IPv4-адреса. Источник firewall.address.name firewall.addrgrp.name.
	address6 string		Объект IPv6-адреса. Источник firewall.address6.name firewall.addrgrp6.name.
	fortiguard_category integer		Идентификатор категории FortiGuard.
	id integer / обязательно		Номер идентификатора.
	regex string		Исключить серверы по регулярному выражению.
	type string	Варианты: fortiguard-category address address6 wildcard-fqdn regex	Тип объекта адреса (IPv4 или IPv6) или категория FortiGuard.
	wildcard_fqdn string		Исключить серверы по маске FQDN. Источник firewall.wildcard-fqdn.custom.name firewall.wildcard-fqdn.group.name.
ssl_exemptions_log string		Варианты: disable enable	Включить/выключить протоколирование исключений SSL.
ssl_server list			SSL-серверы.

		ftps_client_cert_request строка	Варианты: bypass inspect block	Действие, выполняемое при запросе клиентом сертификата во время рукопожатия FTPS.
		https_client_cert_request строка	Варианты: bypass inspect block	Действие, выполняемое при запросе клиентом сертификата во время рукопожатия HTTPS.
		id целое число / обязательно		Идентификатор SSL-сервера.
		imaps_client_cert_request строка	Варианты: bypass inspect block	Действие, выполняемое при запросе клиентом сертификата во время рукопожатия IMAPS.
		ip строка		IPv4-адрес SSL-сервера.
		pop3s_client_cert_request строка	Варианты: bypass inspect block	Действие, выполняемое при запросе клиентом сертификата во время рукопожатия POP3S.
		smtps_client_cert_request строка	Варианты: bypass inspect block	Действие, выполняемое при запросе клиентом сертификата во время рукопожатия SMTPS.
		ssl_other_client_cert_request строка	Варианты: bypass inspect block	Действие, выполняемое при запросе клиентом сертификата во время рукопожатия протокола SSL.
	state строка		Варианты: present absent	Устарело Начиная с Ansible 2.9, рекомендуется использовать параметр «state» на верхнем уровне. Указывает, нужно ли создать или удалить объект.
	untrusted_caname строка			Ненадёжный сертификат CA, используемый SSL-инспекцией. Источник vpn.certificate.local.name.
	use_ssl_server строка		Варианты: disable enable	Включить/выключить использование таблицы SSL-сервера для SSL-offloading.
	whitelist строка		Варианты: enable disable	Включить/выключить исключение серверов с помощью списка разрешённых серверов FortiGuard.
host строка				IP-адрес FortiOS или FortiGate.
https булево			Варианты: no да ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password строка			По умолчанию: ""	Пароль FortiOS или FortiGate.
ssl_verify булево добавлен в 2.9			Варианты: no да ←	Обеспечивает проверку сертификата FortiGate надёжным центром сертификации.
state строка добавлен в 2.9			Варианты: present absent	Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перенесён на внешний уровень.
username строка				Имя пользователя FortiOS или FortiGate.
vdom строка			По умолчанию: "root"	Виртуальная область, определённая ранее. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельную единицу.

Примечания

Примечание

Требуется библиотека fortiosapi, разработанная Fortinet
Запускать как локальное действие в вашем плане выполнения

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure SSL/SSH protocol options.
    fortios_firewall_ssl_ssh_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      firewall_ssl_ssh_profile:
        caname: "<your_own_value> (source vpn.certificate.local.name)"
        comment: "Optional comments."
        ftps:
            allow_invalid_server_cert: "enable"
            client_cert_request: "bypass"
            ports: "8"
            status: "disable"
            unsupported_ssl: "bypass"
            untrusted_cert: "allow"
        https:
            allow_invalid_server_cert: "enable"
            client_cert_request: "bypass"
            ports: "15"
            status: "disable"
            unsupported_ssl: "bypass"
            untrusted_cert: "allow"
        imaps:
            allow_invalid_server_cert: "enable"
            client_cert_request: "bypass"
            ports: "22"
            status: "disable"
            unsupported_ssl: "bypass"
            untrusted_cert: "allow"
        mapi_over_https: "enable"
        name: "default_name_27"
        pop3s:
            allow_invalid_server_cert: "enable"
            client_cert_request: "bypass"
            ports: "31"
            status: "disable"
            unsupported_ssl: "bypass"
            untrusted_cert: "allow"
        rpc_over_https: "enable"
        server_cert: "<your_own_value> (source vpn.certificate.local.name)"
        server_cert_mode: "re-sign"
        smtps:
            allow_invalid_server_cert: "enable"
            client_cert_request: "bypass"
            ports: "41"
            status: "disable"
            unsupported_ssl: "bypass"
            untrusted_cert: "allow"
        ssh:
            inspect_all: "disable"
            ports: "47"
            ssh_algorithm: "compatible"
            ssh_policy_check: "disable"
            ssh_tun_policy_check: "disable"
            status: "disable"
            unsupported_version: "bypass"
        ssl:
            allow_invalid_server_cert: "enable"
            client_cert_request: "bypass"
            inspect_all: "disable"
            unsupported_ssl: "bypass"
            untrusted_cert: "allow"
        ssl_anomalies_log: "disable"
        ssl_exempt:
         -
            address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
            address6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
            fortiguard_category: "63"
            id:  "64"
            regex: "<your_own_value>"
            type: "fortiguard-category"
            wildcard_fqdn: "<your_own_value> (source firewall.wildcard-fqdn.custom.name firewall.wildcard-fqdn.group.name)"
        ssl_exemptions_log: "disable"
        ssl_server:
         -
            ftps_client_cert_request: "bypass"
            https_client_cert_request: "bypass"
            id:  "72"
            imaps_client_cert_request: "bypass"
            ip: "<your_own_value>"
            pop3s_client_cert_request: "bypass"
            smtps_client_cert_request: "bypass"
            ssl_other_client_cert_request: "bypass"
        untrusted_caname: "<your_own_value> (source vpn.certificate.local.name)"
        use_ssl_server: "disable"
        whitelist: "enable"

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

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

Ключ	Возвращаемое	Описание
build строка	всегда	Номер сборки образа fortigate Пример: 1547
http_method строка	всегда	Последний метод, использованный для размещения содержимого в FortiGate Пример: PUT
http_status строка	всегда	Последний результат, полученный от FortiGate после последней операции Пример: 200
mkey строка	успех	Главный ключ (id), используемый в последнем вызове FortiGate Пример: id
name строка	всегда	Имя таблицы, использованной для выполнения запроса Пример: urlfilter
path строка	всегда	Путь к таблице, использованной для выполнения запроса Пример: webfilter
revision строка	всегда	Внутренний номер ревизии Пример: 17.0.2.10658
serial строка	всегда	Серийный номер устройства Пример: FGVMEVYYQT3AB5352
status строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Использованная виртуальная область Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_firewall_ssl_ssh_profile_module.html