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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ca - / обязательно		Ссылка на существующий объект utm_ca_signing_ca или utm_ca_verification_ca.
certificate - / обязательно		Сертификат в формате PEM.
comment -		Дополнительная строка комментария (необязательно).
encrypted boolean	Варианты: нет ← да	Включить шифрование (необязательно).
headers словарь		Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей
key -		Дополнительный закрытый ключ в формате PEM (необязательно).
meta - / обязательно		Ссылка на существующий объект utm_ca_meta_x509.
name - / обязательно		Имя объекта. Будет использоваться для идентификации записи.
state строка	Варианты: отсутствует присутствует ←	Желаемое состояние объекта. `present` будет создавать или обновлять объект. `absent` будет удалять объект, если он присутствовал.
utm_host строка / обязательно		REST-точка входа Sophos UTM.
utm_port целое число	Значение по умолчанию: 4444	Порт REST-интерфейса.
utm_protocol строка	Варианты: http https ←	Протокол REST-точки входа.
utm_token строка / обязательно		Токен для идентификации в REST-API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, глава 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 сложный		успешно	Созданный объект utm.
	_locked boolean		Заблокирован ли объект в данный момент.
	_ref строка		Имя ссылки объекта.
	_type строка		Тип объекта.
	ca строка		Ссылка на существующий объект utm_ca_signing_ca или utm_ca_verification_ca.
	certificate строка		Сертификат в формате PEM.
	comment строка		Строка комментария (может быть пустой строкой).
	encrypted boolean		Включено ли шифрование.
	key строка		Закрытый ключ в формате PEM (может быть пустой строкой).
	meta строка		Ссылка на существующий объект utm_ca_meta_x509.
	name строка		Имя объекта.

Статус

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

Авторы

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