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

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

Описание

Сбор информации о снимках томов ec2 в AWS
Этот модуль назывался ec2_snapshot_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: ec2_snapshot_facts

Требования

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

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
debug_botocore_endpoint_logs логический тип добавлен в 2.8	Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения книги задач. Также может использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион является обязательным. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
filters -	По умолчанию: {}	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html для возможных фильтров. Имена и значения фильтров чувствительны к регистру.
owner_ids -	По умолчанию: []	Если вы укажете одного или нескольких владельцев снимков, будут возвращены только снимки от указанных владельцев и для которых у вас есть доступ.
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
restorable_by_user_ids -	По умолчанию: []	Если вы укажите список пользователей, которые могут восстановить снимки, будут возвращены только снимки с правами на создание снимков для этих пользователей.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
snapshot_ids -	По умолчанию: []	Если вы укажете один или несколько идентификаторов снимков, будут возвращены только снимки с указанными идентификаторами.
validate_certs логический тип	Варианты: нет да ←	Если установлено в «нет», сертификаты 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), если данные авторизации не указаны. См. https://boto.readthedocs.io/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 information about all snapshots, including public ones
- ec2_snapshot_info:

# Gather information about all snapshots owned by the account 0123456789
- ec2_snapshot_info:
    filters:
      owner-id: 0123456789

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

# Gather information about a particular snapshot using ID
- ec2_snapshot_info:
    filters:
      snapshot-id: snap-00112233

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

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

# Gather information about any snapshot with an error status
- ec2_snapshot_info:
    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 строка	всегда	Состояние моментального снимка (завершено, ожидается или ошибка). Пример: completed
state_message строка	всегда	Зашифрованные моментальные снимки Amazon EBS копируются асинхронно. Если операция копирования моментального снимка завершается ошибкой (например, если не получены соответствующие разрешения AWS Key Management Service (AWS KMS)), в этом поле отображаются подробности состояния ошибки, которые помогут вам диагностировать причину ошибки.
tags словарь	всегда	Любые метки, назначенные моментальному снимку. Пример: { 'my_tag_key': 'my_tag_value' }
volume_id строка	всегда	Идентификатор тома, который использовался для создания моментального снимка. Пример: vol-01234567
volume_size целое число	всегда	Размер тома в ГБ. Пример: 8

Статус

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

Авторы

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.9/modules/ec2_snapshot_info_module.html