os_project_access - Управление доступом к виртуальным машинам OpenStack
Новое в версии 2.5.
Обзор
- Добавление или удаление доступа к ресурсам, таким как виртуальные машины, типы томов или другие ресурсы, в OpenStack.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должна ждать система сокетов перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан библиотеке requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемой функции авторизации облака. Для стандартной плагиновой функции password в нём будут содержаться auth_url, username, password, project_name и любая информация о доменах, если облако её поддерживает. Для других плагинов этот параметр должен содержать необходимые для работы плагина параметры. Этот параметр не требуется, если задан параметр cloud или переменные среды 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 bool |
| Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли 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. Смотрите Поддержка и обслуживание модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. на странице здесь.
Автор
- 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.6/modules/os_project_access_module.html
