elasticache_facts - Получение фактов для кластеров AWS Elasticache
Новое в версии 2.5.
Обзор
- Получение фактов из кластеров AWS Elasticache
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 | |
| ec2_url | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она задана. | |
| name | Имя кластера Elasticache | |
| profile (добавлено в 1.6) | Использует профиль 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 (добавлено в 1.6) | AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| validate_certs bool (добавлено в 1.5) |
| Если установлено в "no", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания AWS региона, когда это требуется, но это также может быть настроено в файле конфигурации boto
Примеры
- name: obtain all Elasticache facts
elasticache_facts:
- name: obtain all facts for a single Elasticache cluster
elasticache_facts:
name: test_elasticache
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| elasticache_clusters сложный | всегда | Список кластеров Elasticache | |||
| auto_minor_version_upgrade bool | всегда | Автоматически ли происходит обновление до минорных версий Пример: True | |||
| cache_cluster_create_time строка | всегда | Дата и время создания кластера Пример: 2017-09-15T05:43:46.038000+00:00 | |||
| cache_cluster_id строка | всегда | ID кластера кэша Пример: abcd-1234-001 | |||
| cache_cluster_status строка | всегда | Статус кластера Elasticache Пример: доступен | |||
| cache_node_type строка | всегда | Тип экземпляра узлов Elasticache Пример: cache.t2.micro | |||
| cache_nodes сложный | всегда | Список узлов Elasticache в кластере | |||
| cache_node_create_time строка | всегда | Дата и время создания узла Пример: 2017-09-15T05:43:46.038000+00:00 | |||
| cache_node_id строка | всегда | ID узла кэша Пример: 0001 | |||
| cache_node_status строка | всегда | Статус узла кэша Пример: доступен | |||
| customer_availability_zone строка | всегда | Зона доступности, в которой был создан узел кэша Пример: ap-southeast-2b | |||
| endpoint сложный | всегда | Подробности подключения к узлу кэша | |||
| address строка | всегда | URL конечной точки узла кэша Пример: abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com | |||
| port целое число | всегда | Порт конечной точки узла кэша Пример: 6379 | |||
| parameter_grou_status строка | всегда | Статус группы параметров кэша Пример: синхронизирован | |||
| cache_parameter_group сложный | всегда | Содержание группы параметров кэша | |||
| cache_node_ids_to_reboot список | всегда | Узлы кэша, которые нужно перезагрузить для применения изменений параметров | |||
| cache_parameter_group_name строка | всегда | Имя группы параметров кэша Пример: default.redis3.2 | |||
| parameter_apply_status строка | всегда | Статус обновлений параметров Пример: синхронизирован | |||
| cache_security_groups список | всегда | Используемые группами безопасности кэша Пример: ['sg-abcd1234'] | |||
| cache_subnet_group_name строка | всегда | Используемая группой подсетей Elasticache Пример: abcd-subnet-group | |||
| client_download_landing_page строка | всегда | URL веб-страницы загрузки клиента Пример: https://console.aws.amazon.com/elasticache/home#client-download: | |||
| engine строка | всегда | Используемый движок Elasticache Пример: redis | |||
| engine_version строка | всегда | Версия движка Elasticache Пример: 3.2.4 | |||
| notification_configuration сложный | если уведомления включены | Настройка уведомлений | |||
| topic_arn строка | если уведомления включены | ARN темы назначения уведомлений Пример: arn:aws:sns:*:123456789012:my_topic | |||
| topic_name строка | если уведомления включены | Имя темы назначения уведомлений Пример: MyTopic | |||
| num_cache_nodes целое число | всегда | Количество узлов кэша Пример: 1 | |||
| pending_modified_values сложный | всегда | Значения, ожидающие изменения | |||
| preferred_availability_zone строка | всегда | Предпочтительная зона доступности Пример: ap-southeast-2b | |||
| preferred_maintenance_window string | always | Временной интервал предпочтительного окна технического обслуживания Пример: sat:12:00-sat:13:00 | |||
| replication_group_id string | always | Идентификатор группы репликации Пример: replication-001 | |||
| security_groups complex | always | Список групп безопасности, связанных с Elasticache | |||
| security_group_id string | always | Идентификатор группы безопасности Пример: sg-abcd1234 | |||
| status string | always | Статус группы безопасности Пример: active | |||
| tags complex | always | Теги, примененные к кластеру elasticache Пример: {'Application': 'web', 'Environment': 'test'} | |||
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в поддержке и обслуживании модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/elasticache_facts_module.html