Spec-Zone.ru › Ansible 2.9

ovirt_instance_type – Модуль для управления типами экземпляров в oVirt/RHV

Новая версия с 2.8.

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

Обзор

  • Этот модуль управляет всем жизненным циклом типа экземпляра в oVirt/RHV.

Требования

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

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth
словарь / обязательно
Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt:
ca_file
строка
Файл PEM, содержащий доверенные сертификаты CA.
Сертификат, представленный сервером, будет проверен с помощью этих сертификатов CA.
Если параметр ca_file не задан, используется системное хранилище сертификатов CA.
Значение по умолчанию задано переменной окружения OVIRT_CAFILE.
headers
словарь
Словарь HTTP-заголовков, которые нужно добавить к каждому API-запросу.
hostname
строка
Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`.
Значение по умолчанию задано переменной окружения OVIRT_HOSTNAME.
Необходимо указать либо url, либо hostname.
insecure
булево
    Варианты:
  • нет
  • да
Флаг булевого типа, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.
kerberos
булево
    Варианты:
  • нет
  • да
Флаг булевого типа, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.
password
строка / обязательно
Пароль пользователя.
Значение по умолчанию задано переменной окружения OVIRT_PASSWORD.
token
строка
Токен, используемый вместо входа с именем пользователя и паролем.
Значение по умолчанию задано переменной окружения OVIRT_TOKEN.
url
строка
Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`.
Значение по умолчанию задано переменной окружения OVIRT_URL.
Необходимо указать либо url, либо hostname.
username
строка / обязательно
Имя пользователя, например admin@internal.
Значение по умолчанию задано переменной окружения OVIRT_USERNAME.
ballooning_enabled
булево
    Варианты:
  • нет
  • да
Если истина, использовать надувание памяти.
Надувание памяти — это виртуальное устройство, которое может использоваться для перераспределения/возврата памяти хоста в зависимости от потребностей экземпляра динамическим способом. Таким образом можно создавать состояния перераспределения памяти.
boot_devices
-
    Варианты:
  • cdrom
  • hd
  • network
Список устройств загрузки, которые должны использоваться для загрузки. Например [ cdrom, hd ].
Значение по умолчанию задано движком oVirt/RHV.
cpu_cores
-
Количество виртуальных ядер процессора типа экземпляра.
Значение по умолчанию задано движком oVirt/RHV.
cpu_mode
-
Режим процессора типа экземпляра. Он может быть следующим: host_passthrough, host_model или custom.
Для типа процессора host_passthrough необходимо установить placement_policy в pinned.
Если значение не указано, значение по умолчанию задано движком oVirt/RHV.
cpu_pinning
-
Топология закрепления процессора для сопоставления процессора типа экземпляра с процессором хоста.
Топология закрепления процессора — это список словарей, которые могут иметь следующие значения:
cpu - Номер процессора хоста.
vcpu - Номер процессора типа экземпляра.
cpu_sockets
-
Количество виртуальных сокетов процессора типа экземпляра.
Значение по умолчанию задано движком oVirt/RHV.
cpu_threads
-
Количество виртуальных нитей процессора типа экземпляра.
Значение по умолчанию задано движком oVirt/RHV.
description
-
Описание типа экземпляра.
fetch_nested
булево
    Варианты:
  • нет
  • да
Если истина, модуль получит дополнительные данные из API.
Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes.
graphical_console
-
Назначить графический консоль типу экземпляра.
Графический консоль — это словарь, который может иметь следующие значения:
headless_mode - Если истина, отключить графический консоль для данного типа экземпляра.
protocol - Графический протокол, список из spice, vnc или обоих.
high_availability
булево
    Варианты:
  • нет
  • да
Если да, тип экземпляра будет задан как высокодоступный.
Если нет, тип экземпляра не будет задан как высокодоступный.
Если значение не указано, значение по умолчанию задано движком oVirt/RHV.
high_availability_priority
-
Указывает приоритет типа экземпляра в очередях запуска и миграции. Тип экземпляра с более высоким приоритетом будет запущен и мигрирован до типов экземпляров с более низким приоритетом. Значение — целое число от 0 до 100. Чем выше значение, тем выше приоритет.
Если значение не указано, значение по умолчанию задано движком oVirt/RHV.
host
-
Указать хост, на котором должен выполняться тип экземпляра. По умолчанию хост выбирается планировщиком движка.
Этот параметр используется только когда state равен running или present.
id
-
Идентификатор типа экземпляра для управления.
io_threads
-
Количество потоков ввода-вывода, используемых типом экземпляра. 0 означает отключение потоков ввода-вывода.
memory
-
Объем памяти типа экземпляра. Префикс использует стандарт IEC 60027-2 (например, 1GiB, 1024MiB).
Значение по умолчанию задано движком.
memory_guaranteed
-
Объем минимальной гарантированной памяти типа экземпляра. Префикс использует стандарт IEC 60027-2 (например, 1GiB, 1024MiB).
Параметр memory_guaranteed не может быть ниже параметра memory.
Значение по умолчанию задано движком.
memory_max
-
Верхний предел памяти типа экземпляра, до которого можно выполнить горячую подкачку памяти. Префикс использует стандарт IEC 60027-2 (например, 1GiB, 1024MiB).
Значение по умолчанию задано движком.
name
-
Имя типа экземпляра для управления.
Если тип экземпляра не существует, требуется name. В противном случае можно использовать id или name.
nested_attributes
список
Указывает список атрибутов, которые нужно получить из API.
Этот параметр применяется только если fetch_nested равен true.
nics
-
Список сетевых адаптеров (NIC), которые должны быть подключены к виртуальной машине. NIC описывается следующим словарем.
name - Название сетевого адаптера.
profile_name - Имя профиля, к которому должен быть подключён сетевой адаптер.
interface - Тип сетевого интерфейса. Один из следующих: virtio, e1000, rtl8139, по умолчанию virtio.
mac_address - Пользовательский MAC-адрес сетевого интерфейса, по умолчанию он берётся из пула MAC-адресов.
ПРИМЕЧАНИЕ - Этот параметр используется только тогда, когда state имеет состояние running или present и может только создавать сетевые адаптеры. Чтобы более глубоко управлять сетевыми адаптерами типа виртуальной машины, используйте модуль ovirt_nic вместо этого.
operating_system
-
Операционная система типа виртуальной машины.
Значение по умолчанию устанавливается движком oVirt/RHV.
Возможные значения: debian_7, freebsd, freebsdx64, other, other_linux, other_linux_kernel_4, other_linux_ppc64, other_linux_s390x, other_ppc64, other_s390x, rhcos_x64, rhel_3, rhel_3x64, rhel_4, rhel_4x64, rhel_5, rhel_5x64, rhel_6, rhel_6_9_plus_ppc64, rhel_6_ppc64, rhel_6x64, rhel_7_ppc64, rhel_7_s390x, rhel_7x64, rhel_8x64, rhel_atomic7x64, sles_11, sles_11_ppc64, sles_12_s390x, ubuntu_12_04, ubuntu_12_10, ubuntu_13_04, ubuntu_13_10, ubuntu_14_04, ubuntu_14_04_ppc64, ubuntu_16_04_s390x, windows_10, windows_10x64, windows_2003, windows_2003x64, windows_2008, windows_2008R2x64, windows_2008x64, windows_2012R2x64, windows_2012x64, windows_2016x64, windows_2019x64, windows_7, windows_7x64, windows_8, windows_8x64, windows_xp
placement_policy
-
Настройка политики размещения типа виртуальной машины.
Политика размещения может иметь следующие значения:
migratable - Разрешить ручную и автоматическую миграцию.
pinned - Не разрешать миграцию.
user_migratable - Разрешить только ручную миграцию.
Если значение не передано, используется значение по умолчанию, установленное движком oVirt/RHV.
poll_interval
целое число
По умолчанию:
3
Количество секунд, которое модуль ждёт, прежде чем отправить другой запрос опроса состояния сущности.
rng_bytes
-
Количество байтов, разрешённых к использованию за период.
rng_device
-
Генератор случайных чисел (RNG). Можно выбрать один из следующих устройств: urandom, random или hwrng.
Для выбора hwrng необходимо сначала включить его в кластере.
/dev/urandom используется для версий кластера ≥ 4.1, а /dev/random для версий кластера ≤ 4.0
rng_period
-
Продолжительность одного периода в миллисекундах.
serial_console
булево
    Варианты:
  • нет
  • да
Истина включить консоль VirtIO, ложь - выключить её. По умолчанию выбирается движком oVirt/RHV.
smartcard_enabled
булево
    Варианты:
  • нет
  • да
Если истина, используется аутентификация с помощью смарт-карты.
soundcard_enabled
булево
    Варианты:
  • нет
  • да
Если истина, звуковая карта добавляется к типу виртуальной машины.
state
-
    Варианты:
  • отсутствует
  • наличие ←
Тип виртуальной машины должен быть присутствующим/отсутствующим.
Состояние наличие создаст/обновит тип виртуальной машины и не изменит его состояние, если оно уже существует.
timeout
целое число
По умолчанию:
180
Время в секундах, которое модуль должен ждать, пока виртуальная машина не перейдёт в нужное состояние.
usb_support
булево
    Варианты:
  • нет
  • да
Истина включить поддержку USB, ложь - выключить её. По умолчанию выбирается движком oVirt/RHV.
virtio_scsi
булево
    Варианты:
  • нет
  • да
Если истина, будет включена поддержка virtio scsi.
wait
булево
    Варианты:
  • нет
  • да ←
yes если модуль должен ждать, пока сущность не перейдёт в нужное состояние.
watchdog
-
Назначение устройства watchdog для типа виртуальной машины.
Watchdog - это словарь, который может иметь следующие значения:
model - Модель устройства watchdog. Например: i6300esb, diag288 или null.
action - Действие watchdog, которое должно быть выполнено при срабатывании watchdog. Например: none, reset, poweroff, pause или dump.

Примечания

Примечание

  • Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.0

Примеры

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create instance type
- name: Create instance type
  ovirt_instance_type:
    state: present
    name: myit
    rng_device: hwrng
    rng_bytes: 200
    rng_period: 200
    soundcard_enabled: true
    virtio_scsi: true
    boot_devices:
      - network

# Remove instance type
- ovirt_instance_type:
    state: absent
    name: myit


# Create instance type with predefined memory and cpu limits.
- ovirt_instance_type:
    state: present
    name: myit
    memory: 2GiB
    cpu_cores: 2
    cpu_sockets: 2
    nics:
      - name: nic1

# Enable usb support and serial console
- ovirt_instance_type:
    name: myit
    usb_support: True
    serial_console: True

# Use graphical console with spice and vnc
- name: Create a instance type that has the console configured for both Spice and VNC
  ovirt_instance_type:
    name: myit
    graphical_console:
      protocol:
        - spice
        - vnc

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

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

Ключ Возвращаемое значение Описание
id
строка
При успехе, если тип виртуальной машины найден.
ID типа виртуальной машины, который управляется

Пример:
7de90f31-222c-436c-a1ca-7e655bd5b60c
instancetype
словарь
При успехе, если тип виртуальной машины найден.
Словарь всех атрибутов типа виртуальной машины. Атрибуты типа виртуальной машины можно найти на вашей виртуальной машине oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/instance_type.



Статус

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

Авторы

  • Martin Necas (@mnecas)
  • Ondra Machacek (@machacekondra)

Подсказка

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

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

Spec-Zone.ru

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