redshift_facts – Сбор фактов о кластере(ах) Redshift

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

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

Обзор

Сбор фактов о кластере(ах) Redshift

Требования

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

boto
boto3
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
cluster_identifier -		Префикс идентификатора кластера Redshift, который вы ищете. Это соответствие по регулярному выражению с неявным '^'. Добавьте '$' для полного соответствия. Псевдонимы: имя, идентификатор
debug_botocore_endpoint_logs логический добавлено в 2.8	Варианты: нет ← да	Используйте logger botocore.endpoint для парсинга уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения playbook. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется.
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
tags -		Словарь/хеш тегов в формате { имя_тега1: 'значение_тега1', имя_тега2: 'значение_тега2' } для сопоставления с группой безопасности(ями), которую вы ищете.
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

Примеры

# Note: These examples do net set authentication details, see the AWS guide for details.

# Find all clusters
- redshift_facts:
  register: redshift

# Find cluster(s) with matching tags
- redshift_facts:
    tags:
      env: prd
      stack: monitoring
  register: redshift_tags

# Find cluster(s) with matching name/prefix and tags
- redshift_facts:
    tags:
      env: dev
      stack: web
    name: user-
  register: redshift_web

# Fail if no cluster(s) is/are found
- redshift_facts:
    tags:
      env: stg
      stack: db
  register: redshift_user
  failed_when: "{{ redshift_user.results | length == 0 }}"

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
allow_version_upgrade boolean	success	Логическое значение, которое, если истинно, указывает, что обновления основных версий будут автоматически применяться к кластеру во время окна обслуживания. Пример: true\|false
automated_snapshot_retention_period integer	success	Количество дней, в течение которых сохраняются автоматические снимки кластера. Пример: 1
availability_zone string	success	Имя зоны доступности, в которой расположен кластер. Пример: us-east-1b
cluster_create_time string	success	Дата и время создания кластера. Пример: 2016-05-10T08:33:16.629000+00:00
cluster_identifier string	success	Уникальный ключ для идентификации кластера. Пример: redshift-identifier
cluster_nodes list	success	Узлы в кластере. Пример: [{'node_role': 'LEADER', 'private_ip_address': '10.0.0.1', 'public_ip_address': 'x.x.x.x'}, {'node_role': 'COMPUTE-1', 'private_ip_address': '10.0.0.3', 'public_ip_address': 'x.x.x.x'}]
cluster_paramater_groups list	success	Список параметров кластера, связанных с этим кластером. Пример: [{'cluster_parameter_status_list': [{'parameter_apply_status': 'in-sync', 'parameter_name': 'statement_timeout'}, {'parameter_apply_status': 'in-sync', 'parameter_name': 'require_ssl'}], 'parameter_apply_status': 'in-sync', 'parameter_group_name': 'tuba'}]
cluster_public_keys string	success	Открытый ключ для кластера. Пример: ssh-rsa anjigfam Amazon-Redshift
cluster_revision_number string	success	Конкретный номер ревизии базы данных в кластере. Пример: 1231
cluster_security_groups list	success	Список групп безопасности кластера, связанных с кластером.
cluster_snapshot_copy_status dictionary	success	Значение, возвращающее целевой регион и период хранения, настроенные для копирования снимков между регионами.
cluster_status string	success	Текущее состояние кластера. Пример: available
cluster_subnet_group_name string	success	Имя группы подсетей, связанной с кластером. Пример: redshift-subnet
cluster_version string	success	Идентификатор версии движка Amazon Redshift, работающего в кластере. Пример: 1.0
db_name string	success	Имя начальной базы данных, созданной при создании кластера. Пример: dev
elastic_ip_status dictionary	success	Состояние IP-адреса эластичного сервера (EIP).
encrypted boolean	success	Логическое значение, которое, если истинно, указывает, что данные в кластере зашифрованы в состоянии покоя. Пример: true\|false
endpoint string	success	Точка подключения. Пример: {'address': 'cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com', 'port': 5439}
enhanced_vpc_routing boolean	success	Параметр, указывающий, следует ли создавать кластер с включенным расширенным маршрутизацией VPC. Пример: true\|false
hsm_status dictionary	success	Значение, которое сообщает, завершил ли кластер Amazon Redshift применение изменений настроек модуля аппаратной безопасности (HSM), указанных в команде модификации кластера.
iam_roles list	success	Список ролей IAM, прикрепленных к кластеру.
kms_key_id string	success	Идентификатор ключа AWS Key Management Service (AWS KMS), используемого для шифрования данных в кластере.
master_username string	success	Имя пользователя-мастера для кластера. Пример: admin
modify_status string	optional	Статус операции модификации.
node_type string	success	Тип узла для узлов в кластере. Пример: ds2.xlarge
number_of_nodes integer	success	Количество вычислительных узлов в кластере. Пример: 12
pending_modified_values dictionary	success	Значение, которое, если присутствует, указывает на то, что изменения в кластере находятся в ожидании.
preferred_maintenance_window string	success	Еженедельный временной интервал в формате всемирного координированного времени (UTC), в течение которого может выполняться техническое обслуживание. Пример: tue:07:30-tue:08:00
publicly_accessible boolean	success	Логическое значение, которое, если истинно, указывает, что к кластеру можно получить доступ из публичной сети. Пример: true\|false
restore_status dictionary	success	Значение, описывающее состояние действия восстановления кластера.
tags list	success	Список тегов для кластера.
vpc_id string	success	Идентификатор VPC, в котором находится кластер, если кластер находится в VPC. Пример: vpc-1234567

vpc_security_groups

list

success

Список VPC групп безопасности, связанных с кластером.

Пример:

[{'status': 'active', 'vpc_security_group_id': 'sg-12cghhg'}]

Статус

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

Авторы

Jens Carl (@j-carl)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/redshift_facts_module.html