Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_host — добавление, удаление или перемещение хоста ESXi в vCenter, из vCenter или внутри vCenter

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_host.

  • УСТАРЕЛО
  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕЛО

Удалено в:

версии 7.0.0

Причина:

Этот модуль перенесён в новую коллекцию vmware.vmware

Альтернатива:

Вместо него используйте vmware.vmware.esxi_host и vmware.vmware.esxi_connection.

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

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

Параметры

Параметр

Комментарии

add_connected

boolean

Если задано значение true, хост подключается сразу после добавления.

Этот параметр игнорируется, если не задано state=present.

Варианты:

  • false
  • true ← (по умолчанию)

cluster_name

псевдонимы: cluster

string

Имя кластера, в который нужно добавить хост.

Если folder не задано, этот параметр обязателен.

datacenter_name

псевдонимы: datacenter

string / обязательный

Имя центра обработки данных, в который нужно добавить хост.

esxi_hostname

string / обязательный

Имя хоста ESXi, которым нужно управлять.

esxi_password

string

Пароль ESXi.

Обязателен при добавлении хоста.

Необязателен при повторном подключении.

Не используется при удалении.

Начиная с версии 2.5 этот параметр больше не является обязательным.

esxi_ssl_thumbprint

псевдонимы: ssl_thumbprint

string

Указание отпечатка сертификата hostsystem.

Чтобы получить отпечаток сертификата hostsystem, используйте следующую команду —

# openssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha1 -noout

По умолчанию: ""

esxi_username

string

Имя пользователя ESXi.

Обязательно при добавлении хоста.

Необязательно при повторном подключении. Если используются оба параметра — esxi_username и esxi_password

Не используется при удалении.

Начиная с версии 2.5 этот параметр больше не является обязательным.

fetch_ssl_thumbprint

boolean

Получить отпечаток SSL-сертификата хоста.

Фактически это отключает проверку сертификата хоста (проверку, подписан ли он доверенным центром сертификации).

Отключите этот параметр, если хотите разрешить добавление в vCenter только хостов с действительными сертификатами.

Если для этого параметра задано значение false и сертификат не удаётся проверить, добавление или повторное подключение завершится ошибкой.

Не используется, если задано esxi_ssl_thumbprint.

Необязателен при повторном подключении, но используется только при использовании esxi_username и esxi_password.

Не используется при удалении.

Варианты:

  • false
  • true ← (по умолчанию)

folder

псевдонимы: folder_name

string

Имя папки, в которую нужно добавить хост.

Если cluster_name не задано, этот параметр обязателен.

Например, если в папке «Site1» находится центр обработки данных «dc1», это значение будет «/Site1/dc1/host».

Здесь «host» — скрытая папка в VMware Web Client.

Другой пример: если в центре обработки данных «dc2» есть вложенная структура папок «/myhosts/india/pune», значение folder будет «/dc2/host/myhosts/india/pune».

Другие примеры: «/Site2/dc2/Asia-Cluster/host» или «/dc3/Asia-Cluster/host»

force_connection

boolean

Принудительно подключить хост, если им уже управляет другой сервер vCenter.

Варианты:

  • false
  • true ← (по умолчанию)

hostname

string

Имя хоста или IP-адрес сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_HOST.

password

псевдонимы: pass, pwd

string

Пароль сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_PASSWORD.

port

integer

Номер порта сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_PORT.

По умолчанию: 443

proxy_host

string

Адрес прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы.

Укажите имя хоста или IP-адрес.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_PROXY_HOST.

proxy_port

integer

Порт HTTP-прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_PROXY_PORT.

reconnect_disconnected

boolean

Повторно подключать отключённые хосты.

Используется только при заданном state=present и если хост уже существует.

Варианты:

  • false
  • true ← (по умолчанию)

state

string

Если задано значение present, добавить хост, если он отсутствует.

Если задано значение present, обновить расположение хоста, если он уже существует.

Если задано значение absent, удалить хост, если он существует.

Если задано значение absent, ничего не делать, если хост уже отсутствует.

Если задано значение add_or_reconnect, добавить хост, если он отсутствует, иначе повторно подключить его и обновить его расположение.

Если задано значение reconnect, повторно подключить хост, если он существует, и обновить его расположение.

Если задано значение disconnected, отключить хост, если он существует.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "add_or_reconnect"
  • "reconnect"
  • "disconnected"

username

псевдонимы: admin, user

string

Имя пользователя сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_USER.

validate_certs

boolean

Разрешает подключение при недействительных SSL-сертификатах. Установите значение false, если сертификаты не являются доверенными.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Всем модулям требуется доступ на запись через API, поэтому они не поддерживаются при использовании бесплатной лицензии ESXi.
  • Имена всех переменных и объектов VMware чувствительны к регистру.
  • Модули могут использовать библиотеку Python «requests», которая по умолчанию не применяет хранилище сертификатов системы. Вы можете указать хранилище сертификатов, задав переменную окружения REQUESTS_CA_BUNDLE. Обратите внимание: наличие этой переменной может в некоторых случаях привести к игнорированию значения «false» для параметра «validate_certs». Пример: «export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem»

Примеры

- 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

метаданные о добавленной системе нового хоста

Возвращается: при успешном добавлении

Пример: "Host already connected to vCenter 'vcenter01' in cluster 'cluster01'"

Статус

  • Этот модуль будет удалён в версии 7.0.0. [устарело]
  • Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

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

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_host_module.html

Spec-Zone.ru

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