community.vmware.vmware_maintenancemode – Размещение хоста в режим технического обслуживания

Примечание

Этот плагин входит в состав коллекции community.vmware (версия 1.6.0).

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

Чтобы использовать его в книге задач, укажите: community.vmware.vmware_maintenancemode.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
esxi_hostname строка / обязательно		Имя хоста, определенное в vCenter.
evacuate логическое значение	Варианты: no ← yes	Если установлено значение `True`, эвакуировать все выключенные виртуальные машины.
hostname строка		Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
password строка		Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число	По умолчанию: 443	Порт сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в Ansible 2.6.
proxy_host строка		Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PROXY_PORT`.
state строка	Варианты: present ← absent	Вход или выход из режима технического обслуживания.
timeout целое число	По умолчанию: 0	Укажите таймаут для операции.
username строка		Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user
validate_certs логическое значение	Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено значение `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.
vsan строка	Варианты: ensureObjectAccessibility evacuateAllData noAction	Укажите, в какой режим VSAN войти. псевдонимы: vsan_mode

Примечания

Примечание

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

Примеры

- name: Enter VSAN-Compliant Maintenance Mode
  community.vmware.vmware_maintenancemode:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    vsan: ensureObjectAccessibility
    evacuate: true
    timeout: 3600
    state: present
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
hostname строка	всегда	Имя хоста в vCenter Пример: esxi.local.domain
hostsystem строка	всегда	Имя ссылки vim Пример: 'vim.HostSystem:host-236'
status строка	всегда	Выполненное действие Пример: ВХОД

Авторы

Jay Jahns (@jjahns) <jjahns@vmware.com>
Abhijeet Kasurde (@Akasurde)

© 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_maintenancemode_module.html