Spec-Zone.ru › Ansible 2.9

ovirt_host – Модуль управления хостами в oVirt/RHV

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

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

  • Модуль управления хостами в oVirt/RHV

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
activate
boolean
добавлен в 2.4
    Варианты:
  • нет
  • да ←
Если state присутствует, активировать хост.
Этот параметр полезно отключить, если вы не хотите изменять состояние хоста при использовании присутствия state.
address
-
Адрес хоста. Может быть полным доменным именем (предпочтительно) или IP-адресом.
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
boolean
    Варианты:
  • нет
  • да
Флаг boolean, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста.
kerberos
boolean
    Варианты:
  • нет
  • да
Флаг boolean, указывающий, нужно ли использовать аутентификацию 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.
check_upgrade
boolean
добавлен в 2.4
    Варианты:
  • нет
  • да ←
Если true и state обновлен, выполнить проверку на обновление перед выполнением действия обновления.
cluster
-
Имя кластера, в котором должен быть создан хост.
comment
-
Описание хоста.
fetch_nested
boolean
    Варианты:
  • нет
  • да
Если True, модуль получит дополнительные данные из API.
Он получит идентификаторы дисков, снимков и т.д. виртуальных машин. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes.
force
boolean
    Варианты:
  • нет ←
  • да
Указывает, что хост должен быть удален, даже если он не отвечает или является частью кластера Gluster Storage и имеет на нём тома.
ПРЕДУПРЕЖДЕНИЕ: Это не принудительно удаляет хост, если в это же время на нём выполняется другая операция, связанная с хостом.
hosted_engine
-
    Варианты:
  • развернуть
  • снятие с развертывания
Если развернуть, это означает, что этот хост также должен развернуть компоненты hosted engine.
Если снятие с развертывания, это означает, что этот хост должен снять с развертывания компоненты hosted engine, и этот хост не будет работать как часть кластера высокой доступности.
id
-
добавлен в 2.8
Идентификатор хоста для управления.
iscsi
-
добавлен в 2.4
Если state iscsidiscover, это означает, что атрибут iscsi используется для обнаружения целевых устройств
Если state iscsilogin, это означает, что атрибут iscsi используется для входа в указанные целевые устройства, переданные в качестве части атрибута iscsi
kdump_integration
-
    Варианты:
  • включено
  • выключено
Указывает, будет ли включена интеграция Kdump на хосте.
kernel_params
-
Список параметров загрузки ядра.
Ниже приведены наиболее распространённые параметры ядра, используемые для хоста:
Hostdev Passthrough & SR-IOV: intel_iommu=on
Вложенная виртуализация: kvm-intel.nested=1
Небезопасные прерывания: vfio_iommu_type1.allow_unsafe_interrupts=1
Перераспределение PCI: pci=realloc
Note:
Изменение параметров загрузки ядра может привести к сбою загрузки хоста. Перед внесением любых изменений, пожалуйста, обратитесь к документации продукта.
Изменения параметров загрузки ядра требуют развертывания и перезагрузки хоста. Хост должен быть успешно переустановлен, а затем перезагружен, чтобы параметры загрузки ядра были применены.
name
- / обязательно
Имя хоста для управления.
nested_attributes
список
Указывает список атрибутов, которые необходимо извлечь из API.
Этот параметр применяется только если fetch_nested равен true.
override_display
boolean
    Варианты:
  • нет
  • да
Переопределяет адрес отображения всех виртуальных машин на этом хосте указанным адресом.
override_iptables
boolean
    Варианты:
  • нет
  • да
Если True, iptables хоста будут переопределены скриптом развертывания хоста.
Обратите внимание, что override_iptables по умолчанию равен false в oVirt/RHV.
password
-
Пароль root. Он требуется в случае, если public_key установлен в False.
poll_interval
целое число
Значение по умолчанию:
3
Количество секунд, которое модуль ожидает, прежде чем отправить новый запрос для проверки статуса объекта.
power_management_enabled
boolean
добавлен в 2.4
    Варианты:
  • нет
  • да
Включить или отключить управление питанием хоста.
Для более комплексной настройки управления питанием используйте модуль ovirt_host_pm.
public_key
boolean
    Choices:
  • нет ←
  • да
Истина, если для аутентификации на хосте должен использоваться открытый ключ.
Требуется в случае, если password не задан.

алиасы: ssh_public_key
reboot_after_upgrade
boolean
добавлено в 2.6
    Choices:
  • нет
  • да ←
Если истина и state обновляется, перезагрузить хост после успешного обновления.
spm_priority
-
Приоритет SPM хоста. Целочисленное значение от 1 до 10, где большее число означает более высокий приоритет.
state
-
    Choices:
  • present ←
  • absent
  • maintenance
  • upgraded
  • started
  • restarted
  • stopped
  • reinstalled
  • iscsidiscover
  • iscsilogin
Состояние, в котором должен находиться хост после успешного завершения.
iscsilogin и iscsidiscover поддерживаются с версии 2.4.
timeout
integer
По умолчанию:
600
Время в секундах, которое модуль должен ждать, пока хост не перейдет в желаемое состояние.
vgpu_placement
-
добавлено в 2.8
    Choices:
  • consolidated
  • separated
Если consolidated, каждый vGPU размещается на первой физической карте с доступным пространством. Это стандартное размещение, использующее все доступное пространство на физических картах.
Если separated, каждый vGPU размещается на отдельной физической карте, если это возможно. Это может быть полезно для повышения производительности vGPU.
wait
boolean
    Choices:
  • нет
  • да ←
yes нужно ли модулю ждать, пока сущность перейдет в желаемое состояние.

Примечания

Примечание

  • Для использования этого модуля необходимо установить 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:

# Add host with username/password supporting SR-IOV.
# Note that override_iptables is false by default in oVirt/RHV:
- ovirt_host:
    cluster: Default
    name: myhost
    address: 10.34.61.145
    password: secret
    override_iptables: true
    kernel_params:
      - intel_iommu=on

# Add host using public key
- ovirt_host:
    public_key: true
    cluster: Default
    name: myhost2
    address: 10.34.61.145
    override_iptables: true

# Deploy hosted engine host
- ovirt_host:
    cluster: Default
    name: myhost2
    password: secret
    address: 10.34.61.145
    override_iptables: true
    hosted_engine: deploy

# Maintenance
- ovirt_host:
    state: maintenance
    name: myhost

# Restart host using power management:
- ovirt_host:
    state: restarted
    name: myhost

# Upgrade host
- ovirt_host:
    state: upgraded
    name: myhost

# discover iscsi targets
- ovirt_host:
    state: iscsidiscover
    name: myhost
    iscsi:
      username: iscsi_user
      password: secret
      address: 10.34.61.145
      port: 3260


# login to iscsi targets
- ovirt_host:
    state: iscsilogin
    name: myhost
    iscsi:
      username: iscsi_user
      password: secret
      address: 10.34.61.145
      target: "iqn.2015-07.com.mlipchuk2.redhat:444"
      port: 3260


# Reinstall host using public key
- ovirt_host:
    state: reinstalled
    name: myhost
    public_key: true

# Remove host
- ovirt_host:
    state: absent
    name: myhost
    force: True

# Retry removing host when failed (https://bugzilla.redhat.com/show_bug.cgi?id=1719271)
- ovirt_host:
    state: absent
    name: myhost
  register: result
  until: not result.failed
  retries: 6
  delay: 20

# Change host Name
- ovirt_host:
    id: 00000000-0000-0000-0000-000000000000
    name: "new host name"

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

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

Ключ Возвращаемое Описание
host
dictionary
При успехе, если хост найден.
Словарь всех атрибутов хоста. Атрибуты хоста можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/host.

id
string
При успехе, если хост найден.
Идентификатор управляемого хоста

Пример:
7de90f31-222c-436c-a1ca-7e655bd5b60c
iscsi_targets
list
При успехе, если хост найден и состояние равно iscsidiscover.
Список целевых узлов iSCSI хоста



Статус

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

Авторы

  • 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_host_module.html

Spec-Zone.ru

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