community.general.utm_ca_host_key_cert_info – Получение информации о записи ca host_key_cert в Sophos UTM
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: 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 удалит объект, если он был присутствовал. |
| utm_host строка / обязательно | REST-адрес Sophos UTM. | |
| utm_port целое число | Значение по умолчанию: 4444 | Порт REST-интерфейса. |
| utm_protocol строка |
| Протокол 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: 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. | |
| _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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/utm_ca_host_key_cert_info_module.html