Spec-Zone.ru › Ansible

Модуль amazon.aws.backup_restore_job_info — Список информации о заданиях резервного копирования/восстановления

Примечание

Этот модуль является частью коллекции amazon.aws (версия 8.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет 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.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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

account_id

string

Идентификатор учетной записи для вывода списка задач восстановления.

aws_ca_bundle

path

Расположение пакета CA для использования при проверке SSL-сертификатов.

Переменная среды AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

completed_after

string

Указанная дата для фильтрации результатов на основе даты и времени завершения задачи восстановления.

Если указано, будут возвращены только задачи восстановления, созданные после указанной даты и времени.

Дата должна быть в формате Unix и координированном всемирном времени (UTC), например, «2023-02-25T00:05:36.309Z».

completed_before

string

Указанная дата для фильтрации результатов на основе даты и времени завершения задачи восстановления.

Если указано, будут возвращены только задачи восстановления, созданные до указанной даты и времени.

Дата должна быть в формате Unix и координированном всемирном времени (UTC), например, «2023-02-25T00:05:36.309Z».

created_after

string

Указанная дата для фильтрации результатов на основе даты и времени создания задачи восстановления.

Если указано, будут возвращены только задачи восстановления, созданные после указанной даты и времени.

Дата должна быть в формате Unix и координированном всемирном времени (UTC), например, «2023-02-25T00:05:36.309Z».

created_before

string

Указанная дата для фильтрации результатов на основе даты и времени создания задачи восстановления.

Если указано, будут возвращены только задачи восстановления, созданные до указанной даты и времени.

Дата должна быть в формате Unix и координированном всемирном времени (UTC), например, «2023-02-25T00:05:36.309Z».

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint для анализа уникальных (а не общих) "resource:action" вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action для вывода общего списка, сделанного во время playbook.

Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS.

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

profile

aliases: aws_profile

string

Именованный профиль AWS для использования для аутентификации.

См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Переменная среды AWS_PROFILE также может использоваться.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.

region

aliases: aws_region, ec2_region

string

Регион AWS для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Переменные среды AWS_REGION или EC2_REGION также могут использоваться.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

restore_job_id

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.

Также могут быть использованы переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключают друг друга.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды 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.

Также могут быть использованы переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

status

string

Статус задач восстановления для фильтрации результатов на основе статуса задачи.

Выбори:

  • "PENDING"
  • "RUNNING"
  • "COMPLETED"
  • "ABORTED"
  • "FAILED"

validate_certs

boolean

При установке в false, сертификаты SSL для связи с API AWS не будут проверяться.

Установка validate_certs=false категорически не рекомендуется. Вместо этого рассмотрите установку aws_ca_bundle.

Выбори:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible ‘хост’, а не ‘контроллер’. Поэтому файлы могут потребоваться скопировать на ‘хост’. Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible ‘контроллер’, а не ‘хост’.
  • Используемый Ansible SDK AWS (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

строка

Идентификатор учетной записи, владеющей задачей восстановления.

Возвращается: если задача восстановления существует

Пример: "123456789012"

created_resource_arn

строка

Идентификатор ресурса Amazon (ARN), уникально определяющий ресурс, для которого восстанавливается точка восстановления.

Формат ARN зависит от типа ресурса резервного копирования.

Возвращается: если задача восстановления существует

Пример: "arn:aws:ec2:us-east-2:xxxxxxxxxx..."

creation_date

строка

Дата и время создания задачи восстановления в формате Unix и координированном универсальном времени (UTC).

Возвращается: если задача восстановления существует

Пример: "2023-03-13T15:53:07.172000-07:00"

iam_role_arn

строка

ARN роли IAM, используемой для создания целевой точки восстановления.

Возвращается: если задача восстановления существует

Пример: "arn:aws:ec2:us-east-2:xxxxxxxxxx..."

percent_done

строка

Приблизительный процент завершенности задачи на момент запроса статуса.

Возвращается: если задача восстановления существует

Пример: "0.00%"

recovery_point_arn

строка

ARN, уникально определяющий точку восстановления.

Возвращается: если задача восстановления существует

Пример: "arn:aws:ec2:us-east-2:xxxxxxxxxx..."

restore_job_id

строка

Идентификатор задачи, восстанавливающей точку восстановления.

Возвращается: если задача восстановления существует

Пример: "AAAA1234-1D1D-1234-3F8E-1EB111EEEE00"

status

строка

Состояние задачи, инициированной Backup для восстановления точки восстановления.

Возвращается: если задача восстановления существует

Пример: "COMPLETED"

Авторы

  • Mandar Vijay Kulkarni (@mandar242)

Ссылки на коллекцию

  • Отслеживание задач
  • Репозиторий (источники)
  • Связь

© 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/backup_restore_job_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API