Модуль vmware.vmware_rest.vcenter_vm_hardware — обновляет настройки виртуального оборудования виртуальной машины.
Примечание
Этот модуль входит в коллекцию vmware.vmware_rest (версия 4.10.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.vcenter_vm_hardware.
Новое в vmware.vmware_rest 0.1.0
Краткое описание
- Обновляет настройки виртуального оборудования виртуальной машины.
Требования
На хосте, на котором выполняется этот модуль, необходимы следующие компоненты.
- vSphere 7.0.3 или более поздней версии
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
session_timeout float добавлено в vmware.vmware_rest 2.1.0 | Настройки времени ожидания для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
state string | Варианты:
|
upgrade_policy string | Перечисляемый тип upgrade_policy определяет допустимые политики обновления виртуального оборудования виртуальной машины. Варианты:
|
upgrade_version string | Перечисляемый тип version определяет допустимые версии виртуального оборудования виртуальной машины. См. https://kb.vmware.com/s/article/1003746 (Версии оборудования виртуальных машин (1003746)). Варианты:
|
vcenter_hostname string / обязательный | Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
vcenter_password string / обязательный | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
vcenter_rest_log_file string | С помощью этого необязательного параметра можно задать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по HTTP REST. Файл будет сохранен на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
vcenter_username string / обязательный | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной среды |
vcenter_validate_certs boolean | Разрешает подключение, если SSL-сертификаты недействительны. Установите значение Если значение не указано в задаче, вместо него будет использоваться значение переменной среды Варианты:
|
version string | Перечисляемый тип version определяет допустимые версии виртуального оборудования виртуальной машины. См. https://kb.vmware.com/s/article/1003746 (Версии оборудования виртуальных машин (1003746)). Варианты:
|
vm string / обязательный | Идентификатор виртуальной машины. Параметр должен содержать идентификатор ресурса, возвращаемый модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр является обязательным. |
Примечания
Примечание
- Проверено на vSphere 7.0.3
Примеры
- name: Upgrade the VM hardware version
vmware.vmware_rest.vcenter_vm_hardware:
upgrade_policy: AFTER_CLEAN_SHUTDOWN
upgrade_version: VMX_11
vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/test_vm1') }}"
register: _result
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
id dictionary | MOID ресурса Возвращается: при успешном выполнении |
value dictionary | Обновление версии оборудования виртуальной машины Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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/vmware/vmware_rest/vcenter_vm_hardware_module.html
