Модуль openstack.cloud.project — управление проектами OpenStack Identity (Keystone)
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.project.
Краткое описание
- Создание, обновление или удаление проекта OpenStack Identity (Keystone).
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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 | Путь к набору сертификатов CA, который можно использовать для проверки запросов 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. |
description string | Описание проекта. |
domain псевдонимы: domain_id string | Имя или идентификатор домена, в котором нужно создать проект, если облако поддерживает домены. |
extra_specs псевдонимы: properties dictionary | Дополнительные свойства, связанные с этим проектом. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
is_enabled псевдонимы: enabled boolean | Включён ли этот проект. Варианты:
|
name 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: Create a project
openstack.cloud.project:
cloud: mycloud
description: demodescription
domain: demoid
is_enabled: True
name: demoproject
extra_specs:
internal_alias: demo_project
state: present
- name: Delete a project
openstack.cloud.project:
cloud: mycloud
endpoint_type: admin
name: demoproject
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
project dictionary | Словарь с описанием проекта. Возвращается: При успешном выполнении, если state имеет значение |
|
description string |
Описание проекта Возвращается: при успешном выполнении Пример: |
|
domain_id string |
Идентификатор домена, которому принадлежит проект Возвращается: при успешном выполнении Пример: |
|
id string |
Идентификатор проекта Возвращается: при успешном выполнении Пример: |
|
is_domain boolean |
Указывает, выступает ли проект также в роли домена. Возвращается: при успешном выполнении |
|
is_enabled boolean |
Указывает, включён ли проект Возвращается: при успешном выполнении |
|
name string |
Имя проекта Возвращается: при успешном выполнении Пример: |
|
options dictionary |
Параметры ресурса проекта Возвращается: при успешном выполнении |
|
parent_id string |
Идентификатор родительского проекта Возвращается: при успешном выполнении |
|
tags list / элементы=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/project_module.html
