cs_affinitygroup – Управляет группами сродства на облаках на основе Apache CloudStack

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

Обзор

Создание и удаление групп сродства.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

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

Примечания

Примечание

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

Примеры

- name: Create a affinity group
  cs_affinitygroup:
    name: haproxy
    affinity_type: host anti-affinity
  delegate_to: localhost

- name: Remove a affinity group
  cs_affinitygroup:
    name: haproxy
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращённое значение	Описание
account строка	успех	Аккаунт, к которому относится группа сродства. Пример: example account
affinity_type строка	успех	Тип группы сродства. Пример: host anti-affinity
description строка	успех	Описание группы сродства. Пример: application affinity group
domain строка	успех	Домен, к которому относится группа сродства. Пример: example domain
id строка	успех	UUID группы сродства. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
name строка	успех	Имя группы сродства. Пример: app
project строка	успех	Имя проекта, к которому относится группа сродства. Пример: Production

Статус

Этот модуль гарантирует обратную совместимость изменений интерфейса в дальнейшем. [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_affinitygroup_module.html