community.general.oneandone_server – Создание, удаление, запуск, остановка и перезагрузка сервера 1&1 Host.

Примечание

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

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

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

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

Описание

Создание, удаление, обновление, запуск, остановка и перезагрузка сервера 1&1 Host. При создании сервера можно выбрать ожидание его перехода в состояние «работает» перед возвратом.

Требования

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

1and1
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_url строка		Пользовательский URL API. Переопределяет переменную окружения ONEANDONE_API_URL.
appliance строка		Имя или идентификатор операционной системы для сервера. Требуется только для состояния 'present'.
auth_token строка		Токен API аутентификации, предоставленный 1&1. Переопределяет переменную окружения ONEANDONE_AUTH_TOKEN.
auto_increment логическое значение	Варианты: no да ←	При одновременном создании нескольких серверов, следует ли различать имена хостов, добавляя счётчик после них, или заменяя счётчик в строке имени хоста, где присутствует %02d или %03d.
cores_per_processor целое число		Количество ядер на процессор. Должен быть указан вместе с параметрами vcore, ram и hdds.
count целое число	Значение по умолчанию: 1	Количество серверов для создания.
datacenter строка	Варианты: США ← Испания Германия Великобритания	Расположение дата-центра.
description строка		Описание сервера.
firewall_policy строка		Имя или идентификатор политики брандмауэра.
fixed_instance_size строка		Имя или идентификатор размера виртуальной машины сервера. Требуется только для состояния 'present', и взаимно исключает параметры vcore, cores_per_processor, ram и hdds. Доступные варианты: `S`, `M`, `L`, `XL`, `XXL`, `3XL`, `4XL`, `5XL`.
hdds список / элементы=строка		Список жёстких дисков с вложенными свойствами "size" и "is_main". Требуется вместе с параметрами vcore, cores_per_processor и ram.
hostname строка		Имя хоста или идентификатор сервера. Используется только при состоянии 'present'.
load_balancer строка		Имя или идентификатор балансировщика нагрузки.
monitoring_policy строка		Имя или идентификатор политики мониторинга.
private_network строка		Имя или идентификатор частной сети.
ram вещественное число		Объем оперативной памяти. Должен быть указан вместе с параметрами vcore, cores_per_processor и hdds.
server строка		Идентификатор сервера (ID или имя хоста). Требуется для всех состояний, кроме 'running' и 'present'.
server_type строка	Варианты: облачный ← baremetal k8s_node	Тип сервера для создания.
ssh_key сырые данные		Открытый ключ SSH пользователя (содержимое, а не путь).
state строка	Варианты: present ← absent running stopped	Определите состояние сервера для создания, удаления, запуска или остановки.
vcore целое число		Общее количество процессоров. Должен быть указан вместе с параметрами cores_per_processor, ram и hdds.
wait логическое значение	Варианты: no да ←	Ожидать, пока сервер перейдёт в состояние 'running' перед возвратом. Также используется для операции удаления (установите 'false', если вы не хотите ждать удаления каждого отдельного сервера перед продолжением других задач.)
wait_interval целое число	Значение по умолчанию: 5	Определяет количество секунд ожидания при использовании методов wait_for.
wait_timeout целое число	Значение по умолчанию: 600	Время ожидания, прежде чем ожидание прекратится (в секундах).

Примеры

- name: Create three servers and enumerate their names
  community.general.oneandone_server:
    auth_token: oneandone_private_api_key
    hostname: node%02d
    fixed_instance_size: XL
    datacenter: US
    appliance: C5A349786169F140BCBC335675014C08
    auto_increment: true
    count: 3

- name: Create three servers, passing in an ssh_key
  community.general.oneandone_server:
    auth_token: oneandone_private_api_key
    hostname: node%02d
    vcore: 2
    cores_per_processor: 4
    ram: 8.0
    hdds:
      - size: 50
        is_main: false
    datacenter: ES
    appliance: C5A349786169F140BCBC335675014C08
    count: 3
    wait: yes
    wait_timeout: 600
    wait_interval: 10
    ssh_key: SSH_PUBLIC_KEY

- name: Removing server
  community.general.oneandone_server:
    auth_token: oneandone_private_api_key
    state: absent
    server: 'node01'

- name: Starting server
  community.general.oneandone_server:
    auth_token: oneandone_private_api_key
    state: running
    server: 'node01'

- name: Stopping server
  community.general.oneandone_server:
    auth_token: oneandone_private_api_key
    state: stopped
    server: 'node01'

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

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

Ключ	Возвращаемое значение	Описание
servers список / элементы=строка	всегда	Информация о каждом обработанном сервере. Пример: [{"hostname": "мой-сервер", "id": "идентификатор-сервера"}]

Авторы

Amel Ajdinovic (@aajdinov)
Ethan Devenport (@edevenport)

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