Модуль openstack.cloud.volume_type_access — Управление доступом к типу тома OpenStack block-storage

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: openstack.cloud.volume_type_access.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Добавление или удаление доступа к типу тома OpenStack block-storage

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени слой сокетов должен ждать перед истечением времени ожидания для вызовов API. Если этот параметр опущен, в библиотеку запросов ничего не будет передано.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые для плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету сертификатов CA, который может быть использован для проверки запросов API SSL.
client_cert псевдонимы: cert строка	Путь к клиенту сертификата для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud — это строка, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или если присутствуют переменные окружения OpenStack OS_. Если cloud* — это словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога сервисов. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка / обязательно	Имя или идентификатор типа тома блочного хранилища.
project строка / обязательно	Идентификатор или имя проекта для предоставления доступа. Разрешить project доступ к частному типу тома (имя или идентификатор).
project_domain строка	Домен, к которому принадлежит проект (имя или идентификатор). Это может быть использовано в случае коллизий между именами проектов.
region_name строка	Имя региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не будет записан
state строка	Указывает, должен ли проект иметь доступ к типу тома или нет. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Должны ли проверяться запросы API SSL. До Ansible 2.3 это по умолчанию было `true`. Варианты: `false` `true`
wait булево	Должен ли Ansible ждать, пока запрашиваемый ресурс будет завершен. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Тип тома не должен быть закрытым для управления доступом проектов.
Стандартные переменные окружения OpenStack, такие как OS_USERNAME, могут использоваться вместо явного указания значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут браться из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явных параметров в playbooks. Более подробная информация доступна по адресу 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 словарь	Словарь, описывающий тип тома. Возвращаемое значение: успех
description строка	Описание типа. Возвращаемое значение: успех
extra_specs словарь	Словарь дополнительных спецификаций. Обычно ключом является «capabilities». Возвращаемое значение: успех
id строка	Идентификатор типа тома. Возвращаемое значение: успех
is_public булево	Тип тома доступен общественности. Возвращаемое значение: успех
name строка	Имя типа тома. Возвращаемое значение: успех

Авторы

OpenStack Ansible SIG

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

© 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_type_access_module.html