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

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать её в playbook, укажите: 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 булево	Необязательно включить шифрование. Варианты: `false` ← (по умолчанию) `true`
headers словарь	Словарь дополнительных заголовков, которые будут отправлены в запросах POST и PUT. Необходимо для некоторых модулей. По умолчанию: `{}`
key строка	Необязательный закрытый ключ в формате PEM.
meta строка / обязательно	Ссылка на существующий объект utm_ca_meta_x509.
name строка / обязательно	Имя объекта. Будет использоваться для идентификации записи.
state строка	Требуемое состояние объекта. `present` создаст или обновит объект. `absent` удалит объект, если он присутствовал. Варианты: `"absent"` `"present"` ← (по умолчанию)
utm_host строка / обязательно	REST-точка доступа Sophos UTM.
utm_port целое число	Порт REST-интерфейса. По умолчанию: `4444`
utm_protocol строка	Протокол REST-точки доступа. Варианты: `"http"` `"https"` ← (по умолчанию)
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-интерфейса или нет. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Может работать в режиме `check_mode` и возвращать прогноз состояния "изменено" без изменения цели.
diff_mode	Поддержка: отсутствует	В режиме diff будет возвращать детали о том, что изменилось (или что, возможно, нужно изменить в `check_mode`).

Примеры

- 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, который был создан Возвращено: success
_locked логический	Заблокирован ли объект в настоящее время Возвращено: success
_ref строка	Имя ссылки на объект Возвращено: success
_type строка	Тип объекта Возвращено: success
ca строка	Ссылка на существующий объект utm_ca_signing_ca или utm_ca_verification_ca. Возвращено: success
certificate строка	Сертификат в формате PEM Возвращено: success
comment строка	Строка комментария (может быть пустой строкой) Возвращено: success
encrypted логический	Если включена шифровка Возвращено: success
key строка	Приватный ключ в формате PEM (может быть пустой строкой) Возвращено: success
meta строка	Ссылка на существующий объект utm_ca_meta_x509. Возвращено: success
name строка	Имя объекта Возвращено: success

Авторы

Stephan Schwarz (@stearz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/utm_ca_host_key_cert_module.html