iam_server_certificate_info – Получение информации о сертификате сервера
Описание
- Получение атрибутов сертификата сервера
- Этот модуль назывался
iam_server_certificate_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: iam_cert_facts,iam_server_certificate_facts
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
aws_access_key
строка
|
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Псевдонимы: ec2_access_key, access_key |
|
|
aws_secret_key
строка
|
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Псевдонимы: ec2_secret_key, secret_key |
|
|
debug_botocore_endpoint_logs
логическое значение
добавлен в 2.8
|
|
Используйте логгер botocore.endpoint для анализа уникальных (а не общих) вызовов API "ресурс:действие" во время задачи, выводит набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, сделанный во время выполнения книги сценариев. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
|
|
ec2_url
строка
|
URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется.
|
|
|
name
строка / обязательно
|
Имя сертификата сервера, для которого извлекаются атрибуты.
|
|
|
profile
строка
|
Использует профиль boto. Работает только с boto >= 2.24.0.
|
|
|
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.
Псевдонимы: access_token |
|
|
validate_certs
логическое значение
|
|
При значении "нет", SSL сертификаты не будут проверены для версий boto >= 2.6.0.
|
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,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. - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно использовать для указания региона AWS, когда это требуется, но это также можно настроить в файле конфигурации boto
Примеры
# Retrieve server certificate
- iam_server_certificate_info:
name: production-cert
register: server_cert
# Fail if the server certificate name was not found
- iam_server_certificate_info:
name: production-cert
register: server_cert
failed_when: "{{ server_cert.results | length == 0 }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
|
arn
строка
|
успех |
Amazon Resource Name (ARN) сертификата сервера
Пример:
arn:aws:iam::911277865346:server-certificate/server-cert-name
|
|
certificate_body
строка
|
успех |
Строка PEM, закодированная в asn1der
Пример:
-----BEGIN CERTIFICATE----- набор случайных данных -----END CERTIFICATE-----
|
|
expiration
строка
|
успех |
Дата и время истечения срока действия сертификата сервера в формате ISO 8601.
Пример:
2017-06-15T12:00:00+00:00
|
|
path
строка
|
успех |
Путь к сертификату сервера
Пример:
/
|
|
server_certificate_id
строка
|
успех |
21-символьный идентификатор сертификата
Пример:
ADWAJXWTZAXIPIMQHMJPO
|
|
server_certificate_name
строка
|
успех |
Имя сертификата сервера
Пример:
server-cert-name
|
|
upload_date
строка
|
успех |
Дата и время загрузки сертификата сервера в формате ISO 8601.
Пример:
2015-04-25T00:36:40+00:00
|
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Allen Sanabria (@linuxdynasty)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/iam_server_certificate_info_module.html