os_project_access - Управление доступом к виртуальным машинам OpenStack
Новое в версии 2.5.
Обзор
- Добавление или удаление доступа к ресурсам, таким как виртуальные машины, типы дисков или другие ресурсы, из OpenStack.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени слой сокетов должен ждать перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, в библиотеку запросов ничего не передаётся. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако её поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые для этого плагина. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type | Имя плагина авторизации, которое следует использовать. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Зона доступности ресурса. | |
| cacert | Путь к пакету сертификатов CA, который можно использовать для проверки SSL-API-запросов. | |
| 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 обязательно | ID проекта. | |
| timeout | По умолчанию: 180 | Сколько времени Ansible будет ждать запрошенного ресурса. |
| verify |
| Нужно ли проверять SSL API-запросы. До версии 2.3 по умолчанию было True. алиасы: validate_certs |
| wait |
| Должен ли 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 строка | успех | ID виртуальной машины. Пример: 515256b8-7027-4d73-aa54-4e30a4a4a339 | |
| name строка | успех | Имя виртуальной машины. Пример: tiny | |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- 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.5/modules/os_project_access_module.html
