Spec-Zone.ru › Ansible

Модуль openstack.cloud.volume_snapshot_info – Получение снимков томов

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.volume_snapshot_info.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Получение сведений о снимках томов из облака OpenStack.

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

integer

Время ожидания сокетного уровня перед истечением времени ожидания вызовов API. Если параметр не указан, в библиотеку requests ничего не передаётся.

auth

dictionary

Словарь с данными аутентификации, необходимыми выбранному плагину аутентификации облака. Для стандартного плагина password он должен содержать auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все необходимые им параметры. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.

auth_type

string

Имя используемого плагина аутентификации. Если в облаке используется аутентификация не по паролю, укажите здесь имя плагина и соответствующим образом обновите содержимое параметра auth.

ca_cert

псевдонимы: cacert

string

Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL.

client_cert

псевдонимы: cert

string

Путь к сертификату клиента, используемому в транзакции SSL.

client_key

псевдонимы: key

string

Путь к ключу клиента, используемому в транзакции SSL.

cloud

any

Именованное облако или конфигурация облака, с которой нужно работать. Если cloud — это строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если cloud — это словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.

details

boolean

Более подробный вывод

Варианты:

  • false
  • true

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, извлекаемый из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

string

Имя снимка.

region_name

string

Имя региона.

sdk_log_level

string

Уровень журналирования OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся.

status

string

Указывает состояние снимка.

Варианты:

  • "available"
  • "backing-up"
  • "creating"
  • "deleted"
  • "deleting"
  • "error"
  • "error_deleting"
  • "restoring"
  • "unmanaging"

timeout

integer

Время ожидания запрошенного ресурса модулем Ansible.

По умолчанию: 180

validate_certs

псевдонимы: verify

boolean

Следует ли проверять запросы API SSL.

До Ansible 2.3 значением по умолчанию было true.

Варианты:

  • false
  • true

volume

string

Имя или идентификатор тома.

wait

boolean

Следует ли модулю Ansible ждать завершения операции с запрошенным ресурсом.

Варианты:

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

Примечания

Примечание

  • Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например OS_USERNAME.
  • Данные аутентификации определяются openstacksdk: значения могут быть взяты из файла конфигурации yaml /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явных параметров плейбука. Дополнительные сведения доступны по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: List all snapshots
  openstack.cloud.volume_snapshot_info:

- name: Fetch data about a single snapshot
  openstack.cloud.volume_snapshot_info:
    name: my_fake_snapshot

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

volume_snapshots

list / elements=dictionary

Список словарей с описанием снимков томов.

Возвращается: всегда

created_at

string

Время создания снимка.

Возвращается: при успехе

description

string

Описание снимка.

Возвращается: при успехе

id

string

Уникальный UUID.

Возвращается: при успехе

Пример: "39007a7e-ee4f-4d13-8283-b4da2e037c69"

is_forced

boolean

Указывает, следует ли создавать снимок, даже если том подключён.

Возвращается: при успехе

metadata

dictionary

Метаданные снимка.

Возвращается: при успехе

name

string

Имя снимка.

Возвращается: при успехе

progress

string

Текущий процент выполнения создания снимка.

Возвращается: при успехе

project_id

string

Идентификатор проекта, с которым связан этот снимок.

Возвращается: при успехе

size

integer

Размер тома в ГБ.

Возвращается: при успехе

status

string

Состояние снимка.

Возвращается: при успехе

updated_at

string

Время обновления снимка.

Возвращается: при успехе

volume_id

string

Идентификатор тома.

Возвращается: при успехе

Авторы

  • Специальная группа OpenStack Ansible

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/openstack/cloud/volume_snapshot_info_module.html

Spec-Zone.ru

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