Spec-Zone.ru › Ansible 2.9

vmware_host – Добавление, удаление или перемещение хоста ESXi в, из или внутри vCenter

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

Синопсис

  • Этот модуль может быть использован для добавления, повторного подключения или удаления хоста ESXi к или из vCenter.
  • Этот модуль также может быть использован для перемещения хоста ESXi в кластер или папку, или наоборот, внутри одного и того же датацентра.

Требования

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

  • python >= 2.6
  • PyVmomi
  • ssl
  • socket
  • hashlib

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
add_connected
boolean
добавлен в 2.6
    Варианты:
  • нет
  • да ←
Если установлено в True, то хост должен быть подключён сразу после добавления.
Этот параметр игнорируется, если значение параметра state отличается от present.
cluster_name
строка
Имя кластера, к которому добавляется хост.
Если folder не задано, то этот параметр обязателен.
Псевдонимы добавлены в версии 2.6.

псевдонимы: кластер
datacenter_name
строка / обязательно
Имя дата-центра, к которому добавляется хост.
Псевдонимы добавлены в версии 2.6.

псевдонимы: дата-центр
esxi_hostname
строка / обязательно
Имя хоста ESXi для управления.
esxi_password
строка
Пароль ESXi.
Требуется для добавления хоста.
Необязательно для переподключения.
Не используется для удаления.
Больше не является обязательным параметром с версии 2.5.
esxi_ssl_thumbprint
строка
добавлен в 2.5
Значение по умолчанию:
""
Указывает отпечаток сертификата хост-системы.
Используйте следующую команду для получения отпечатка сертификата хост-системы -
# openssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha1 -noout
Используется только если fetch_thumbprint не установлено в true.

псевдонимы: ssl_thumbprint
esxi_username
строка
Имя пользователя ESXi.
Требуется для добавления хоста.
Необязательно для переподключения. Если используются esxi_username и esxi_password
Не используется для удаления.
Больше не является обязательным параметром с версии 2.5.
fetch_ssl_thumbprint
boolean
добавлен в 2.8
    Варианты:
  • нет
  • да ←
Извлечь отпечаток сертификата SSL хоста.
Это по сути отключает проверку сертификата хоста (проверку, подписан ли он признанным центром сертификации).
Отключите этот параметр, если хотите допускать добавление только хостов с действительными сертификатами в vCenter.
Если этот параметр установлен в false и сертификат не может быть проверен, добавление или переподключение завершатся неудачей.
Не используется, если esxi_ssl_thumbprint установлено.
Необязательно для переподключения, но используется только если esxi_username и esxi_password используются.
Не используется для удаления.
folder
строка
добавлен в 2.6
Имя папки, в которой добавляется хост.
Если cluster_name не установлено, то этот параметр обязателен.
Например, если есть дата-центр 'dc1' в папке 'Site1', то это значение будет '/Site1/dc1/host'.
Здесь 'host' — невидимая папка в VMware Web Client.
Другой пример, если есть вложенная структура папок, например '/myhosts/india/pune' в дата-центре 'dc2', то значение folder будет '/dc2/host/myhosts/india/pune'.
Другие примеры:
- '/Site2/dc2/Asia-Cluster/host'
- '/dc3/Asia-Cluster/host'

псевдонимы: имя_папки
force_connection
boolean
добавлен в 2.8
    Варианты:
  • нет
  • да ←
Принудительное подключение, если хост уже управляется другим сервером vCenter.
hostname
строка
Имя хоста или IP-адрес сервера vSphere vCenter или ESXi.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST.
Поддержка переменных среды добавлена в Ansible 2.6.
password
строка
Пароль сервера vSphere vCenter или ESXi.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD.
Поддержка переменных среды добавлена в Ansible 2.6.

псевдонимы: pass, pwd
port
целое число
добавлен в 2.5
Значение по умолчанию:
443
Номер порта сервера vSphere vCenter или ESXi.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT.
Поддержка переменных среды добавлена в Ansible 2.6.
proxy_host
строка
добавлен в 2.9
Адрес прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их.
Формат — имя хоста или IP-адрес.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_HOST.
Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12
proxy_port
целое число
добавлен в 2.9
Порт HTTP-прокси, который будет принимать все запросы HTTPS и перенаправлять их.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_PORT.
reconnect_disconnected
boolean
добавлен в 2.8
    Варианты:
  • нет
  • да ←
Переподключить отключённые хосты.
Используется только если state установлено в present и если хост уже существует.
state
строка
    Варианты:
  • present ←
  • absent
  • add_or_reconnect
  • reconnect
Если установлено в present, добавить хост, если хоста нет.
Если установлено в present, обновить местоположение хоста, если хост уже существует.
Если установлено в absent, удалить хост, если хост присутствует.
Если установлено в absent, ничего не делать, если хост уже не существует.
Если установлено в add_or_reconnect, добавить хост, если его нет, иначе переподключить и обновить местоположение.
Если установлено в reconnect, переподключить хост, если он есть, и обновить местоположение.
username
строка
Имя пользователя сервера vSphere vCenter или ESXi.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER.
Поддержка переменных среды добавлена в Ansible 2.6.

псевдонимы: admin, user
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Разрешить подключение, когда сертификаты SSL недействительны. Установите в false, когда сертификаты ненадёжные.
Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.
Поддержка переменных среды добавлена в Ansible 2.6.
Если установлено в yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

  • Тестировалось на vSphere 5.5, 6.0, 6.5 и 6.7

Примеры

- name: Add ESXi Host to vCenter
  vmware_host:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    cluster: cluster_name
    esxi_hostname: '{{ esxi_hostname }}'
    esxi_username: '{{ esxi_username }}'
    esxi_password: '{{ esxi_password }}'
    state: present
  delegate_to: localhost

- name: Add ESXi Host to vCenter under a specific folder
  vmware_host:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    folder: '/Site2/Asia-Cluster/host'
    esxi_hostname: '{{ esxi_hostname }}'
    esxi_username: '{{ esxi_username }}'
    esxi_password: '{{ esxi_password }}'
    state: present
    add_connected: True
  delegate_to: localhost

- name: Reconnect ESXi Host (with username/password set)
  vmware_host:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    cluster: cluster_name
    esxi_hostname: '{{ esxi_hostname }}'
    esxi_username: '{{ esxi_username }}'
    esxi_password: '{{ esxi_password }}'
    state: reconnect
  delegate_to: localhost

- name: Reconnect ESXi Host (with default username/password)
  vmware_host:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    cluster: cluster_name
    esxi_hostname: '{{ esxi_hostname }}'
    state: reconnect
  delegate_to: localhost

- name: Add ESXi Host with SSL Thumbprint to vCenter
  vmware_host:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    cluster: cluster_name
    esxi_hostname: '{{ esxi_hostname }}'
    esxi_username: '{{ esxi_username }}'
    esxi_password: '{{ esxi_password }}'
    esxi_ssl_thumbprint: "3C:A5:60:6F:7A:B7:C4:6C:48:28:3D:2F:A5:EC:A3:58:13:88:F6:DD"
    state: present
  delegate_to: localhost

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

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

Ключ Возвращаемое значение Описание
result
строка
при успешном добавлении
метаданные о добавленной новой хост-системе

Пример:
Хост уже подключен к vCenter 'vcenter01' в кластере 'cluster01'


Статус

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

Авторы

  • Joseph Callen (@jcpowermac)
  • Russell Teague (@mtnbikenc)
  • Maxime de Roucy (@tchernomax)
  • Christian Kotte (@ckotte)

Подсказка

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

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

Spec-Zone.ru

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