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

Примечание

Этот плагин является частью коллекции community.general (версия 1.3.2).

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

Для использования в плейбуке укажите: community.general.utm_ca_host_key_cert.

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ca строка / обязательно		Ссылка на существующий объект utm_ca_signing_ca или utm_ca_verification_ca.
certificate строка / обязательно		Сертификат в формате PEM.
comment строка		Необязательная строка комментария.
encrypted логическое значение	Варианты: нет ← да	Необязательно включить шифрование.
headers словарь		Словарь дополнительных заголовков, которые будут отправлены в запросах POST и PUT. Необходим для некоторых модулей
key строка		Необязательный закрытый ключ в формате PEM.
meta строка / обязательно		Ссылка на существующий объект utm_ca_meta_x509.
name строка / обязательно		Имя объекта. Будет использоваться для идентификации записи.
state строка	Варианты: absent present ←	Желаемое состояние объекта. `present` создаст или обновит объект `absent` удалит объект, если он был present
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 логическое значение	Варианты: нет да ←	Должен ли быть проверен сертификат SSL REST интерфейса.

Примеры

- name: Create a ca_host_key_cert entry
  community.general.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

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

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

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

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

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

Авторы

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.10/collections/community/general/utm_ca_host_key_cert_module.html