Spec-Zone.ru › Ansible 2.11

community.aws.elasticache_info – Получение информации о кластерах AWS ElastiCache

Примечание

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

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

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

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

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

Обзор

  • Получение информации из кластеров AWS ElastiCache
  • Этот модуль назывался elasticache_facts до Ansible 2.9. Способ использования не изменился.

Требования

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

  • python >= 2.6
  • boto

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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'. Дополнительную информацию о конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время выполнения задачи, выводя множество в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url
строка
URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL.

псевдонимы: aws_endpoint_url, endpoint_url
name
строка
Название кластера ElastiCache.
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
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 ElastiCache information
  community.aws.elasticache_info:

- name: obtain all information for a single ElastiCache cluster
  community.aws.elasticache_info:
    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
строка
всегда
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_group_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
строка
всегда
Временной интервал для предпочтительного окна обслуживания

Пример:
суббота:12:00-суббота:13:00
replication_group_id
строка
всегда
ID группы репликации

Пример:
replication-001
security_groups
сложный тип
всегда
Список групповых правил безопасности, связанных с ElastiCache
security_group_id
строка
всегда
ID группового правила безопасности

Пример:
sg-abcd1234
status
строка
всегда
Статус группового правила безопасности

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

Пример:
{'Приложение': 'веб', 'Среда': 'тест'}


Авторы

  • Will Thames (@willthames)

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

Spec-Zone.ru

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