Spec-Zone.ru › Ansible 2.7

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

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

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

Обзор

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

Требования

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

  • openstacksdk
  • python >= 2.7

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_timeout
-
Сколько времени должно ждать сокетное соединение перед истечением времени ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку requests.
auth
-
Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password, это будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей, этот параметр должен содержать любые параметры, необходимые этому подключаемому модулю. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды 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
boolean
    Варианты:
  • нет
  • да ←
Включен ли проект
interface
-
добавлен в 2.3
    Варианты:
  • public ←
  • internal
  • admin
Тип URL-адреса конечной точки для получения из каталога услуг.

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

псевдонимы: validate_certs
wait
boolean
    Варианты:
  • нет
  • да ←
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
    endpoint_type: admin
    state: present
    name: demoproject
    description: demodescription
    domain_id: demoid
    enabled: True

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

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

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

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

description
строка
Описание проекта

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

Пример:
True
id
строка
Идентификатор проекта

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

Пример:
demoproject


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.7/modules/os_project_module.html

Spec-Zone.ru

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