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

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

Описание

Модуль 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 -		Уникальный идентификатор сети для создания серверов.
os_type -	Варианты: redHat6_64Bit centOS6_64Bit windows2012R2Standard_64Bit ubuntu14_64Bit	Необязательно для серверов bare metal. Указывает операционную систему для предоставления сервера bare metal.
packages -	По умолчанию: []	Список пакетов blue print для запуска на сервере после его создания.
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 -	Варианты: стандартный ← гипермасштабирование	Тип хранилища, подключаемого к серверу.
template -		Шаблон для создания сервера. Будет искать шаблон, если предоставлена частичная строка. Требуется, когда состояние 'present'.
ttl -		Время жизни сервера в секундах. Сервер будет удалён по истечении этого времени.
type -	Варианты: стандартный ← гипермасштабирование bareMetal	Тип создаваемого сервера.
wait boolean	Варианты: нет да ←	Ожидать ли завершения задач предоставления перед возвратом.

Примечания

Примечание

Для использования данного модуля необходимо установить следующие переменные среды, которые обеспечивают доступ к облаку Centurylink - CLC_V2_API_USERNAME, идентификатор входа в учетную запись облака Centurylink - CLC_V2_API_PASSWORD, пароль к учетной записи облака Centurylink.
В качестве альтернативы, модуль принимает токен 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.
Пользователи могут установить 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
  clc_server:
    name: test
    template: ubuntu-14-64
    count: 1
    group: Default Group
    state: present

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

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

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

- name: Delete a Server
  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-server', '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-server', 'ipaddress': '10.120.45.23', 'isTemplate': False, 'links': [{'href': '/v2/servers/wfad/test-server', 'id': 'test-server', '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-server', 'rel': 'billing'}, {'href': '/v2/servers/wfad/test-server/publicIPAddresses', 'rel': 'publicIPAddresses', 'verbs': ['POST']}, {'href': '/v2/servers/wfad/test-server/credentials', 'rel': 'credentials'}, {'href': '/v2/servers/wfad/test-server/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-server/capabilities', 'rel': 'capabilities'}, {'href': '/v2/servers/wfad/test-server/alertPolicies', 'rel': 'alertPolicyMappings', 'verbs': ['POST']}, {'href': '/v2/servers/wfad/test-server/antiAffinityPolicy', 'rel': 'antiAffinityPolicyMapping', 'verbs': ['PUT', 'DELETE']}, {'href': '/v2/servers/wfad/test-server/cpuAutoscalePolicy', 'rel': 'cpuAutoscalePolicyMapping', 'verbs': ['PUT', 'DELETE']}], 'locationId': 'UC1', 'name': 'test-server', 'os': 'ubuntu14_64Bit', 'osType': 'Ubuntu 14 64-bit', 'status': 'active', 'storageType': 'standard', 'type': 'standard'}]

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

CLC Runner (@clc-runner)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/clc_server_module.html