community.general.clc_server – Создание, удаление, запуск и остановка серверов в CenturyLink Cloud.

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.clc_server.

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

Описание

Модуль Ansible для создания, удаления, запуска и остановки серверов в CenturyLink Cloud.

Требования

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

python = 2.7
requests >= 2.5.0
clc-sdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
add_public_ip boolean	Варианты: нет ← да	Добавить ли публичный IP-адрес к серверу
additional_disks список / элементы=строка	Значение по умолчанию: []	Список дополнительных дисков для сервера
alert_policy_id строка		Политика оповещений, назначаемая серверу. Взаимоисключающее с 'alert_policy_name'.
alert_policy_name строка		Политика оповещений, назначаемая серверу. Взаимоисключающее с 'alert_policy_id'.
alias строка		Псевдоним учетной записи для развертывания серверов.
anti_affinity_policy_id строка		Политика антиаффинити, назначаемая серверу. Взаимоисключающее с 'anti_affinity_policy_name'.
anti_affinity_policy_name строка		Политика антиаффинити, назначаемая серверу. Взаимоисключающее с 'anti_affinity_policy_id'.
configuration_id строка		Требуется только для серверов «bare metal». Указывает идентификатор для конкретного типа конфигурации сервера «bare metal» для развертывания.
count целое число	Значение по умолчанию: 1	Количество серверов для создания (взаимоисключающее с exact_count)
count_group строка		Требуется при указании exact_count. Используемая группа серверов для определения количества развертываемых серверов.
cpu целое число	Значение по умолчанию: 1	Количество ЦП для выделения на сервере
cpu_autoscale_policy_id строка		Политика автоматического масштабирования, назначаемая серверу.
custom_fields список / элементы=строка	Значение по умолчанию: []	Список пользовательских полей для установки на сервере.
description строка		Описание, устанавливаемое для сервера.
exact_count целое число		Идемпотентный режим. Обеспечит, что в указанной группе запустится именно это количество серверов, создавая и удаляя их для достижения этого количества. Требуется установка count_group.
group строка	Значение по умолчанию: "Группа по умолчанию"	Группа серверов для создания серверов.
ip_address строка		IP-адрес сервера. Если не указан, присваивается автоматически.
location строка		Дата-центр для создания серверов.
managed_os boolean	Варианты: нет ← да	Создать сервер как «Управляемый» или нет.
memory целое число	Значение по умолчанию: 1	Память в ГБ.
name строка		Идентификатор длиной от 1 до 6 символов для сервера. Требуется при состоянии 'present'.
network_id строка		UUID сети, в которой нужно создать сервера.
os_type строка	Варианты: redHat6_64Bit centOS6_64Bit windows2012R2Standard_64Bit ubuntu14_64Bit	Требуется только для серверов «bare metal». Указывает ОС для развертывания с сервером «bare metal».
packages список / элементы=строка	Значение по умолчанию: []	Список пакетов шаблонов для запуска на сервере после его создания.
password строка		Пароль администратора/пользователя root
primary_dns строка		Основной DNS, используемый сервером.
public_ip_ports список / элементы=строка	Значение по умолчанию: []	Список портов для разрешения на брандмауэре для публичного IP сервера, если add_public_ip установлено в True.
public_ip_protocol строка	Варианты: TCP ← UDP ICMP	Протокол для использования публичного IP, если add_public_ip установлено в True.
secondary_dns строка		Дополнительный DNS, используемый сервером.
server_ids список / элементы=строка	Значение по умолчанию: []	Требуется для состояний started, stopped и absent. Список идентификаторов серверов, которые необходимо гарантировать запущенными, остановленными или отсутствующими.
source_server_password строка		Пароль исходного сервера, если указан клон.
state строка	Варианты: present ← absent started stopped	Состояние, которое должно быть у ресурсов.
storage_type строка	Варианты: standard ← hyperscale	Тип хранилища, подключаемого к серверу.
template строка		Шаблон для создания сервера. Будет искать шаблон, если предоставлена частичная строка. Требуется при состоянии 'present'.
ttl строка		Срок жизни сервера в секундах. Сервер будет удален по истечении этого времени.
type строка	Варианты: standard ← hyperscale bareMetal	Тип создаваемого сервера.
wait boolean	Варианты: нет да ←	Ожидать завершения задач развертывания перед возвратом.

Примечания

Примечание

Для использования этого модуля необходимо установить следующие переменные среды, которые обеспечивают доступ к CenturyLink Cloud — CLC_V2_API_USERNAME, идентификатор входа в систему для учетной записи CenturyLink Cloud — CLC_V2_API_PASSWORD, пароль для учетной записи CenturyLink Cloud.
В качестве альтернативы модуль принимает токен API и псевдоним учетной записи. Токен API можно сгенерировать с помощью входа в систему и пароля учетной записи CLC через вызов API HTTP по адресу: 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.

Примеры

# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples

- name: Provision a single Ubuntu Server
  community.general.clc_server:
    name: test
    template: ubuntu-14-64
    count: 1
    group: Default Group
    state: present

- name: Ensure 'Default Group' has exactly 5 servers
  community.general.clc_server:
    name: test
    template: ubuntu-14-64
    exact_count: 5
    count_group: Default Group
    group: Default Group

- name: Stop a Server
  community.general.clc_server:
    server_ids:
      - UC1ACCT-TEST01
    state: stopped

- name: Start a Server
  community.general.clc_server:
    server_ids:
      - UC1ACCT-TEST01
    state: started

- name: Delete a Server
  community.general.clc_server:
    server_ids:
      - UC1ACCT-TEST01
    state: absent

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

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

Ключ	Возвращено	Описание
partially_created_server_ids список / элементы=строка	успех	Список идентификаторов серверов, частично созданных Пример: ['UC1TEST-SVR01', 'UC1TEST-SVR02']
server_ids список / элементы=строка	успех	Список идентификаторов серверов, созданных Пример: ['UC1TEST-SVR01', 'UC1TEST-SVR02']
servers список / элементы=строка	успех	Список объектов серверов, возвращённых из CLC Пример: [{'changeInfo': {'createdBy': 'service.wfad', 'createdDate': 1438196820, 'modifiedBy': 'service.wfad', 'modifiedDate': 1438196820}, 'description': 'test-сервер', 'details': {'alertPolicies': [], 'cpu': 1, 'customFields': [], 'diskCount': 3, 'disks': [{'id': '0:0', 'partitionPaths': [], 'sizeGB': 1}, {'id': '0:1', 'partitionPaths': [], 'sizeGB': 2}, {'id': '0:2', 'partitionPaths': [], 'sizeGB': 14}], 'hostName': '', 'inMaintenanceMode': False, 'ipAddresses': [{'internal': '10.1.1.1'}], 'memoryGB': 1, 'memoryMB': 1024, 'partitions': [], 'powerState': 'started', 'snapshots': [], 'storageGB': 17}, 'groupId': '086ac1dfe0b6411989e8d1b77c4065f0', 'id': 'test-сервер', 'ipaddress': '10.120.45.23', 'isTemplate': False, 'links': [{'href': '/v2/servers/wfad/test-сервер', 'id': 'test-сервер', 'rel': 'self', 'verbs': ['GET', 'PATCH', 'DELETE']}, {'href': '/v2/groups/wfad/086ac1dfe0b6411989e8d1b77c4065f0', 'id': '086ac1dfe0b6411989e8d1b77c4065f0', 'rel': 'group'}, {'href': '/v2/accounts/wfad', 'id': 'wfad', 'rel': 'account'}, {'href': '/v2/billing/wfad/serverPricing/test-сервер', 'rel': 'billing'}, {'href': '/v2/servers/wfad/test-сервер/publicIPAddresses', 'rel': 'publicIPAddresses', 'verbs': ['POST']}, {'href': '/v2/servers/wfad/test-сервер/credentials', 'rel': 'credentials'}, {'href': '/v2/servers/wfad/test-сервер/statistics', 'rel': 'statistics'}, {'href': '/v2/servers/wfad/510ec21ae82d4dc89d28479753bf736a/upcomingScheduledActivities', 'rel': 'upcomingScheduledActivities'}, {'href': '/v2/servers/wfad/510ec21ae82d4dc89d28479753bf736a/scheduledActivities', 'rel': 'scheduledActivities', 'verbs': ['GET', 'POST']}, {'href': '/v2/servers/wfad/test-сервер/capabilities', 'rel': 'capabilities'}, {'href': '/v2/servers/wfad/test-сервер/alertPolicies', 'rel': 'alertPolicyMappings', 'verbs': ['POST']}, {'href': '/v2/servers/wfad/test-сервер/antiAffinityPolicy', 'rel': 'antiAffinityPolicyMapping', 'verbs': ['PUT', 'DELETE']}, {'href': '/v2/servers/wfad/test-сервер/cpuAutoscalePolicy', 'rel': 'cpuAutoscalePolicyMapping', 'verbs': ['PUT', 'DELETE']}], 'locationId': 'UC1', 'name': 'test-сервер', 'os': 'ubuntu14_64Bit', 'osType': 'Ubuntu 14 64-разрядный', 'status': 'active', 'storageType': 'standard', 'type': 'standard'}]

Авторы

CLC Runner (@clc-runner)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/clc_server_module.html