openstack.cloud.project модуль — Управление проектами OpenStack Identity (Keystone)

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.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 целое число	Сколько времени должен ожидать уровень сокета, прежде чем истечёт время ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету сертификата CA, который можно использовать для проверки запросов API SSL.
client_cert псевдонимы: cert строка	Путь к клиенту сертификата для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
description строка	Описание проекта.
domain псевдонимы: domain_id строка	Имя или идентификатор домена для создания проекта, если облако поддерживает домены.
extra_specs псевдонимы: properties словарь	Дополнительные свойства, которые должны быть связаны с этим проектом.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога сервисов. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
is_enabled псевдонимы: enabled булево	Включён ли этот проект или нет. Варианты: `false` `true`
name строка / обязательно	Имя проекта. Это атрибут не может быть обновлён.
region_name строка	Имя региона.
sdk_log_level строка	Уровень логов OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
state строка	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Нужно ли проверять запросы API SSL. До Ansible 2.3 по умолчанию было `true`. Варианты: `false` `true`

wait

boolean

Должен ли Ansible ожидать завершения запрошенного ресурса.

Варианты:

false
true ← (по умолчанию)

Примечания

Примечание

Можно использовать стандартные переменные среды 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 словарь	Словарь, описывающий проект. Возвращается: при успехе, когда state равно `present`.
description строка	Описание проекта. Возвращается: успех Пример: `"demodescription"`
domain_id строка	ID домена, к которому принадлежит проект. Возвращается: успех Пример: `"default"`
id строка	ID проекта. Возвращается: успех Пример: `"f59382db809c43139982ca4189404650"`
is_domain логическое	Указывает, является ли проект также доменом. Возвращается: успех
is_enabled логическое	Указывает, включен ли проект. Возвращается: успех
name строка	Имя проекта. Возвращается: успех Пример: `"demoproject"`
options словарь	Параметры ресурса для проекта. Возвращается: успех
parent_id строка	ID родителя проекта. Возвращается: успех
tags список / элементы=строка	Список связанных тегов. Возвращается: успех

Авторы

OpenStack Ansible SIG

Ссылки на коллекцию

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