Spec-Zone.ru › Ansible 2.10

community.aws.aws_acm_info – Получение информации о сертификатах из службы AWS Certificate Manager

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

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

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

Новое в версии 1.0.0: из community.aws

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Получение информации о сертификатах ACM
  • Этот модуль назывался aws_acm_facts до Ansible 2.9. Способ использования не изменился.
  • Обратите внимание, что эта функция не вернёт информацию о загруженных ключах размером 4096 бит из-за ограничения API ACM.

Требования

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

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если параметр profile задан, этот параметр игнорируется.
Одновременное указание параметров aws_access_key и profile устарело и будет сделано взаимно исключающими после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение пакета CA для проверки сертификатов SSL.
Используется только для модулей на основе boto3.
Примечание: пакет CA считывается на стороне модуля и может потребоваться явно скопировать его с контроллера, если он не выполняется локально.
aws_config
словарь
Словарь для модификации конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. Смотрите http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения более подробной информации о конфигурации boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если параметр profile задан, этот параметр игнорируется.
Одновременное указание параметров aws_secret_key и profile устарело и будет сделано взаимно исключающими после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
certificate_arn
строка
Если указан, результаты будут отфильтрованы, чтобы показать только сертификат с этим ARN.
Если сертификат с этим ARN не существует, задача завершится с ошибкой.
Если сертификат с этим ARN существует в другом регионе, задача завершится с ошибкой.

псевдонимы: arn
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Используйте регистрирующуюся утилиту botocore.endpoint для обработки уникальных (а не общих) API-запросов «ресурс:действие», отправляемых во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, сделанный во время выполнения книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
domain_name
строка
Имя домена сертификата ACM для ограничения поиска

псевдонимы: name
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть.

псевдонимы: aws_endpoint_url, endpoint_url
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка одновременного указания этих параметров вместе с profile устарела.
aws_access_key, aws_secret_key и security_token будут сделаны взаимно исключающими с profile после 2022-06-01.

псевдонимы: aws_profile
region
строка
Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если параметр profile задан, этот параметр игнорируется.
Одновременное указание параметров security_token и profile устарело и будет сделано взаимно исключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
statuses
список / элементы=строка
    Варианты:
  • PENDING_VALIDATION
  • ISSUED
  • INACTIVE
  • EXPIRED
  • VALIDATION_TIMED_OUT
  • REVOKED
  • FAILED
Статус для фильтрации результатов сертификатов
tags
словарь
Фильтровать результаты, показывая только сертификаты с тегами, соответствующими всем тегам, указанным здесь.
validate_certs
булево
    Варианты:
  • нет
  • да ←
Если установлено в «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета: AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
  • Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION можно использовать для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- name: obtain all ACM certificates
  community.aws.aws_acm_info:

- name: obtain all information for a single ACM certificate
  community.aws.aws_acm_info:
    domain_name: "*.example_com"

- name: obtain all certificates pending validation
  community.aws.aws_acm_info:
    statuses:
    - PENDING_VALIDATION

- name: obtain all certificates with tag Name=foo and myTag=bar
  community.aws.aws_acm_info:
    tags:
      Name: foo
      myTag: bar


# The output is still a list of certificates, just one item long.
- name: obtain information about a certificate with a particular ARN
  community.aws.aws_acm_info:
    certificate_arn:  "arn:aws:acm:ap-southeast-2:123456789876:certificate/abcdeabc-abcd-1234-4321-abcdeabcde12"

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

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

Краткое описание полей Возвращаемое значение Описание
сертификаты
сложный
всегда
Список сертификатов
сертификат
строка
после завершения создания сертификата
Тело сертификата ACM

Пример:
-----BEGIN CERTIFICATE-----\\nMII.....-----END CERTIFICATE-----\\n
certificate_arn
строка
всегда
ARN сертификата

Пример:
arn:aws:acm:ap-southeast-2:123456789012:certificate/abcd1234-abcd-1234-abcd-123456789abc
certificate_chain
строка
после завершения создания сертификата
Полная цепочка сертификатов для сертификата

Пример:
-----BEGIN CERTIFICATE-----\\nMII...\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n...
created_at
строка
всегда
Дата создания сертификата

Пример:
2017-08-15T10:31:19+10:00
domain_name
строка
всегда
Имя домена для сертификата

Пример:
*.example.com
domain_validation_options
сложный
при типе сертификата AMAZON_ISSUED
Параметры, используемые ACM для проверки сертификата
domain_name
строка
всегда
Полное доменное имя сертификата

Пример:
example.com
validation_domain
строка
всегда
Имя домена, используемое ACM для отправки электронных писем о подтверждении

Пример:
example.com
validation_emails
список / элементы=строка
всегда
Список адресов электронной почты, используемых ACM для отправки электронных писем о подтверждении домена

Пример:
['admin@example.com', 'postmaster@example.com']
validation_status
строка
всегда
Статус проверки домена

Пример:
SUCCESS
failure_reason
строка
только при ошибке выдачи сертификата
Причина ошибки запроса сертификата

Пример:
NO_AVAILABLE_CONTACTS
in_use_by
список / элементы=строка
всегда
Список ARN ресурсов AWS, которые используют сертификат.
issued_at
строка
всегда
Дата выдачи сертификата

Пример:
2017-01-01T00:00:00+10:00
issuer
строка
всегда
Выдающий сертификат

Пример:
Amazon
key_algorithm
строка
всегда
Алгоритм, используемый для генерации сертификата

Пример:
RSA-2048
not_after
строка
всегда
Дата после которой сертификат недействителен

Пример:
2019-01-01T00:00:00+10:00
not_before
строка
всегда
Дата до которой сертификат недействителен

Пример:
2017-01-01T00:00:00+10:00
renewal_summary
сложный
при выданном Amazon сертификате и начатом обновлении
Информация о процессе обновления
domain_validation_options
сложный
при типе сертификата AMAZON_ISSUED
Параметры, используемые ACM для проверки сертификата
domain_name
строка
всегда
Полное доменное имя сертификата

Пример:
example.com
validation_domain
строка
всегда
Имя домена, используемое ACM для отправки электронных писем о подтверждении

Пример:
example.com
validation_emails
список / элементы=строка
всегда
Список адресов электронной почты, используемых ACM для отправки электронных писем о подтверждении домена

Пример:
['admin@example.com', 'postmaster@example.com']
validation_status
строка
всегда
Статус проверки домена

Пример:
SUCCESS
renewal_status
строка
всегда
Статус обновления домена

Пример:
PENDING_AUTO_RENEWAL
revocation_reason
строка
при аннулировании сертификата
Причина аннулирования сертификата

Пример:
SUPERCEDED
revoked_at
строка
при аннулировании сертификата
Дата аннулирования сертификата

Пример:
2017-09-01T10:00:00+10:00
serial
строка
всегда
Серийный номер сертификата

Пример:
00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
signature_algorithm
строка
всегда
Алгоритм, используемый для подписи сертификата

Пример:
SHA256WITHRSA
status
строка
всегда
Статус сертификата в ACM

Пример:
ISSUED
subject
строка
всегда
Имя сущности, связанной с открытым ключом, содержащимся в сертификате

Пример:
CN=*.example.com
subject_alternative_names
список / элементы=строка
всегда
Альтернативные имена субъекта для сертификата

Пример:
['*.example.com']
tags
словарь
всегда
Теги, связанные с сертификатом

Пример:
{'Application': 'helloworld', 'Environment': 'test'}
type
строка
всегда
Источник сертификата

Пример:
AMAZON_ISSUED


Авторы

  • Will Thames (@willthames)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/aws_acm_info_module.html

Spec-Zone.ru

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