cs_project – Управляет проектами на облаках Apache CloudStack

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

Обзор

Создание, обновление, приостановка, активация и удаление проектов.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится проект.
api_http_method строка	Варианты: get post	HTTP-метод, используемый для запроса к API-точке. Если не указан, используется переменная среды `CLOUDSTACK_METHOD`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию - `get`, если не указано.
api_key строка		API-ключ API CloudStack. Если не указан, используется переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region строка	По умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не указано, используется переменная среды `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ API CloudStack. Если не задан, используется переменная среды `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не задан, используется переменная среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию - 10 секунд, если не указано.
api_url строка		URL API CloudStack, например, https://cloud.example.com/client/api. Если не указан, используется переменная среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
display_text строка		Текст для отображения проекта. Если не указано, в качестве display_text используется name.
domain строка		Домен, к которому относится проект.
name строка / обязательно		Имя проекта.
poll_async логическое значение	Варианты: no да ←	Проверять асинхронные задачи до завершения.
state строка	Варианты: present ← absent active suspended	Состояние проекта.
tags список		Список тегов. Теги — список словарей, содержащих ключи key и value. Если нужно удалить все теги, установите пустой список, например, tags: []. псевдонимы: тег

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация читается из нескольких мест в указанном порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная среды CLOUDSTACK_CONFIG, указывающая на файл .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Дополнительно можно указать несколько учетных данных и конечных точек с помощью разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется раздел cloudstack. Более подробная информация доступна по адресу https://github.com/exoscale/cs.
Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: Create a project
  cs_project:
    name: web
    tags:
      - { key: admin, value: john }
      - { key: foo,   value: bar }
  delegate_to: localhost

- name: Rename a project
  cs_project:
    name: web
    display_text: my web project
  delegate_to: localhost

- name: Suspend an existing project
  cs_project:
    name: web
    state: suspended
  delegate_to: localhost

- name: Activate an existing project
  cs_project:
    name: web
    state: active
  delegate_to: localhost

- name: Remove a project
  cs_project:
    name: web
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
account строка	success	Аккаунт, к которому относится проект. Пример: example account
display_text строка	success	Текст для отображения проекта. Пример: web project
domain строка	success	Домен, к которому относится проект. Пример: example domain
id строка	success	UUID проекта. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name строка	success	Имя проекта. Пример: web project
state строка	success	Состояние проекта. Пример: Active
tags список	success	Список тегов ресурсов, связанных с проектом. Пример: [ { "key": "foo", "value": "bar" } ]

Статус

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

Авторы

René Moser (@resmo)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cs_project_module.html