Spec-Zone.ru › Ansible

Модуль cloudscale_ch.cloud.server_group — Управляет группами серверов на сервисе cloudscale.ch IaaS

Примечание

Этот модуль является частью коллекции cloudscale_ch.cloud (версия 2.4.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cloudscale_ch.cloud.

Для использования в playbook укажите: cloudscale_ch.cloud.server_group.

Добавлена в cloudscale_ch.cloud 1.0.0

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

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

Псевдонимы: cloudscale_server_group

Параметры

Параметр

Комментарии

api_timeout

целое число

Время ожидания в секундах для вызовов API cloudscale.ch.

Его также можно передать в переменной среды CLOUDSCALE_API_TIMEOUT.

По умолчанию: 45

api_token

строка / обязательный

Токен API cloudscale.ch.

Его также можно передать в переменной среды CLOUDSCALE_API_TOKEN.

api_url

строка

добавлено в cloudscale_ch.cloud 1.3.0

URL API cloudscale.ch.

Его также можно передать в переменной среды CLOUDSCALE_API_URL.

По умолчанию: "https://api.cloudscale.ch/v1"

name

строка

Название группы серверов.

Требуется либо name, либо uuid. Эти параметры взаимоисключающие.

state

строка

Состояние группы серверов.

Выбираемые значения:

  • "present" ← (по умолчанию)
  • "absent"

tags

словарь

Теги, связанные с группами серверов. Установите в значение {} для удаления всех тегов.

type

строка

Тип группы серверов.

По умолчанию: "anti-affinity"

uuid

строка

UUID группы серверов.

Требуется либо name, либо uuid. Эти параметры взаимоисключающие.

zone

строка

Код зоны группы серверов (например, lpg1 или rma1).

Примечания

Примечание

  • Все операции выполняются с использованием публичного API cloudscale.ch v1.
  • Подробная информация доступна в полной документации API: https://www.cloudscale.ch/en/api/v1.
  • Для всех операций требуется действительный токен API. Вы можете создать любое количество токенов, используя панель управления cloudscale.ch по адресу https://control.cloudscale.ch.

Примеры

---
- name: Ensure server group exists
  cloudscale_ch.cloud.server_group:
    name: my-name
    type: anti-affinity
    api_token: xxxxxx

- name: Ensure server group in a specific zone
  cloudscale_ch.cloud.server_group:
    name: my-rma-group
    type: anti-affinity
    zone: lpg1
    api_token: xxxxxx

- name: Ensure a server group is absent
  cloudscale_ch.cloud.server_group:
    name: my-name
    state: absent
    api_token: xxxxxx

Значения возврата

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

Ключ

Описание

href

строка

API-URL для получения подробной информации о группе серверов

Возвращается: при наличии

Пример: "https://api.cloudscale.ch/v1/server-group/cfde831a-4e87-4a75-960f-89b0148aa2cc"

name

строка

Отображаемое имя группы серверов

Возвращается: всегда

Пример: "load balancers"

servers

список / элементы=строка

Список серверов, входящих в группу серверов.

Возвращается: при наличии

Пример: []

state

строка

Состояние группы серверов.

Возвращается: всегда

Пример: "present"

tags

словарь

Теги, связанные с группой серверов.

Возвращается: при успехе

Пример: {"project": "my project"}

type

строка

Тип группы серверов

Возвращается: при наличии

Пример: "anti-affinity"

uuid

строка

Уникальный идентификатор данного сервера

Возвращается: всегда

Пример: "cfde831a-4e87-4a75-960f-89b0148aa2cc"

zone

словарь

Зона группы серверов

Возвращается: при успехе

Пример: {"slug": "rma1"}

Авторы

  • René Moser (@resmo)
  • Denis Krienbühl (@href)

Ссылки на коллекции

  • Система отслеживания задач
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cloudscale_ch/cloud/server_group_module.html

Spec-Zone.ru

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