Spec-Zone.ru › Ansible 2.6

os_project - Управление проектами OpenStack

Новая в версии 2.0.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

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

Требования

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

  • openstacksdk
  • python >= 2.7

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_timeout
Сколько времени должен ожидать уровень сокета перед истечением времени ожидания для вызовов API. Если это значение опущено, ничего не будет передано в библиотеку запросов.
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.
description
Описание проекта
domain_id
Идентификатор домена для создания проекта в облаке, если облако поддерживает домены.

псевдонимы: domain
enabled
bool
    Варианты:
  • no
  • yes ←
Проект включён
interface
(добавлен в 2.3)
    Варианты:
  • public ←
  • internal
  • admin
Тип URL конечной точки для извлечения из каталога служб.

псевдонимы: endpoint_type
key
Путь к ключу клиента для использования в рамках транзакции SSL.
name
обязательно
Имя проекта
region_name
Имя региона.
state
    Варианты:
  • present ←
  • absent
Должен ли ресурс присутствовать или отсутствовать.
timeout По умолчанию:
180
Сколько времени Ansible должно ожидать запрошенного ресурса.
verify
bool
    Варианты:
  • no
  • yes
Требуется ли проверка запросов API SSL. До версии 2.3 по умолчанию было True.

псевдонимы: validate_certs
wait
bool
    Варианты:
  • no
  • yes ←
Должен ли 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

Примеры

# Create a project
- os_project:
    cloud: mycloud
    state: present
    name: demoproject
    description: demodescription
    domain_id: demoid
    enabled: True

# Delete a project
- os_project:
    cloud: mycloud
    state: absent
    name: demoproject

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

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

Ключ Возвращено Описание
project
сложный
При успехе, когда состояние равно 'present'
Словарь, описывающий проект.

id
строка
Идентификатор проекта

Пример:
f59382db809c43139982ca4189404650
name
строка
Имя проекта

Пример:
demoproject
description
строка
Описание проекта

Пример:
demodescription
enabled
bool
Булево значение, показывающее, включен ли проект

Пример:
True


Статус

Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантирует обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

  • Alberto Gireud (@agireud)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API