Spec-Zone.ru › Ansible

community.crypto.ecs_domain модуль – Проверка запроса домена с использованием API Entrust Certificate Services (ECS)

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.crypto. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.crypto.ecs_domain.

Новое в community.crypto 1.0.0

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

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

  • Запрос проверки или повторной проверки домена с использованием API Entrust Certificate Services (ECS).
  • Требуются учетные данные для API Entrust Certificate Services (ECS).
  • Если домен уже находится в процессе проверки, новый запрос на проверку не будет отправлен, но данные проверки (если применимо) будут возвращены.
  • Если домен уже находится в процессе проверки, но указанный verification_method отличается от текущего verification_method, verification_method будет обновлен, и данные проверки (если применимо) будут возвращены.
  • Если домен является активным, проверенным доменом, возвращаемое значение changed будет false, если только domain_status=EXPIRED, в этом случае будет выполнена повторная проверка.
  • Если verification_method=dns, подробная информация о необходимой записи DNS будет указана в возвращаемых параметрах dns_contents, dns_location и dns_resource_type.
  • Если verification_method=web_server, подробная информация о необходимых файлах будет указана в возвращаемых параметрах file_contents и file_location.
  • Если verification_method=email, адрес(а) электронной почты, на которые были отправлены письма с подтверждением, будут указаны в возвращаемом параметре emails. Это чисто информационное сообщение. Для доменов, запрошенных с помощью этого модуля, это всегда будет список размером 1.

Требования

Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.

  • PyYAML >= 3.11

Параметры

Параметр

Комментарии

client_id

целое число

Идентификатор клиента, с которым необходимо связать домен.

Если идентификатор клиента не указан, домен будет добавлен к основному клиенту с идентификатором 1.

По умолчанию: 1

domain_name

строка / обязательно

Имя домена, которое необходимо проверить или перепроверить.

entrust_api_client_cert_key_path

путь / обязательно

Путь к ключу для клиентского сертификата, используемого для аутентификации в API Entrust Certificate Services (ECS).

entrust_api_client_cert_path

путь / обязательно

Путь к клиентскому сертификату, используемому для аутентификации в API Entrust Certificate Services (ECS).

entrust_api_key

строка / обязательно

Ключ (пароль) для аутентификации в API Entrust Certificate Services (ECS).

entrust_api_specification_path

путь

Путь к файлу спецификации, определяющему конфигурацию API Entrust Certificate Services (ECS).

Вы можете использовать это для хранения локальной копии спецификации, чтобы избежать ее загрузки каждый раз при использовании модуля.

По умолчанию: "https://cloud.entrust.net/EntrustCloud/documentation/cms-api-2.1.0.yaml"

entrust_api_user

строка / обязательно

Имя пользователя для аутентификации в API Entrust Certificate Services (ECS).

verification_email

строка

Адрес электронной почты, который будет использоваться для проверки права владения доменом.

Адрес электронной почты должен быть либо адресом электронной почты, присутствующим в данных WHOIS для domain_name, либо одним из следующих сконструированных адресов электронной почты: admin@domain_name, administrator@domain_name, webmaster@domain_name, hostmaster@domain_name, postmaster@domain_name.

Обратите внимание, что если domain_name включает поддомены, следует использовать домен верхнего уровня. Например, если запрашивается проверка example1.ansible.com или test.example2.ansible.com, и вы хотите использовать предварительно созданное имя «admin», адрес электронной почты должен быть admin@ansible.com.

Если используются значения электронной почты из данных WHOIS для домена или его пространства имен верхнего уровня, они должны точно совпадать.

Если verification_method=email, но verification_email не указан, будет использован первый адрес электронной почты, найденный в данных WHOIS для домена.

Для проверки права владения доменом владелец домена должен следовать инструкциям в полученном электронном письме.

Допускается только если verification_method=email

verification_method

строка / обязательно

Метод проверки, который будет использоваться для подтверждения контроля над доменом.

Если verification_method=email и указано значение verification_email, это значение используется для проверки электронной почты. Если verification_email не указано, будет использовано первое значение, присутствующее в данных WHOIS. На адрес, указанный в verification_email, будет отправлено электронное письмо с инструкциями о том, как проверить контроль над доменом.

Если verification_method=dns, значение dns_contents должно быть сохранено в местоположении dns_location, с типом записи DNS dns_resource_type. Чтобы подтвердить право владения доменом, обновите свои записи DNS так, чтобы текстовая строка, возвращаемая dns_contents, была доступна по dns_location.

Если verification_method=web_server, содержимое возвращаемого значения file_contents должно быть доступно на веб-сервере по адресу file_location.

Если verification_method=manual, домен будет проверен с помощью ручного процесса. Это не рекомендуется.

Варианты:

  • "dns"
  • "email"
  • "manual"
  • "web_server"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: нет

Может работать в check_mode и возвращать прогнозируемый статус изменения без модификации целевого объекта.

diff_mode

Поддержка: нет

В режиме diff возвращает подробности о том, что изменилось (или, возможно, нуждается в изменении в check_mode).

Примечания

Примечание

  • Существует небольшая задержка (обычно около 5 секунд, но может достигать 60 секунд) перед получением случайных значений при запросе валидации при verification_method=dns или verification_method=web_server. Учитывайте это при выполнении множества запросов валидации домена.

См. также

См. также

community.crypto.x509_certificate

Может использоваться для запроса сертификатов от ECS, с provider=entrust.

community.crypto.ecs_certificate

Может использоваться для запроса сертификата от ECS, используя проверенный домен.

Примеры

- name: Request domain validation using email validation for client ID of 2.
  community.crypto.ecs_domain:
    domain_name: ansible.com
    client_id: 2
    verification_method: email
    verification_email: admin@ansible.com
    entrust_api_user: apiusername
    entrust_api_key: a^lv*32!cd9LnT
    entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
    entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key

- name: Request domain validation using DNS. If domain is already valid,
        request revalidation if expires within 90 days
  community.crypto.ecs_domain:
    domain_name: ansible.com
    verification_method: dns
    entrust_api_user: apiusername
    entrust_api_key: a^lv*32!cd9LnT
    entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
    entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key

- name: Request domain validation using web server validation, and revalidate
        if fewer than 60 days remaining of EV eligibility.
  community.crypto.ecs_domain:
    domain_name: ansible.com
    verification_method: web_server
    entrust_api_user: apiusername
    entrust_api_key: a^lv*32!cd9LnT
    entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
    entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key

- name: Request domain validation using manual validation.
  community.crypto.ecs_domain:
    domain_name: ansible.com
    verification_method: manual
    entrust_api_user: apiusername
    entrust_api_key: a^lv*32!cd9LnT
    entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
    entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key

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

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

Ключ

Описание

client_id

integer

Идентификатор клиента, которому принадлежит домен. Если указано входное значение client_id, оно всегда будет совпадать с client_id

Возвращается: изменено или успешно

Пример: 1

dns_contents

string

Значение, которое ECS будет ожидать найти в записи DNS, расположенной по адресу dns_location.

Возвращается: изменено и если verification_method равно dns

Пример: "AB23CD41432522FF2526920393982FAB"

dns_location

string

Местоположение, в котором ECS будет ожидать найти запись DNS для проверки домена, содержащую содержимое dns_contents.

Возвращается: изменено и если verification_method равно dns

Пример: "_pki-validation.ansible.com"

dns_resource_type

string

Тип записи ресурса, который ECS будет ожидать для записи DNS, расположенной по адресу dns_location.

Возвращается: изменено и если verification_method равно dns

Пример: "TXT"

domain_status

string

Статус текущего домена. Будет одним из APPROVED, DECLINED, CANCELLED, INITIAL_VERIFICATION, DECLINED, CANCELLED, RE_VERIFICATION, EXPIRED, EXPIRING

Возвращается: изменено или успешно

Пример: "APPROVED"

emails

list / elements=string

Список электронных адресов, использованных для запроса проверки этого домена.

Домены, запрошенные с помощью этого модуля, будут иметь список размером только 1.

Возвращается: verification_method равно email

Пример: ["admin@ansible.com", "administrator@ansible.com"]

ev_days_remaining

integer

Количество дней, в течение которых домен остается доступным для отправки сертификатов «EV». Никогда не будет больше значения ov_days_remaining

Возвращается: успешно и ev_eligible равно true и domain_status равно APPROVED, RE_VERIFICATION или EXPIRING.

Пример: 94

ev_eligible

boolean

Может ли домен быть использован для отправки сертификатов «EV». Никогда не будет true, если ov_eligible равно false

Возвращается: успешно и domain_status равно APPROVED, RE_VERIFICATION или EXPIRING, или EXPIRED.

Пример: true

file_contents

string

Содержимое файла, которое ECS будет ожидать найти по адресу file_location.

Возвращается: verification_method равно web_server

Пример: "AB23CD41432522FF2526920393982FAB"

file_location

string

Местоположение, в котором ECS будет ожидать найти файл для проверки домена, содержащий содержимое file_contents.

Возвращается: verification_method равно web_server

Пример: "http://ansible.com/.well-known/pki-validation/abcd.txt"

ov_days_remaining

integer

Количество дней, в течение которых домен остается доступным для отправки сертификатов «OV». Никогда не будет меньше значения ev_days_remaining

Возвращается: успешно и ov_eligible равно true и domain_status равно APPROVED, RE_VERIFICATION или EXPIRING.

Пример: 129

ov_eligible

boolean

Может ли домен быть использован для отправки сертификатов «OV». Никогда не будет false, если ev_eligible равно true

Возвращается: успешно и domain_status равно APPROVED, RE_VERIFICATION, EXPIRING, или EXPIRED.

Пример: true

verification_method

string

Метод проверки, используемый для запроса проверки домена. Если changed будет таким же, как входной параметр verification_method.

Возвращается: изменено или успешно

Пример: "dns"

Авторы

  • Chris Trufan (@ctrufan)

Справочные ссылки

  • Отслеживание проблем
  • Репозиторий (исходные коды)
  • Задать вопрос (crypto)
  • Задать вопрос (ACME)
  • Отправить отчет об ошибке
  • Запросить новую функцию
  • Общение

© 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/crypto/ecs_domain_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API