Модуль community.general.utm_ca_host_key_cert_info — Получение информации о записи ca host_key_cert в Sophos UTM

Примечание

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

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

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

Для использования в книге задач укажите: community.general.utm_ca_host_key_cert_info.

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

Описание

Получение информации о записи ca host_key_cert в Sophos UTM.

Параметры

Параметр	Комментарии
headers словарь	Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей. Значение по умолчанию: `{}`
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	Поддержка: полная добавлен в community.general 3.3.0 Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз статуса изменения без изменения целевого объекта.
diff_mode	Поддержка: отсутствует Это действие не изменяет состояние.	Возвращает подробности о том, что изменилось (или, возможно, нужно изменить в `check_mode`), когда используется режим сравнения.

Примеры

- name: Get info for a ca host_key_cert entry
  community.general.utm_ca_host_key_cert_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry

Значения возврата

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

Ключ	Описание
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_info_module.html