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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Значения возврата
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

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
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 bool (добавлен в 1.5)	Варианты: no да ←	При установке в "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверены.

Примечания

Примечание

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

Примеры

# 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 (Amazon Resource Name) клиентского основного ключа (CMK) AWS Key Management Service (AWS KMS), который использовался для защиты ключа шифрования тома для родительского тома. Пример: 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, зашифрованные с помощью Amazon EBS, копируются асинхронно. Если операция копирования моментального снимка завершается неудачно (например, если не получены соответствующие разрешения AWS Key Management Service (AWS KMS)), в этом поле отображаются подробности об ошибке состояния, которые помогут вам диагностировать причину ошибки.
tags словарь	всегда	Все теги, назначенные моментальному снимку. Пример: { 'my_tag_key': 'my_tag_value' }
volume_id строка	всегда	Идентификатор тома, который использовался для создания моментального снимка. Пример: vol-01234567
volume_size целое число	всегда	Размер тома в ГБ. Пример: 8

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. в Раздел по поддержке и обслуживанию модулей.

Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.

Автор

Rob White (@wimnat)

Подсказка

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

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