os_project_access – Управление доступом к виртуальным машинам OpenStack
Новое в версии 2.5.
Обзор
- Добавление или удаление доступа к ресурсам виртуальных машин, типов дисков и другим ресурсам OpenStack.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout - | Время ожидания сокета при вызове API. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth - | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type - | Имя подключаемого модуля авторизации для использования. Если облако использует не аутентификацию по паролю, то здесь должно быть указано имя подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Зона доступности ресурса. | |
| cacert - | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. | |
| cert - | Путь к клиенту сертификату для использования в рамках SSL-транзакции. | |
| cloud - | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface - добавлено в 2.3 |
| Тип URL-адреса конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type |
| key - | Путь к клиенту ключу для использования в рамках SSL-транзакции. | |
| region_name - | Название региона. | |
| resource_name - | Имя ресурса (например, tiny). | |
| resource_type - | Тип ресурса (например, nova_flavor, cinder_volume_type). | |
| state - |
| Укажите желаемое состояние ресурса. |
| target_project_id - / обязательно | Идентификатор проекта. | |
| timeout - | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемый ресурс. |
| verify boolean |
| Подтверждать или нет запросы API SSL. До версии 2.3 значение по умолчанию было True. Псевдонимы: validate_certs |
| wait boolean |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Могут использоваться стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об аутентификации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в заданиях. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
- name: "Enable access to tiny flavor to your tenant."
os_project_access:
cloud: mycloud
state: present
target_project_id: f0f1f2f3f4f5f67f8f9e0e1
resource_name: tiny
resource_type: nova_flavor
- name: "Disable access to the given flavor to project"
os_project_access:
cloud: mycloud
state: absent
target_project_id: f0f1f2f3f4f5f67f8f9e0e1
resource_name: tiny
resource_type: nova_flavor
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| flavor сложный | При успехе, когда state равен 'present' | Словарь, описывающий виртуальную машину. | |
| id строка | успех | Идентификатор виртуальной машины. Пример: 515256b8-7027-4d73-aa54-4e30a4a4a339 | |
| name строка | успех | Имя виртуальной машины. Пример: tiny | |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Roberto Polli (@ioggstream)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/os_project_access_module.html