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

Примечание

Этот плагин является частью коллекции amazon.aws (версия 1.3.0).

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

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

Новое в версии 1.0.0: of amazon.aws

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

Описание

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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 Bundle читается со стороны модуля и может потребоваться явно скопировать его с контроллера, если он не запускается локально.
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
filters словарь	Значение по умолчанию: {}	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html для возможных фильтров. Имена и значения фильтров чувствительны к регистру.
owner_ids список / элементы=строка	Значение по умолчанию: []	Если вы укажете одного или нескольких владельцев снимков, будут возвращены только снимки указанных владельцев и для которых у вас есть доступ.
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
restorable_by_user_ids список / элементы=строка	Значение по умолчанию: []	Если вы укажете список пользователей, для которых можно восстановить снимки, будут возвращены только снимки, для которых эти пользователи имеют разрешения на создание снимков.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если параметр profile задан, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: aws_security_token, access_token
snapshot_ids список / элементы=строка	Значение по умолчанию: []	Если вы укажете один или несколько идентификаторов снимков, будут возвращены только снимки с указанными идентификаторами.
validate_certs булево	Варианты: нет да ←	При значении "нет", SSL-сертификаты не будут проверяться для boto-версий >= 2.6.0.

Примечания

Примечание

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

Примеры

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

# Gather information about all snapshots, including public ones
- amazon.aws.ec2_snapshot_info:

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

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

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

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

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

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

Авторы

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.10/collections/amazon/aws/ec2_snapshot_info_module.html