openstack.cloud.os_project – Управление проектами OpenStack

Примечание

Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Чтобы использовать его в книге задач, укажите: openstack.cloud.os_project.

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

Обзор

Управление проектами OpenStack. С помощью этого модуля можно создавать, обновлять или удалять проекты. Проект будет обновлен, если имя совпадает с существующим проектом и состояние присутствует. Значение имя не может быть обновлено без удаления и повторного создания проекта.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должно ждать сокетное соединение перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для стандартного плагина password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, требуемые этим плагином. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка		Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификата, который нужно использовать в рамках транзакции SSL. псевдонимы: cert
client_key строка		Путь к ключу клиента, который нужно использовать в рамках транзакции SSL. псевдонимы: key
cloud сырой		Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
description строка		Описание проекта
domain_id строка		Идентификатор домена для создания проекта, если облако поддерживает домены. псевдонимы: domain
enabled булево	Варианты: no yes ←	Включен ли проект
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
name строка / обязательно		Название проекта
properties словарь	Значение по умолчанию: {}	Дополнительные свойства, которые должны быть связаны с этим проектом. Требуется openstacksdk>0.45.
region_name строка		Имя региона.
state строка	Варианты: present ← absent	Ресурс должен быть присутствующим или отсутствующим.
timeout целое число	Значение по умолчанию: 180	Сколько времени Ansible должно ждать запрошенного ресурса.
validate_certs булево	Варианты: no ← yes	Нужно ли проверять запросы API SSL. До Ansible 2.3 это имело значение по умолчанию `yes`. псевдонимы: verify
wait булево	Варианты: no yes ←	Должен ли Ansible ждать завершения запрошенного ресурса.

Примечания

Примечание

Можно использовать стандартные переменные среды OpenStack, такие как OS_USERNAME, вместо явного указания значений.
Информация об аутентификации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

# Create a project
- openstack.cloud.project:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: demoproject
    description: demodescription
    domain_id: demoid
    enabled: True
    properties:
      internal_alias: demo_project

# Delete a project
- openstack.cloud.project:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: demoproject

Возвращаемые значения

Общие возвращаемые значения описаны в этом месте, следующие поля уникальны для этого модуля:

Ключ		Возвращаемое значение	Описание
project сложный		При успехе, когда состояние равно 'present'	Словарь, описывающий проект.
	description строка	успех	Описание проекта Пример: demodescription
	enabled булево	успех	Булево значение, указывающее, включен ли проект Пример: True
	id строка	успех	Идентификатор проекта Пример: f59382db809c43139982ca4189404650
	name строка	успех	Имя проекта Пример: demoproject

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_project_module.html