Spec-Zone.ru › Ansible

Модуль openstack.cloud.volume_type_info — получение сведений о типе тома OpenStack

Примечание

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

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

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

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

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

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

  • Получение сведений о типе тома в OpenStack.
  • Получение сведений о шифровании типа тома в 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

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

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.

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. Если значение пустое, журнал не ведётся.

timeout

integer

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

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

validate_certs

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

boolean

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

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

Варианты:

  • false
  • true

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: Get volume type details
  openstack.cloud.volume_type_info:
    name: test_type

- name: Get volume type details by id
  openstack.cloud.volume_type_info:
    name: fbadfa6b-5f17-4c26-948e-73b94de57b42

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

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

Ключ

Описание

access_project_ids

list / элементы=string

Список идентификаторов проектов, которым разрешён доступ к типу тома

Для общедоступных типов томов возвращается значение «null», поскольку этот параметр неприменим

Возвращается: при успешном выполнении, если state имеет значение ‘present’

encryption

dictionary

Словарь с описанием шифрования типа тома

Возвращается: при успешном выполнении, если state имеет значение ‘present’

cipher

string

Алгоритм шифрования

Возвращается: при успешном выполнении

Пример: "aes-xts-plain64"

control_location

string

Расположение шифрования

Возвращается: при успешном выполнении

Пример: "front-end"

created_at

string

Дата и время создания ресурса

Возвращается: при успешном выполнении

Пример: "2023-08-04T10:23:03.000000"

deleted

string

Булево значение, указывающее, удалён ли ресурс

Возвращается: при успешном выполнении

Пример: "False"

deleted_at

string

Дата и время удаления ресурса

Возвращается: при успешном выполнении

encryption_id

string

UUID шифрования типа тома

Возвращается: при успешном выполнении

Пример: "b75d8c5c-a6d8-4a5d-8c86-ef4f1298525d"

id

string

Псевдоним для encryption_id

Возвращается: при успешном выполнении

Пример: "b75d8c5c-a6d8-4a5d-8c86-ef4f1298525d"

key_size

string

Размер ключа

Возвращается: при успешном выполнении

Пример: "256"

provider

string

Поставщик шифрования

Возвращается: при успешном выполнении

Пример: "nova.volume.encryptors.luks.LuksEncryptor"

updated_at

string

Дата и время последнего обновления ресурса

Возвращается: при успешном выполнении

volume_type

dictionary

Словарь с описанием типа тома

Возвращается: при успешном выполнении, если state имеет значение ‘present’

description

string

Описание типа тома

Возвращается: при успешном выполнении

Пример: "Unencrypted volume type"

extra_specs

dictionary

Дополнительные параметры типа тома

Возвращается: при успешном выполнении

id

string

UUID типа тома

Возвращается: при успешном выполнении

Пример: "b75d8c5c-a6d8-4a5d-8c86-ef4f1298525d"

is_public

boolean

Является ли тип тома общедоступным

Возвращается: при успешном выполнении

Пример: true

name

string

Имя типа тома

Возвращается: при успешном выполнении

Пример: "test_type"

Авторы

  • Специальная группа 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_type_info_module.html

Spec-Zone.ru

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