Модуль amazon.aws.backup_restore_job_info — список сведений о заданиях восстановления из резервных копий
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.backup_restore_job_info.
Новый модуль в amazon.aws 6.0.0
Описание
- Выводит подробные сведения о заданиях AWS Backup, запущенных для восстановления сохранённого ресурса.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key строка | Идентификатор ключа доступа 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 SDK botocore. |
account_id строка | Идентификатор учётной записи, из которой необходимо получить задания восстановления. |
aws_ca_bundle путь | Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
completed_after строка | Указанная дата для фильтрации результатов по дате и времени завершения задания восстановления. Если параметр указан, будут возвращены только задания восстановления, созданные после указанной даты и времени. Дата должна быть указана в формате Unix и по всемирному координированному времени (UTC), например «2023-02-25T00:05:36.309Z». |
completed_before строка | Указанная дата для фильтрации результатов по дате и времени завершения задания восстановления. Если параметр указан, будут возвращены только задания восстановления, созданные до указанной даты и времени. Дата должна быть указана в формате Unix и по всемирному координированному времени (UTC), например «2023-02-25T00:05:36.309Z». |
created_after строка | Указанная дата для фильтрации результатов по дате и времени создания задания восстановления. Если параметр указан, будут возвращены только задания восстановления, созданные после указанной даты и времени. Дата должна быть указана в формате Unix и по всемирному координированному времени (UTC), например «2023-02-25T00:05:36.309Z». |
created_before строка | Указанная дата для фильтрации результатов по дате и времени создания задания восстановления. Если параметр указан, будут возвращены только задания восстановления, созданные до указанной даты и времени. Дата должна быть указана в формате Unix и по всемирному координированному времени (UTC), например «2023-02-25T00:05:36.309Z». |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную окружения Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region строка | Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
restore_job_id строка | Идентификатор задания восстановления, сведения о котором нужно получить. Этот параметр взаимоисключающий со всеми остальными параметрами. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка | Секретный ключ доступа 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 для согласованности с AWS SDK botocore. |
session_token псевдонимы: aws_session_token строка | Токен сеанса AWS STS для использования с временными учётными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения Параметры session_token и profile взаимоисключающие. |
status строка | Статус заданий восстановления, используемый для фильтрации результатов. Варианты:
|
validate_certs логическое значение | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для подключаемых модулей поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
- Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других настроек, например региона, из файлов конфигурации в контексте «узла» 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.
- name: List all restore jobs
amazon.aws.backup_restore_job_info:
- name: List specific restore job's info by job ID
amazon.aws.backup_restore_job_info:
restore_job_id: "52BEE289-xxxx-xxxx-xxxx-47DCAA2E7ACD"
- name: List restore jobs based on Account ID
amazon.aws.backup_restore_job_info:
account_id: xx1234567890
- name: List restore jobs based on status and created_before time
amazon.aws.backup_restore_job_info:
status: completed
created_before: "2023-02-25T00:05:36.309Z"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
restore_jobs список / элементы=словарь | Задания восстановления, соответствующие заданным фильтрам. Каждый элемент представляет собой словарь со сведениями об этом задании восстановления. Возвращается: всегда |
|
account_id строка |
Идентификатор учётной записи, которой принадлежит задание восстановления. Возвращается: если задание восстановления существует Пример: |
|
created_resource_arn строка |
Имя ресурса Amazon (ARN), однозначно идентифицирующее ресурс, точка восстановления которого восстанавливается. Формат ARN зависит от типа резервной копии ресурса. Возвращается: если задание восстановления существует Пример: |
|
creation_date строка |
Дата и время создания задания восстановления в формате Unix и по всемирному координированному времени (UTC). Возвращается: если задание восстановления существует Пример: |
|
iam_role_arn строка |
ARN роли IAM, использованной для создания целевой точки восстановления. Возвращается: если задание восстановления существует Пример: |
|
percent_done строка |
Расчётная доля выполненной работы на момент запроса статуса задания. Возвращается: если задание восстановления существует Пример: |
|
recovery_point_arn строка |
ARN, однозначно идентифицирующий точку восстановления. Возвращается: если задание восстановления существует Пример: |
|
restore_job_id строка |
Идентификатор задания, восстанавливающего точку восстановления. Возвращается: если задание восстановления существует Пример: |
|
status строка |
Состояние задания, запущенного Backup для восстановления точки восстановления. Возвращается: если задание восстановления существует Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/backup_restore_job_info_module.html