Spec-Zone.ru › Ansible 2.10

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

Примечание

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

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

Чтобы использовать его в плейбуке, укажите: community.general.oneandone_server.

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

Описание

  • Создать, удалить, обновить, запустить, остановить и перезагрузить сервер 1&1 Host. При создании сервера можно дополнительно дождаться его запуска ('running') перед возвратом.

Требования

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

  • 1and1
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_url
строка
Пользовательский URL API. Переопределяет переменную окружения ONEANDONE_API_URL.
appliance
строка
Имя или ID операционной системы для сервера. Требуется только для состояния '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
строка
Имя или ID политики брандмауэра.
fixed_instance_size
строка
Имя или ID размера экземпляра сервера. Требуется только для состояния '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
строка
Имя хоста или ID сервера. Используется только при состоянии 'present'.
load_balancer
строка
Имя или ID балансировщика нагрузки.
monitoring_policy
строка
Имя или ID политики мониторинга.
private_network
строка
Имя или ID частной сети.
ram
число с плавающей запятой
Объем оперативной памяти. Должен быть указан вместе с параметрами vcore, cores_per_processor и hdds.
server
строка
Идентификатор сервера (ID или имя хоста). Требуется для всех состояний, кроме 'running' и 'present'.
server_type
строка
    Варианты:
  • облачный ←
  • baremetal
  • k8s_node
Тип сервера для создания.
ssh_key
сырой
Открытый ключ SSH пользователя (содержимое, а не путь).
state
строка
    Варианты:
  • настоящий ←
  • отсутствующий
  • работающий
  • остановленный
Определение состояния сервера для создания, удаления, запуска или остановки.
vcore
целое число
Общее количество процессоров. Должно быть указано вместе с параметрами cores_per_processor, ram и hdds.
wait
логическое
    Варианты:
  • no
  • да ←
Дождаться состояния 'running' сервера перед возвратом. Также используется для операции удаления (установите 'false', если не нужно ждать удаления каждого отдельного сервера перед продолжением других задач).
wait_interval
целое число
По умолчанию:
5
Определяет количество секунд ожидания при использовании методов ожидания.
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": "my-server", "id": "server-id"}]


Авторы

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

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

Spec-Zone.ru

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