utm_ca_host_key_cert – создание, обновление или удаление записи ca host_key_cert в Sophos UTM

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

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

Описание

Создание, обновление или удаление записи ca host_key_cert в SOPHOS UTM.
Для работы данного модуля необходима активированная возможность REST API UTM.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ca - / обязательно		Ссылка на существующий объект utm_ca_signing_ca или utm_ca_verification_ca.
certificate - / обязательно		Сертификат в формате PEM.
comment -		Необязательная строка комментария.
encrypted boolean	Варианты: нет ← да	Включение шифрования по желанию.
headers dictionary		Словарь дополнительных заголовков для отправки запросов POST и PUT. Необходим для некоторых модулей.
key -		Необязательный закрытый ключ в формате PEM.
meta - / обязательно		Ссылка на существующий объект utm_ca_meta_x509.
name - / обязательно		Имя объекта. Будет использоваться для идентификации записи.
state string	Варианты: отсутствует присутствует ←	Желаемое состояние объекта. `present` создаст или обновит объект. `absent` удалит объект, если он был присутствующим.
utm_host string / обязательно		REST-точку входа Sophos UTM.
utm_port integer	По умолчанию: 4444	Порт REST-интерфейса.
utm_protocol string	Варианты: http https ←	Протокол REST-точки входа.
utm_token string / обязательно		Токен, используемый для идентификации в REST-API. См. https://www.sophos.com/ru-ru/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=ru, Глава 2.4.2.
validate_certs boolean	Варианты: нет да ←	Необходимо ли проверять SSL-сертификат REST-интерфейса.

Примеры

# Create a ca_host_key_cert entry
- name: utm ca_host_key_cert
  utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    ca: REF_ca/signing_ca_OBJECT_STRING
    meta: REF_ca/meta_x509_OBJECT_STRING
    certificate: |
      --- BEGIN CERTIFICATE ---
      . . .
       . . .
      . . .
      --- END CERTIFICATE ---
    state: present

# Remove a ca_host_key_cert entry
- name: utm ca_host_key_cert
  utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    state: absent

# Read a ca_host_key_cert entry
- name: utm ca_host_key_cert
  utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    state: info

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

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

Ключ		Возвращено	Описание
result complex		success	Объект utm, который был создан
	_locked boolean		Заблокирован ли объект в данный момент
	_ref string		Имя ссылки объекта
	_type string		Тип объекта
	ca string		Ссылка на существующий объект utm_ca_signing_ca или utm_ca_verification_ca.
	certificate string		Сертификат в формате PEM
	comment string		Строка комментария (может быть пустой строкой)
	encrypted boolean		Если включено шифрование
	key string		Приватный ключ в формате PEM (может быть пустой строкой)
	meta string		Ссылка на существующий объект utm_ca_meta_x509.
	name string		Название объекта

Статус

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

Авторы

Stephan Schwarz (@stearz)

Подсказка

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

© 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/utm_ca_host_key_cert_module.html