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
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 -		Имя кластера Elasticache
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

Примеры

- 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 булево			всегда	Автоматически ли происходит обновление до младших версий Пример: True
	cache_cluster_create_time строка			всегда	Дата и время создания кластера Пример: 2017-09-15T05:43:46.038000+00:00
	cache_cluster_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 строка		всегда	Идентификатор узла кэша Пример: 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'}

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/elasticache_facts_module.html