Spec-Zone.ru › Ansible

vultr.cloud.bare_metal модуль — Управление виртуальными машинами на Vultr.

Примечание

Этот модуль является частью коллекции vultr.cloud (версия 1.13.0).

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

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

Для использования в плейбуке укажите: vultr.cloud.bare_metal.

Добавлен в vultr.cloud 1.9.0

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

Обзор

  • Управление виртуальными машинами на Vultr.

Параметры

Параметр

Комментарии

activation_email

boolean

Отправлять ли письмо подтверждения активации при готовности виртуальной машины?

Применяется только при создании.

Варианты:

  • false ← (по умолчанию)
  • true

api_endpoint

string

URL конечной точки API (без конечного слэша).

Значение по умолчанию из переменной среды VULTR_API_ENDPOINT.

По умолчанию: "https://api.vultr.com/v2"

api_key

string / обязательно

Ключ API Vultr API.

Значение по умолчанию из переменной среды VULTR_API_KEY.

api_retries

integer

Количество попыток повтора в случае, если Vultr API возвращает HTTP код ошибки, такой как - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Время ожидания шлюза истекло

Значение по умолчанию из переменной среды VULTR_API_RETRIES.

По умолчанию: 5

api_retry_max_delay

integer

Максимальное значение задержки повтора запроса в секундах. Задержка увеличивается экспоненциально.

Значение по умолчанию из переменной среды VULTR_API_RETRY_MAX_DELAY.

По умолчанию: 12

api_timeout

integer

Таймаут HTTP запроса к Vultr API.

Значение по умолчанию из переменной среды VULTR_API_TIMEOUT.

По умолчанию: 180

app

string

Название приложения для развертывания Vultr OneClick приложений.

Взаимоисключительно с image и os.

enable_ipv6

boolean

Включить IPv6 или нет?

Варианты:

  • false
  • true

hostname

string

Имя хоста для присвоения этой виртуальной машине.

image

string

Имя образа для развертывания Vultr Marketplace приложений.

Взаимоисключительно с os и app.

label

aliases: name

string / обязательно

Имя виртуальной машины.

os

string

Название операционной системы.

Взаимоисключительно с image и app.

persistent_pxe

boolean

Включить постоянный PXE или нет?

Варианты:

  • false
  • true

plan

string

Название плана для использования с виртуальной машиной.

Обязательно, если виртуальная машина еще не существует.

region

string / обязательно

Регион развертывания виртуальной машины.

reserved_ipv4

string

IP-адрес плавающего IP-адреса, используемого в качестве основного IP-адреса этой виртуальной машины.

Применяется только при создании.

skip_wait

boolean

добавлено в vultr.cloud 1.13.0

Пропустить ожидание полной готовности экземпляра для доступа.

Варианты:

  • false ← (по умолчанию)
  • true

snapshot

string

Описание или идентификатор снимка.

Применяется только при создании виртуальной машины.

ssh_keys

list / elements=string

Список имен SSH-ключей, передаваемых виртуальной машине при создании.

startup_script

string

Имя или идентификатор скрипта запуска, который выполняется при загрузке.

Применяется только при создании виртуальной машины.

state

string

Состояние виртуальной машины.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
END_OF_DOCUMENT_MARKER

метки

список / элементы=строка

Метки для виртуальной машины.

данные_пользователя

строка

Данные пользователя, передаваемые виртуальной машине.

проверять_сертификаты

логическое

Проверять SSL-сертификаты API Vultr.

Варианты:

  • false
  • true ← (по умолчанию)

vpc2s

список / элементы=строка

Список VPC (VPC 2.0), идентифицируемых по описанию, для назначения виртуальной машине.

Примечания

Примечание

  • Также см. документацию API по адресу https://www.vultr.com/api/.

Примеры

---
- name: Create an bare metal machine using OS
  vultr.cloud.bare_metal:
    label: my web server
    hostname: my-hostname
    user_data: |
      #cloud-config
      packages:
        - nginx
    plan: vbm-4c-32gb
    enable_ipv6: true
    ssh_keys:
      - my ssh key
    vpc2s:
      - my vpc description
    tags:
      - web
      - project-genesis
    region: ams
    os: Debian 12 x64 (bookworm)

- name: Deploy an bare metal machine of a marketplace app
  vultr.cloud.bare_metal:
    label: git-server
    hostname: git
    plan: vbm-4c-32gb
    enable_ipv6: true
    region: ams
    image: Gitea on Ubuntu 20.04

- name: Delete an bare metal machine
  vultr.cloud.bare_metal:
    label: my web server
    region: ams
    state: absent

Значения возврата

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

Ключ

Описание

vultr_api

dictionary

Ответ от Vultr API с некоторыми дополнениями/изменениями.

Возвращается: success

api_endpoint

string

Конечная точка, используемая для запросов API.

Возвращается: success

Пример: "https://api.vultr.com/v2"

api_retries

integer

Максимальное количество повторных попыток для запросов API.

Возвращается: success

Пример: 5

api_retry_max_delay

integer

Задержка экспоненциального отката в секундах между повторными попытками до этого максимального значения задержки.

Возвращается: success

Пример: 12

api_timeout

integer

Таймаут, используемый для запросов API.

Возвращается: success

Пример: 60

vultr_bare_metal

dictionary

Ответ от Vultr API.

Возвращается: success

app_id

integer

ID приложения сервера bare metal.

Возвращается: success

Пример: 37

cpu_count

integer

Количество процессоров сервера bare metal.

Возвращается: success

Пример: 1

date_created

string

Дата создания сервера bare metal.

Возвращается: success

Пример: "2020-10-10T01:56:20+00:00"

default_password

string

Пароль по умолчанию, назначенный при развертывании. Доступен только в течение десяти минут после развертывания.

Возвращается: success

Пример: "examplePassword"

disk

string

Информация о диске сервера bare metal.

Возвращается: success

Пример: "2x 240GB SSD"

enable_ipv6

boolean

Включен ли IPv6 или нет.

Возвращается: success

Пример: true

features

list / elements=string

Особенности сервера bare metal.

Возвращается: success

Пример: ["ddos_protection", "ipv6", "auto_backups"]

gateway_v4

string

Шлюз IPv4.

Возвращается: success

Пример: "95.179.188.1"

id

string

ID сервера bare metal.

Возвращается: success

Пример: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"

image_id

string

ID образа сервера bare metal.

Возвращается: success

Пример: ""

label

string

Метка сервера bare metal.

Возвращается: success

Пример: "my bare metal machine"

mac_address

integer

MAC-адрес сервера bare metal.

Возвращается: success

Пример: 2199756823533

main_ip

string

IPv4 машины bare metal.

Returned: success

Sample: "95.179.189.95"

netmask_v4

string

Netmask IPv4 машины bare metal.

Returned: success

Sample: "255.255.254.0"

os

string

ОС машины bare metal.

Returned: success

Sample: "Application"

os_id

integer

ID ОС машины bare metal.

Returned: success

Sample: 186

plan

string

План машины bare metal.

Returned: success

Sample: "vbm-4c-32gb"

power_status

string

Состояние питания машины bare metal.

Returned: success

Sample: "running"

ram

string

Информация о RAM машины bare metal.

Returned: success

Sample: "32768 MB"

region

string

Регион, в котором была развернута машина bare metal.

Returned: success

Sample: "ews"

status

string

Статус развертывания машины bare metal.

Returned: success

Sample: "active"

tags

list / elements=string

Теги машины bare metal.

Returned: success

Sample: ["my-tag"]

user_data

string

Закодированные в Base64 пользовательские данные (cloud init) машины bare metal.

Returned: success

Sample: "I2Nsb3VkLWNvbmZpZwpwYWNrYWdlczoKICAtIGh0b3AK"

v6_main_ip

string

IPv6 машины bare metal.

Returned: success

Sample: ""

v6_network

string

IPv6 сеть машины bare metal.

Returned: success

Sample: ""

v6_network_size

integer

Размер IPv6 сети машины bare metal.

Returned: success

Sample: 0

vpc2s

list / elements=string

Список подключенных VPC (VPC 2.0).

Returned: success

date_created

string

Дата создания VPC.

Returned: success

Sample: "2020-10-10T01:56:20+00:00"

description

string

Описание VPC.

Returned: success

Sample: "my vpc"

id

string

ID VPC.

Returned: success

Sample: "5536d2a4-66fd-4dfb-b839-7672fd5bc116"

ip_block

string

Блок IP-адресов, назначенный VPC.

Возвращаемое значение: успех

Пример: "10.99.0.0"

prefix_length

integer

Количество бит для маски сети в CIDR-нотации.

Возвращаемое значение: успех

Пример: 24

region

string

Регион, к которому назначен VPC.

Возвращаемое значение: успех

Пример: "ews"

Авторы

  • René Moser (@resmo)

Ссылки на сборку

  • Система отслеживания задач
  • Репозиторий (источники)

© 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/vultr/cloud/bare_metal_module.html

Spec-Zone.ru

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