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

Примечание

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

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

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

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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

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

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

Параметры

Параметр	Комментарии
dest path	Путь назначения, по которому будет сохранён пакет конфигурации ESXi. Это может быть папка или файл. Если указана папка, файл резервной копии будет сохранён в ней под именем по умолчанию, сформированным на основе сервера ESXi. Если указан файл, файл резервной копии будет сохранён под этим именем. Расширение файла всегда будет .tgz.
esxi_hostname string	Имя сервера ESXi. Этот параметр требуется только при аутентификации через vCenter.
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
password aliases: 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`.
src path	Файл с конфигурацией ESXi, которая будет восстановлена.
state string / обязательный	Если `saved`, пакет резервной копии .tgz будет сохранён в `dest`. Если `absent`, конфигурация хоста будет сброшена до значений по умолчанию. Если `loaded`, файл резервной копии из `src` будет загружен на хост ESXi, перезаписав настройки хоста. Варианты: `"saved"` `"absent"` `"loaded"`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- 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 string	Полный путь к файлу, в котором была сохранена конфигурация ESXi Возвращается: changed Пример: `"/tmp/configBundle-esxi.host.domain.tgz"`

Авторы

Andreas Nafpliotis (@nafpliot-ibm)

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

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