community.vmware.vmware_cfg_backup – Резервное копирование/восстановление/сброс конфигурации хоста ESXi

Примечание

Этот плагин является частью коллекции community.vmware (версия 1.7.0).

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

Для использования в книге задач укажите: community.vmware.vmware_cfg_backup.

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

Обзор

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

Требования

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

python >= 2.6
Установлен PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
dest путь		Место назначения, где будет сохранён пакет конфигурации ESXi. dest может быть папкой или файлом. Если dest – папка, резервная копия будет сохранена в папке с именем по умолчанию, сгенерированным из сервера ESXi. Если dest – файл, резервная копия будет сохранена с указанным именем. Расширение файла всегда будет .tgz.
esxi_hostname строка		Имя сервера ESXi. Требуется только если выполняется аутентификация против vCenter.
hostname строка		Имя хоста или IP-адрес сервера vCenter vSphere или сервера ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
password строка		Пароль сервера vCenter vSphere или сервера ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число	По умолчанию: 443	Порт сервера vCenter vSphere или сервера ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `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`.
src путь		Файл, содержащий конфигурацию ESXi, которая будет восстановлена.
state строка / обязательный	Варианты: saved absent loaded	Если `saved`, пакет резервной копии .tgz будет сохранён в dest. Если `absent`, конфигурация хоста будет сброшена до значений по умолчанию. Если `loaded`, файл резервной копии в src будет загружен на хост ESXi, перезаписывая настройки хоста.
username строка		Имя пользователя сервера vCenter vSphere или сервера ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user
validate_certs булево	Варианты: no да ←	Позволяет подключиться, когда сертификаты SSL не валидны. Установите в `false`, когда сертификаты не доверяются. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено в `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

Проверено на ESXi 6.0
Работает только для хостов ESXi
При загрузке или сбросе конфигурации хост будет автоматически переведён в режим обслуживания.

Примеры

- name: Save the ESXi configuration locally by authenticating directly against the ESXi host
  community.vmware.vmware_cfg_backup:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    state: saved
    dest: /tmp/
  delegate_to: localhost

- name: Save the ESXi configuration locally by authenticating against the vCenter and selecting the ESXi host
  community.vmware.vmware_cfg_backup:
    hostname: '{{ vcenter_hostname }}'
    esxi_hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    state: saved
    dest: /tmp/
  delegate_to: localhost

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

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

Ключ	Возвращённое значение	Описание
dest_file строка	changed	Полный путь к файлу, в котором хранится конфигурация ESXi. Пример: /tmp/configBundle-esxi.host.domain.tgz

Авторы

Andreas Nafpliotis (@nafpliot-ibm)

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