Spec-Zone.ru › Ansible 2.5

elasticache_facts - Получение фактов для кластеров AWS Elasticache

Новая в версии 2.5.

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

Обзор

  • Получение фактов из кластеров AWS Elasticache

Требования

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

  • python >= 2.6
  • boto

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key Значение по умолчанию:
None
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key Значение по умолчанию:
None
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
ec2_url Значение по умолчанию:
None
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
name
Имя кластера Elasticache
profile
(добавлен в 1.6)
Значение по умолчанию:
None
Использует профиль 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)
Значение по умолчанию:
None
AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
validate_certs
(добавлен в 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

engine
строка
всегда
Двигатель, используемый elasticache

Пример:
redis
cache_cluster_create_time
строка
всегда
Дата и время создания кластера

Пример:
2017-09-15T05:43:46.038000+00:00
replication_group_id
строка
всегда
ID группы репликации

Пример:
replication-001
tags
сложный
всегда
Теги, примененные к кластеру elasticache

Пример:
{'Environment': 'test', 'Application': 'web'}
cache_cluster_id
строка
всегда
ID кэширующего кластера

Пример:
abcd-1234-001
pending_modified_values
сложный
всегда
Значения, которые ожидают изменения

cache_cluster_status
строка
всегда
Статус кластера Elasticache

Пример:
доступен
preferred_availability_zone
строка
всегда
Предпочитаемая зона доступности

Пример:
ap-southeast-2b
auto_minor_version_upgrade
булево
всегда
Автоматическое обновление до младших версий

Пример:
True
client_download_landing_page
строка
всегда
URL страницы загрузки клиента

Пример:
https://console.aws.amazon.com/elasticache/home#client-download:
cache_subnet_group_name
строка
всегда
Группа подсетей Elasticache, используемая кэшем

Пример:
abcd-subnet-group
notification_configuration
сложный
если уведомления включены
Настройка уведомлений

topic_name
строка
если уведомления включены
Имя темы назначения уведомлений

Пример:
MyTopic
topic_arn
строка
если уведомления включены
ARN темы назначения уведомлений

Пример:
arn:aws:sns:*:123456789012:my_topic
security_groups
сложный
всегда
Список групп безопасности, связанных с Elasticache

status
строка
всегда
Статус группы безопасности

Пример:
активен
security_group_id
строка
всегда
ID группы безопасности

Пример:
sg-abcd1234
cache_nodes
сложный
всегда
Список узлов Elasticache в кластере

customer_availability_zone
строка
всегда
Зона доступности, в которой был создан узел кэша

Пример:
ap-southeast-2b
cache_node_id
строка
всегда
ID узла кэша

Пример:
0001
endpoint
сложный
всегда
Подробности подключения к узлу кэша

port
целое число
всегда
Порт конечной точки узла кэша

Пример:
6379
address
строка
всегда
URL конечной точки узла кэша

Пример:
abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com
cache_node_status
строка
всегда
Статус узла кэша

Пример:
доступен
parameter_grou_status
строка
всегда
Статус параметрической группы кэша

Пример:
синхронизировано
cache_node_create_time
строка
всегда
Дата и время создания узла

Пример:
2017-09-15T05:43:46.038000+00:00
engine_version
строка
всегда
Версия движка elasticache

Пример:
3.2.4
cache_security_groups
список
всегда
Используемые группы безопасности кэша

Пример:
['sg-abcd1234']
num_cache_nodes
целое число
всегда
Количество узлов кэша

Пример:
1
cache_node_type
string
always
Тип экземпляра узлов Elasticache

Пример:
cache.t2.micro
cache_parameter_group
complex
always
Содержимое группы параметров кэша

cache_node_ids_to_reboot
list
always
Узлы кэша, которые нужно перезапустить для применения изменений параметров

cache_parameter_group_name
string
always
Имя группы параметров кэша

Пример:
default.redis3.2
parameter_apply_status
string
always
Статус обновлений параметров

Пример:
in-sync
preferred_maintenance_window
string
always
Временной интервал для предпочтительного окна технического обслуживания

Пример:
sat:12:00-sat:13:00


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.

Автор

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

Spec-Zone.ru

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