Spec-Zone.ru › Ansible 2.8

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

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

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

Описание

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

Требования

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

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

Параметры

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

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

псевдонимы: datacenter
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
    Варианты:
  • no
  • yes ←
Получить отпечаток сертификата 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'

псевдонимы: folder_name
force_connection
boolean
добавлен в 2.8
    Варианты:
  • no
  • yes ←
Принудительно подключиться, если хост уже управляется другим сервером 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.
reconnect_disconnected
boolean
добавлен в 2.8
    Варианты:
  • no
  • yes ←
Повторное подключение отключенных хостов.
Используется только если 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
    Варианты:
  • no
  • yes ←
Разрешает подключение, когда 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.8/modules/vmware_host_module.html

Spec-Zone.ru

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