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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.vmware.

Для использования в плейбуке укажите: community.vmware.vmware_host.

Описание
Параметры
Примечания
Примеры
Значения возврата

Описание

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

Параметры

Параметр	Комментарии
add_connected boolean	Если установлено в `true`, то хост должен быть подключён сразу после добавления. Этот параметр игнорируется, если не `state=present`. Выбори: `false` `true` ← (по умолчанию)
cluster_name алиасы: cluster строка	Имя кластера для добавления хоста. Если `folder` не задано, то этот параметр обязателен.
datacenter_name алиасы: datacenter строка / обязательно	Имя центру данных для добавления хоста.
esxi_hostname строка / обязательно	Имя хоста ESXi для управления.
esxi_password строка	Пароль ESXi. Обязателен для добавления хоста. Необязателен для повторного подключения. Не используется для удаления. Больше не является обязательным параметром с версии 2.5.
esxi_ssl_thumbprint алиасы: ssl_thumbprint строка	Указание отпечатка сертификата хост-системы. Используйте следующую команду для получения отпечатка сертификата хост-системы - # openssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha1 -noout По умолчанию: `""`
esxi_username строка	Имя пользователя 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 строка	Имя папки, в которой добавить хост. Если `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	Принудительно подключиться, если хост уже управляется другим сервером vCenter. Выбори: `false` `true` ← (по умолчанию)
hostname строка	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задании, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
password алиасы: pass, pwd строка	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задании, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port целое число	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задании, вместо него будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host строка	Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задании, вместо него будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port целое число	Порт 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 aliases: admin, user string	Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда сертификаты SSL недействительны. Установите значение `false`, когда сертификаты не доверяются. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Все модули требуют доступа к API для записи и поэтому не поддерживаются на бесплатной лицензии ESXi.
Все имена переменных и объектов VMware чувствительны к регистру.

Примеры

- 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'"`

Авторы

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

Ссылки на сборку

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