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

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: community.general.utm_ca_host_key_cert.

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

Краткое описание

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

Параметры

Параметр	Комментарии
ca string / обязательный	Ссылка на существующий объект utm_ca_signing_ca или utm_ca_verification_ca.
certificate string / обязательный	Сертификат в формате PEM.
comment string	Необязательная строка комментария.
encrypted boolean	При необходимости включить шифрование. Варианты: `false` ← (по умолчанию) `true`
headers dictionary	Словарь дополнительных заголовков, которые будут передаваться в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: `{}`
key string	Необязательный закрытый ключ в формате PEM.
meta string / обязательный	Ссылка на существующий объект utm_ca_meta_x509.
name string / обязательный	Имя объекта, идентифицирующее запись.
state string	Требуемое состояние объекта. `present` создает или обновляет объект. `absent` удаляет объект, если он существует. Варианты: `"absent"` `"present"` ← (по умолчанию)
utm_host string / обязательный	Конечная точка REST Sophos UTM.
utm_port integer	Порт интерфейса REST. По умолчанию: `4444`
utm_protocol string	Протокол конечной точки REST. Варианты: `"http"` `"https"` ← (по умолчанию)
utm_token string / обязательный	Токен для идентификации в 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. Варианты: `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 complex	Созданный объект utm. Возвращается: при успешном выполнении
_locked boolean	Заблокирован ли объект в данный момент. Возвращается: при успешном выполнении
_ref string	Имя ссылки на объект. Возвращается: при успешном выполнении
_type string	Тип объекта. Возвращается: при успешном выполнении
ca string	Ссылка на существующий объект utm_ca_signing_ca или utm_ca_verification_ca. Возвращается: при успешном выполнении
certificate string	Сертификат в формате PEM. Возвращается: при успешном выполнении
comment string	Строка комментария (может быть пустой). Возвращается: при успешном выполнении
encrypted boolean	Включено ли шифрование. Возвращается: при успешном выполнении
key string	Закрытый ключ в формате PEM (может быть пустой строкой). Возвращается: при успешном выполнении
meta string	Ссылка на существующий объект utm_ca_meta_x509. Возвращается: при успешном выполнении
name string	Имя объекта. Возвращается: при успешном выполнении

Авторы

Stephan Schwarz (@stearz)

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

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