Модуль openstack.cloud.volume_type_access — управление доступом к типу тома блочного хранилища OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля нужны дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.volume_type_access.
Краткое описание
- Добавление или удаление доступа к типу тома блочного хранилища 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 | Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов 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 / обязательный | Имя или идентификатор типа тома блочного хранилища. |
project string / обязательный | Идентификатор или имя проекта, которому предоставляется доступ. Разрешить проекту project доступ к частному типу тома (имя или идентификатор). |
project_domain string | Домен, к которому относится проект (имя или идентификатор). Можно использовать, если имена проектов совпадают. |
region_name string | Имя региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если параметр пуст, журнал не записывается. |
state string | Указывает, должен ли проект иметь доступ к типу тома. Варианты:
|
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: Grant access to volume type vol-type-001
openstack.cloud.volume_type_access:
cloud: devstack
name: vol-type-001
project: demo
state: present
- name: Revoke access to volume type
openstack.cloud.volume_type_access:
cloud: devstack
name: vol-type-001
project: demo
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
volume_type dictionary | Словарь с описанием типа тома. Возвращается: при успешном выполнении |
|
description string |
Описание типа. Возвращается: при успешном выполнении |
|
extra_specs dictionary |
Словарь дополнительных спецификаций. «capabilities» — часто используемый ключ. Возвращается: при успешном выполнении |
|
id string |
Идентификатор типа тома. Возвращается: при успешном выполнении |
|
is_public boolean |
Доступен ли тип тома всем пользователям. Возвращается: при успешном выполнении |
|
name string |
Имя типа тома. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_access_module.html
