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

Примечание

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

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

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

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

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

Краткое описание

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

Требования

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

1and1

Параметры

Параметр	Комментарии
api_url string	Пользовательский URL API. Переопределяет переменную среды ONEANDONE_API_URL.
appliance string	Имя или ID операционной системы для сервера. Требуется только для состояния «present».
auth_token string	Токен аутентификации API, предоставленный 1&1. Переопределяет переменную среды ONEANDONE_AUTH_TOKEN.
auto_increment boolean	При создании нескольких серверов одновременно, следует ли различать имена хостов, добавляя к ним счетчик или заменяя счетчик там, где в строке имени хоста есть %02d или %03d. Варианты: `false` `true` ← (default)
cores_per_processor integer	Количество ядер на процессор. Должно быть указано вместе с параметрами vcore, ram и hdds.
count integer	Количество серверов для создания. Значение по умолчанию: `1`
datacenter string	Местоположение центра обработки данных. Варианты: `"US"` ← (default) `"ES"` `"DE"` `"GB"`
description string	Описание сервера.
firewall_policy string	Имя или ID политики брандмауэра.
fixed_instance_size string	Имя или ID размера экземпляра сервера. Требуется только для состояния «present» и взаимоисключается с параметрами vcore, cores_per_processor, ram и hdds. Доступные варианты: `S`, `M`, `L`, `XL`, `XXL`, `3XL`, `4XL`, `5XL`
hdds list / elements=dictionary	Список жестких дисков со вложенными свойствами «size» и «is_main». Должно быть указано вместе с параметрами vcore, cores_per_processor и ram.
hostname string	Имя хоста или ID сервера. Используется только когда состояние равно «present».
load_balancer string	Имя или ID балансировщика нагрузки.
monitoring_policy string	Имя или ID политики мониторинга.
private_network string	Имя или ID частной сети.
ram float	Объём оперативной памяти. Должно быть указано вместе с параметрами vcore, cores_per_processor и hdds.
server string	Идентификатор сервера (ID или имя хоста). Требуется для всех состояний, кроме «running» и «present».
server_type string	Тип сервера, который будет создан. Варианты: `"cloud"` ← (default) `"baremetal"` `"k8s_node"`
ssh_key any	Открытый SSH-ключ пользователя (содержание, а не путь).
state string	Определяет состояние сервера для его создания, удаления, запуска или остановки. Варианты: `"present"` ← (default) `"absent"` `"running"` `"stopped"`
vcore integer	Общее количество процессоров. Должно быть указано вместе с параметрами cores_per_processor, ram и hdds.
wait boolean	Ожидать, пока сервер не перейдет в состояние «running», прежде чем возвращаться. Также используется для операции удаления (установите значение «false», если вы не хотите ждать, пока каждый отдельный сервер будет удален, прежде чем переходить к другим задачам). Варианты: `false` `true` ← (default)

wait_interval integer	Определяет количество секунд ожидания при использовании методов wait_for По умолчанию: `5`
wait_timeout integer	Сколько времени ждать, прежде чем ожидание будет прервано, в секундах По умолчанию: `600`

Атрибуты

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

Примеры

- 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: true
    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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/oneandone_server_module.html