Модуль community.general.clc_group – Создание/удаление групп серверов в Centurylink Cloud

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Чтобы использовать его в книге задач, укажите: community.general.clc_group.

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

Описание

Создание или удаление групп серверов в облаке Centurylink Centurylink Cloud

Требования

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

python = 2.7
requests >= 2.5.0
clc-sdk

Параметры

Параметр	Комментарии
описание строка	Описание группы серверов
местоположение строка	Центр обработки данных для создания группы. Если местоположение не указано, группа создается в центре обработки данных по умолчанию, связанном со счетом
имя строка / обязательно	Имя группы серверов
родитель строка	Родительская группа группы серверов. Если родитель не указан, группа создается на верхнем уровне.
состояние строка	Действие по созданию или удалению группы Варианты: `"present"` ← (по умолчанию) `"absent"`
ждать логический	Дожидаться завершения задач перед возвратом. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме проверки и возвращать предсказание изменений состояния без модификации цели.
diff_mode	Поддержка: нет	Возвращает подробности о внесенных изменениях (или, возможно, необходимых изменениях в `check_mode`) в режиме сравнения.

Примечания

Примечание

Для использования этого модуля необходимо установить следующие переменные среды, которые обеспечивают доступ к Centurylink Cloud – CLC_V2_API_USERNAME, идентификатор входа в учетную запись Centurylink Cloud – CLC_V2_API_PASSWORD, пароль к учетной записи Centurylink Cloud.
В качестве альтернативы модуль принимает токен API и псевдоним учетной записи. Токен API можно сгенерировать, используя логин и пароль учетной записи CLC через вызов HTTP API по адресу https://api.ctl.io/v2/authentication/login - CLC_V2_API_TOKEN, токен API, сгенерированный с помощью https://api.ctl.io/v2/authentication/login - CLC_ACCT_ALIAS, псевдоним учетной записи, связанный с Centurylink Cloud.
Пользователи могут установить CLC_V2_API_URL для указания конечной точки, указывающей на другую среду CLC.

Примеры

# Create a Server Group

---
- name: Create Server Group
  hosts: localhost
  gather_facts: false
  connection: local
  tasks:
    - name: Create / Verify a Server Group at CenturyLink Cloud
      community.general.clc_group:
        name: My Cool Server Group
        parent: Default Group
        state: present
      register: clc

    - name: Debug
      ansible.builtin.debug:
        var: clc

# Delete a Server Group
- name: Delete Server Group
  hosts: localhost
  gather_facts: false
  connection: local
  tasks:
    - name: Delete / Verify Absent a Server Group at CenturyLink Cloud
      community.general.clc_group:
        name: My Cool Server Group
        parent: Default Group
        state: absent
      register: clc

    - name: Debug
      ansible.builtin.debug:
        var: clc

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

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

Ключ	Описание
группа словарь	Информация о группе Возвращаемое: успех Пример: {"changeInfo": {"createdBy": "service.wfad", "createdDate": "2015-07-29T18:52:47Z", "modifiedBy": "service.wfad", "modifiedDate": "2015-07-29T18:52:47Z"}, "customFields": [], "description": "test group", "groups": [], "id": "bb5f12a3c6044ae4ad0a03e73ae12cd1", "links": [{"href": "/v2/groups/wfad", "rel": "createGroup", "verbs": ["POST"]}, {"href": "/v2/servers/wfad", "rel": "createServer", "verbs": ["POST"]}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1", "rel": "self", "verbs": ["GET", "PATCH", "DELETE"]}, {"href": "/v2/groups/wfad/086ac1dfe0b6411989e8d1b77c4065f0", "id": "086ac1dfe0b6411989e8d1b77c4065f0", "rel": "parentGroup"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/defaults", "rel": "defaults", "verbs": ["GET", "POST"]}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/billing", "rel": "billing"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/archive", "rel": "archiveGroupAction"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/statistics", "rel": "statistics"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/upcomingScheduledActivities", "rel": "upcomingScheduledActivities"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/horizontalAutoscalePolicy", "rel": "horizontalAutoscalePolicyMapping", "verbs": ["GET", "PUT", "DELETE"]}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/scheduledActivities", "rel": "scheduledActivities", "verbs": ["GET", "POST"]}], "locationId": "UC1", "name": "test group", "status": "active", "type": "default"}

Ключ

Описание

группа

словарь

Информация о группе

Возвращаемое: успех

Пример: {"changeInfo": {"createdBy": "service.wfad", "createdDate": "2015-07-29T18:52:47Z", "modifiedBy": "service.wfad", "modifiedDate": "2015-07-29T18:52:47Z"}, "customFields": [], "description": "test group", "groups": [], "id": "bb5f12a3c6044ae4ad0a03e73ae12cd1", "links": [{"href": "/v2/groups/wfad", "rel": "createGroup", "verbs": ["POST"]}, {"href": "/v2/servers/wfad", "rel": "createServer", "verbs": ["POST"]}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1", "rel": "self", "verbs": ["GET", "PATCH", "DELETE"]}, {"href": "/v2/groups/wfad/086ac1dfe0b6411989e8d1b77c4065f0", "id": "086ac1dfe0b6411989e8d1b77c4065f0", "rel": "parentGroup"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/defaults", "rel": "defaults", "verbs": ["GET", "POST"]}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/billing", "rel": "billing"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/archive", "rel": "archiveGroupAction"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/statistics", "rel": "statistics"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/upcomingScheduledActivities", "rel": "upcomingScheduledActivities"}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/horizontalAutoscalePolicy", "rel": "horizontalAutoscalePolicyMapping", "verbs": ["GET", "PUT", "DELETE"]}, {"href": "/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/scheduledActivities", "rel": "scheduledActivities", "verbs": ["GET", "POST"]}], "locationId": "UC1", "name": "test group", "status": "active", "type": "default"}

Авторы

CLC Runner (@clc-runner)

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

© 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/community/general/clc_group_module.html