Модуль amazon.aws.ec2_snapshot_info – Сбор информации о снимках томов EC2 в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: amazon.aws.ec2_snapshot_info.
Новое в amazon.aws 1.0.0
Обзор
- Сбор информации о снимках томов EC2 в AWS.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string | Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
filters dictionary | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html для возможных фильтров. Имена и значения фильтров чувствительны к регистру. Значение по умолчанию: |
max_results integer | Максимальное количество результатов моментальных снимков, возвращаемых в постраничном выводе. При использовании возвращается только одна страница вместе с элементом ответа Остальные результаты первоначального запроса можно увидеть, отправив еще один запрос со значением Это значение может находиться в диапазоне от 5 до 1000; если Если этот параметр не используется, DescribeSnapshots возвращает все результаты. Этот параметр является взаимоисключающим с |
next_token_id string | Содержит значение, возвращенное из предыдущего постраничного запроса, где использовался Постраничная навигация продолжается с конца предыдущих результатов, которые вернули значение Этот параметр является взаимоисключающим с |
owner_ids list / elements=string | Если вы укажете одного или нескольких владельцев моментальных снимков, будут возвращены только моментальные снимки от указанных владельцев и к которым у вас есть доступ. Значение по умолчанию: |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
restorable_by_user_ids list / elements=string | Если вы укажете список пользователей, которым разрешено восстановление, будут возвращены только моментальные снимки с разрешениями на создание моментальных снимков для этих пользователей. Значение по умолчанию: |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сеанса AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
snapshot_ids list / elements=string | Если вы укажете один или несколько идентификаторов снимков, будут возвращены только снимки с указанными идентификаторами. По умолчанию: |
validate_certs boolean | При значении Установку validate_certs=false настоятельно не рекомендуется. В качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого. Варианты:
|
Примечания
Примечание
- По умолчанию модуль возвращает все снимки, включая общедоступные. Для ограничения результатов снимками, принадлежащими учетной записи, используйте фильтр
owner-id. - Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост» а не «контроллер». Поэтому, файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (как правило,
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
# 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 123456789012
- amazon.aws.ec2_snapshot_info:
filters:
owner-id: 123456789012
# Or alternatively...
- amazon.aws.ec2_snapshot_info:
owner_ids:
- 123456789012
# 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
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
next_token_id строка | Содержит значение, возвращённое из предыдущего запроса с постраничной обработкой, где использовалось Это значение равно null, когда больше результатов возвращать не нужно. Возвращается: при установке параметра |
snapshots список / элементы=словарь | Список полученных снимков с соответствующей информацией. Возвращается: успешно |
|
create_volume_permissions список / элементы=словарь |
Пользователи и группы, имеющие разрешения на создание томов из снимка. Модуль вернёт пустой список, если разрешения на создание томов из снимка установлены как «частные». Возвращается: успешно Пример: |
|
data_encryption_key_id строка |
Идентификатор ключа шифрования данных для снимка. Это уникальный идентификатор, соответствующий ключу шифрования данных, который использовался для шифрования исходного тома или копии снимка. Возвращается: всегда Пример: |
|
description строка |
Описание снимка. Возвращается: всегда Пример: |
|
encrypted булево |
Указывает, зашифрован ли снимок. Возвращается: всегда Пример: |
|
kms_key_id строка |
Полный ARN ключа шифрования AWS KMS (AWS KMS). Возвращается: успешно Пример: |
|
owner_id строка |
AWS идентификатор учётной записи владельца снимка EBS. Возвращается: всегда Пример: |
|
progress строка |
Прогресс снимка в процентах. Возвращается: всегда Пример: |
|
snapshot_id строка |
Идентификатор снимка. Каждый снимок получает уникальный идентификатор при создании. Возвращается: всегда Пример: |
|
start_time строка |
Отметка времени начала создания снимка. Возвращается: всегда Пример: |
|
state строка |
Состояние снимка (завершён, ожидающий или ошибка). Возвращается: всегда Пример: |
|
state_message строка |
Копии снимков Amazon EBS шифруются асинхронно. Если операция копирования снимка завершается ошибкой (например, если не получены необходимые разрешения AWS KMS), в этом поле отображаются детали ошибки, чтобы помочь вам определить причину возникновения ошибки. Возвращается: успешно |
|
storage_tier строка |
Уровень хранения, в котором хранится снимок. Возвращается: всегда Пример: |
|
tags словарь |
Любые теги, назначенные снимку. Возвращается: всегда Пример: |
|
volume_id строка |
Идентификатор тома, используемого для создания снимка. Возвращается: всегда Пример: |
|
volume_size integer |
Размер тома в ГБ. Возвращается: всегда Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/ec2_snapshot_info_module.html