fortinet.fortimanager.fmgr_firewall_sslsshprofile – Настройка параметров протоколов SSL/SSH.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_sslsshprofile

Новое в версии 2.10: модуля fortinet.fortimanager

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

Описание

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation логический тип			Варианты: нет ← да	устанавливается в True только при расхождениях между схемой модуля и структурой API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_sslsshprofile словарь				установленные параметры верхнего уровня
	caname строка			Сертификат CA, используемый для SSL-инспекции.
	comment строка			Дополнительные комментарии.
	mapi-over-https строка		Варианты: отключить включить	Включить/отключить инспекцию MAPI через HTTPS.
	name строка			Имя.
	rpc-over-https строка		Варианты: отключить включить	Включить/отключить инспекцию RPC через HTTPS.
	server-cert строка			Сертификат, используемый для SSL-инспекции, для замены серверного сертификата.
	server-cert-mode строка		Варианты: переподписать заменить	Переподписать или заменить серверный сертификат.
	ssl-anomalies-log строка		Варианты: отключить включить	Включить/отключить протоколирование аномалий SSL.
	ssl-exempt список / элементы=строка			без описания
		address строка		Объект IPv4-адреса.
		address6 строка		Объект IPv6-адреса.
		fortiguard-category строка		Идентификатор категории FortiGuard.
		id целое число		Номер идентификатора.
		regex строка		Исключение серверов по регулярному выражению.
		type строка	Варианты: fortiguard-category address address6 wildcard-fqdn regex	Тип объекта адреса (IPv4 или IPv6) или категория FortiGuard.
		wildcard-fqdn строка		Исключение серверов по маске FQDN.
	ssl-exemptions-log строка		Варианты: отключить включить	Включить/отключить протоколирование исключений SSL.
	ssl-server список / элементы=строка			без описания
		ftps-client-cert-request строка	Варианты: пропустить проверить заблокировать	Действие на основе запроса клиента о сертификате во время рукопожатия FTPS.
		https-client-cert-request строка	Варианты: пропустить проверить заблокировать	Действие на основе запроса клиента о сертификате во время рукопожатия HTTPS.
		id целое число		Идентификатор SSL-сервера.
		imaps-client-cert-request строка	Варианты: пропустить проверить заблокировать	Действие на основе запроса клиента о сертификате во время рукопожатия IMAPS.
		ip строка		IPv4-адрес SSL-сервера.
		pop3s-client-cert-request строка	Варианты: пропустить проверить заблокировать	Действие на основе запроса клиента о сертификате во время рукопожатия POP3S.
		smtps-client-cert-request строка	Варианты: пропустить проверить заблокировать	Действие на основе запроса клиента о сертификате во время рукопожатия SMTPS.
		ssl-other-client-cert-request строка	Варианты: пропустить проверить заблокировать	Действие на основе запроса клиента о сертификате во время рукопожатия SSL-протокола.
	untrusted-caname строка			Ненадёжный сертификат CA, используемый для SSL-инспекции.
	use-ssl-server строка		Варианты: отключить включить	Включить/отключить использование таблицы SSL-серверов для SSL-offloading.
	whitelist строка		Варианты: отключить включить	Включить/отключить исключение серверов с помощью белого списка FortiGuard.
rc_failed список / элементы=строка				Список кодов rc, при которых условия будут нарушены.
rc_succeeded список / элементы=строка				Список кодов rc, при которых условия будут выполнены.
state строка / обязательно			Варианты: present absent	Директива для создания, обновления или удаления объекта.
workspace_locking_adom строка				adom для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным или другим, включая корень.
workspace_locking_timeout целое число			По умолчанию: 300	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем.

Примечания

Примечание

Поддержка работы в режиме блокировки рабочего пространства в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этой задаче.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Можно также переопределить условия для завершения ошибкой или успешным завершением с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure SSL/SSH protocol options.
     fmgr_firewall_sslsshprofile:
        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>
        state: <value in [present, absent]>
        firewall_sslsshprofile:
           caname: <value of string>
           comment: <value of string>
           mapi-over-https: <value in [disable, enable]>
           name: <value of string>
           rpc-over-https: <value in [disable, enable]>
           server-cert: <value of string>
           server-cert-mode: <value in [re-sign, replace]>
           ssl-anomalies-log: <value in [disable, enable]>
           ssl-exempt:
             -
                 address: <value of string>
                 address6: <value of string>
                 fortiguard-category: <value of string>
                 id: <value of integer>
                 regex: <value of string>
                 type: <value in [fortiguard-category, address, address6, ...]>
                 wildcard-fqdn: <value of string>
           ssl-exemptions-log: <value in [disable, enable]>
           ssl-server:
             -
                 ftps-client-cert-request: <value in [bypass, inspect, block]>
                 https-client-cert-request: <value in [bypass, inspect, block]>
                 id: <value of integer>
                 imaps-client-cert-request: <value in [bypass, inspect, block]>
                 ip: <value of string>
                 pop3s-client-cert-request: <value in [bypass, inspect, block]>
                 smtps-client-cert-request: <value in [bypass, inspect, block]>
                 ssl-other-client-cert-request: <value in [bypass, inspect, block]>
           untrusted-caname: <value of string>
           use-ssl-server: <value in [disable, enable]>
           whitelist: <value in [disable, enable]>

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

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный URL запроса Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_sslsshprofile_module.html