openstack.cloud.volume_snapshot_info модуль — Получение снимков томов
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.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 целое число | Сколько времени должна ждать система сокетов, прежде чем истечет время ожидания для API-вызовов. Если это опущено, ничего не будет передано в библиотеку requests. |
auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если предоставлен заданный параметр облака или присутствуют переменные среды OpenStack OS_*. |
auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответственно. |
ca_cert псевдонимы: cacert строка | Путь к пакету сертификатов CA, который может использоваться для проверки SSL-API-запросов. |
client_cert псевдонимы: cert строка | Путь к клиенту сертификату для использования в рамках транзакции SSL. |
client_key псевдонимы: key строка | Путь к ключу клиента для использования в рамках транзакции SSL. |
cloud любой | Наименованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию заданного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или если присутствуют переменные среды OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. |
details логическое значение | Более подробный вывод Варианты:
|
interface псевдонимы: endpoint_type строка | Тип URL-адреса конечной точки для получения из каталога служб. Варианты:
|
name строка | Имя моментального снимка. |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается |
status строка | Указывает состояние моментального снимка. Варианты:
|
timeout целое число | Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: |
validate_certs псевдонимы: verify логическое значение | Проверяются ли SSL API-запросы. До Ansible 2.3 значение по умолчанию было Варианты:
|
volume строка | Имя или ID тома. |
wait логическое значение | Ansible должен ждать завершения запрашиваемого ресурса. Варианты:
|
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в playbooks. Более подробную информацию можно найти на сайте 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 список / элементы=словарь | Список словарей, описывающих снимки томов. Возвращается: всегда |
|
created_at строка |
Время создания снимка. Возвращается: успешно |
|
description строка |
Описание снимка. Возвращается: успешно |
|
id строка |
Уникальный UUID. Возвращается: успешно Пример: |
|
is_forced булево |
Указывает, нужно ли создавать снимок, даже если том подключен. Возвращается: успешно |
|
metadata словарь |
Метаданные снимка. Возвращается: успешно |
|
name строка |
Имя снимка. Возвращается: успешно |
|
progress строка |
Процент завершения снимка на данный момент. Возвращается: успешно |
|
project_id строка |
Идентификатор проекта, к которому относится этот снимок. Возвращается: успешно |
|
size целое число |
Размер тома в ГБ. Возвращается: успешно |
|
status строка |
Статус снимка. Возвращается: успешно |
|
updated_at строка |
Время обновления снимка. Возвращается: успешно |
|
volume_id строка |
Идентификатор тома. Возвращается: успешно |
Ссылки на сборку
© 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/openstack/cloud/volume_snapshot_info_module.html
