ec2_snapshot_facts - Сбор фактов о моментальных снимках томов ec2 в AWS

Новое в версии 2.1.

Обзор
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Обзор

Сбор фактов о моментальных снимках томов ec2 в AWS

Требования (к хосту, на котором выполняется модуль)

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, если она задана.
filters	нет			Словарь фильтров для применения. Каждый элемент словаря содержит ключ фильтра и значение фильтра. Обратитесь к http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html для возможных фильтров. Имена и значения фильтров чувствительны к регистру.
owner_ids	нет			Если вы указали одного или нескольких владельцев моментальных снимков, будут возвращены только моментальные снимки от указанных владельцев, к которым у вас есть доступ.
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
restorable_by_user_ids	нет			Если вы указали список пользователей, которым разрешено восстановление, будут возвращены только моментальные снимки с правами создания моментального снимка для этих пользователей.
security_token (добавлено в 1.6)	нет			Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
snapshot_ids	нет			Если вы указали один или несколько идентификаторов моментальных снимков, будут возвращены только моментальные снимки с указанными идентификаторами.
validate_certs (добавлено в 1.5)	нет	да	да нет	При значении "нет" сертификаты SSL для boto версий >= 2.6.0 не будут проверяться.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Gather facts about all snapshots, including public ones
- ec2_snapshot_facts:

# Gather facts about all snapshots owned by the account 0123456789
- ec2_snapshot_facts:
    filters:
      owner-id: 0123456789

# Or alternatively...
- ec2_snapshot_facts:
    owner_ids:
      - 0123456789

# Gather facts about a particular snapshot using ID
- ec2_snapshot_facts:
    filters:
      snapshot-id: snap-00112233

# Or alternatively...
- ec2_snapshot_facts:
    snapshot_ids:
      - snap-00112233

# Gather facts about any snapshot with a tag key Name and value Example
- ec2_snapshot_facts:
    filters:
      "tag:Name": Example

# Gather facts about any snapshot with an error status
- ec2_snapshot_facts:
    filters:
      status: error

Возвращаемые значения

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

имя	описание	возвращается	тип	пример
data_encryption_key_id	Идентификатор ключа шифрования данных для моментального снимка. Это уникальный идентификатор, соответствующий ключу шифрования данных, который использовался для шифрования исходного тома или копии моментального снимка.	всегда	строка	arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456
description	Описание моментального снимка.	всегда	строка	Мой важный резервный экземпляр
encrypted	Указывает, зашифрован ли моментальный снимок.	всегда	булево	True
kms_key_id	Полный ARN AWS Key Management Service (AWS KMS) ключа основного мастера (CMK), который использовался для защиты ключа шифрования тома для родительского тома.	всегда	строка	74c9742a-a1b2-45cb-b3fe-abcdef123456
owner_alias	Псевдоним учетной записи AWS (например, amazon, self) или идентификатор учетной записи AWS, которая владеет моментальным снимком.	всегда	строка	033440102211
owner_id	Идентификатор учетной записи AWS владельца моментального снимка EBS.	всегда	строка	099720109477
progress	Прогресс моментального снимка в процентах.	всегда	строка	100%
snapshot_id	Идентификатор моментального снимка. Каждый моментальный снимок получает уникальный идентификатор при создании.	всегда	строка	snap-01234567
start_time	Отметка времени начала создания моментального снимка.	всегда	строка	2015-02-12T02:14:02+00:00
state	Состояние моментального снимка (завершено, ожидается или ошибка).	всегда	строка	завершено
state_message	Зашифрованные моментальные снимки Amazon EBS копируются асинхронно. Если операция копирования моментального снимка завершается ошибкой (например, если не получены соответствующие разрешения AWS Key Management Service (AWS KMS)), в этом поле отображаются подробности состояния ошибки, чтобы помочь вам диагностировать причину возникновения ошибки.	всегда	строка	None
tags	Любые теги, назначенные моментальному снимку.	всегда	словарь	{ 'my_tag_key': 'my_tag_value' }
volume_id	Идентификатор тома, который использовался для создания моментального снимка.	всегда	строка	vol-01234567
volume_size	Размер тома в GiB.	всегда	целое число	8

Примечания

Примечание

По умолчанию модуль вернёт все моментальные снимки, включая публичные. Чтобы ограничить результаты моментальными снимками, принадлежащими учётной записи, используйте фильтр «owner-id».
Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Статус

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

Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Справочную информацию по сообществу и участие в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_snapshot_facts_module.html