cs_affinitygroup – Управляет группами родства на облаках на базе Apache CloudStack
Новая версия с 2.0.
Обзор
- Создание и удаление групп родства.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится группа родства. | |
| affinity_type строка | Тип группы родства. Если не указан, используется первый найденный тип. псевдонимы: affinty_type | |
| api_http_method строка |
| Метод HTTP, используемый для запроса к API-точке входа. Если не задан, используется переменная среды CLOUDSTACK_METHOD. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию — get, если не задано. |
| api_key строка | Ключ API CloudStack API. Если не задан, используется переменная среды CLOUDSTACK_KEY. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. | |
| api_region строка | По умолчанию: "cloudstack" | Имя раздела в файле конфигурации 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 строка |
| Состояние группы родства. |
Примечания
Примечание
- 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 строка | success | Аккаунт, к которому относится группа родства. Пример: example account |
| affinity_type строка | success | Тип группы родства. Пример: host anti-affinity |
| description строка | success | Описание группы родства. Пример: application affinity group |
| domain строка | success | Домен, к которому относится группа родства. Пример: example domain |
| id строка | success | UUID группы родства. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 |
| name строка | success | Название группы родства. Пример: app |
| project строка | success | Название проекта, к которому относится группа родства. Пример: 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.8/modules/cs_affinitygroup_module.html