community.vmware.vmware_host – Добавление, удаление или перемещение хоста ESXi в, из или внутри vCenter
Примечание
Этот плагин является частью коллекции community.vmware (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install community.vmware
Для использования в плейбуке укажите: community.vmware.vmware_host
Обзор
- Этот модуль может быть использован для добавления, переподключения или удаления хоста ESXi в или из vCenter.
- Этот модуль также может быть использован для перемещения хоста ESXi в кластер или папку, или наоборот, в рамках одного и того же дата-центра.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
- ssl
- socket
- hashlib
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| add_connected boolean |
| Если установлено значение True, то хост должен быть подключён сразу после добавления.Этот параметр игнорируется, если параметр state установлен на значение отличное от present. |
| cluster_name string | Имя кластера для добавления хоста. Если folder не задан, то этот параметр обязателен.Псевдонимы добавлены в версии 2.6. псевдонимы: cluster | |
| datacenter_name string / обязательно | Имя дата-центра для добавления хоста. Псевдонимы добавлены в версии 2.6. псевдонимы: datacenter | |
| esxi_hostname string / обязательно | Имя хоста ESXi для управления. | |
| esxi_password string | Пароль для хоста ESXi. Требуется для добавления хоста. Необязательно для переподключения. Не используется для удаления. Больше не является обязательным параметром с версии 2.5. | |
| esxi_ssl_thumbprint string | По умолчанию: "" | Указывает отпечаток сертификата хоста. Используйте следующую команду для получения отпечатка сертификата хоста - # openssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha1 -noout Используется только если fetch_thumbprint не задан как true.псевдонимы: ssl_thumbprint |
| esxi_username string | Имя пользователя хоста ESXi. Требуется для добавления хоста. Необязательно для переподключения. Если и esxi_username и esxi_password используютсяНе используется для удаления. Больше не является обязательным параметром с версии 2.5. | |
| fetch_ssl_thumbprint boolean |
| Получить отпечаток SSL сертификата хоста. Это, по сути, отключает проверку сертификата хоста (проверка, подписан ли он признанным центром сертификации). Отключите этот параметр, если хотите, чтобы к vCenter добавлялись только хосты с действительными сертификатами. Если этот параметр установлен в false и сертификат не может быть проверен, добавление или переподключение завершится ошибкой.Не используется, когда esxi_ssl_thumbprint установлено.Необязательно для переподключения, но используется только, если esxi_username и esxi_password используются.Не используется для удаления. |
| folder string | Имя папки, в которую необходимо добавить хост. Если 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 |
| Принудительно подключиться, если хост уже управляется другим сервером vCenter. |
| hostname string | Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST.Поддержка переменных среды добавлена в Ansible 2.6. | |
| password string | Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD.Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port integer | По умолчанию: 443 | Порт сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PORT.Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host string | Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат - имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_HOST.Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | |
| proxy_port integer | Порт HTTP прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_PORT. | |
| reconnect_disconnected boolean |
| Переподключить отключенные хосты. Это используется только если state установлено в present и если хост уже существует. |
| state string |
| Если установлено значение present, добавить хост, если он отсутствует.Если установлено значение present, обновить расположение хоста, если он уже существует.Если установлено значение absent, удалить хост, если он присутствует.Если установлено значение absent, ничего не делать, если хост уже не существует.Если установлено значение add_or_reconnect, добавить хост, если его нет, в противном случае переподключиться и обновить расположение.Если установлено значение reconnect, переподключить хост, если он присутствует, и обновить расположение.Если установлено значение disconnected, отключить хост, если хост уже существует. |
| username string | Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER.Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| validate_certs boolean |
| Разрешить подключение, когда SSL сертификаты недействительны. Установите значение false при недоверии сертификатов.Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS.Поддержка переменных среды добавлена в Ansible 2.6. Если установлено значение true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Проверено на vSphere 5.5, 6.0, 6.5 и 6.7
Примеры
- name: Add ESXi Host to vCenter
community.vmware.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
community.vmware.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)
community.vmware.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)
community.vmware.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
community.vmware.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 string | при успешном добавлении | метаданные о добавленном хосте Пример: Хост уже подключён к vCenter 'vcenter01' в кластере 'cluster01' |
Авторы
- 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.10/collections/community/vmware/vmware_host_module.html