Модуль openstack.cloud.share_type_info — получение сведений о типе общего ресурса OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля могут потребоваться дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.share_type_info.
Краткое описание
- Получение сведений о типе общего ресурса в OpenStack Manila.
- Получение сведений о доступе к типу общего ресурса для закрытых типов.
- Для получения полной информации о типе общего ресурса, включая поле is_default, используется микроверсия API Manila 2.50.
- Если серверная часть не поддерживает микроверсию 2.50, выполняется безопасный переход к получению основных сведений.
- Доступ к закрытым типам общих ресурсов возможен только по UUID.
Требования
Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.
- 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. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, запрашиваемой из каталога служб. Варианты:
|
name string / обязательный | Имя или идентификатор типа общего ресурса. Для закрытых типов общих ресурсов вместо имени необходимо использовать UUID. |
region_name string | Имя региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается. |
timeout integer | Как долго Ansible должен ждать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Нужно ли проверять запросы API SSL. До Ansible 2.3 значение по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ждать завершения операции с запрошенным ресурсом. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров в плейбуках. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: Get share type details
openstack.cloud.share_type_info:
name: manila-generic-share
- name: Get share type details by id
openstack.cloud.share_type_info:
name: fbadfa6b-5f17-4c26-948e-73b94de57b42
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
share_type dictionary | Словарь с описанием типа общего ресурса Возвращается: при успешном выполнении |
|
description string |
описание типа общего ресурса Доступно, если поддерживается микроверсия API Manila 2.50 Если микроверсия недоступна, используется пустая строка Возвращается: при успешном выполнении Пример: |
|
id string |
UUID типа общего ресурса Возвращается: при успешном выполнении Пример: |
|
is_default boolean |
является ли этот тип общего ресурса типом по умолчанию Получается из ответа API, если поддерживается микроверсия 2.50 Если микроверсия недоступна или поле отсутствует, используется значение null Возвращается: при успешном выполнении Пример: |
|
is_public boolean |
является ли тип общего ресурса общедоступным (true) или закрытым (false) Возвращается: при успешном выполнении Пример: |
|
name string |
имя типа общего ресурса Возвращается: при успешном выполнении Пример: |
|
optional_extra_specs dictionary | Необязательные дополнительные спецификации типа общего ресурса Возвращается: при успешном выполнении Пример: |
|
required_extra_specs dictionary | Обязательные дополнительные спецификации типа общего ресурса Возвращается: при успешном выполнении Пример: |
Авторы
- Специальная группа 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/share_type_info_module.html