Модуль vmware.vmware_rest.vcenter_vm_tools – Обновление свойств VMware Tools.

Примечание

Этот модуль является частью коллекции vmware.vmware_rest (версия 3.2.0).

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

Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: vmware.vmware_rest.vcenter_vm_tools.

Новое в vmware.vmware_rest 0.1.0

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

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

Обновление свойств VMware Tools.

Требования

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

vSphere 7.0.3 или более поздняя версия
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
command_line_options string	Параметры командной строки, передаваемые установщику для изменения процедуры установки Tools. Установите, если требуются дополнительные параметры.
session_timeout float добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state string	Варианты: `"present"` ← (по умолчанию) `"upgrade"`
upgrade_policy string	Перечисляемый тип upgrade_policy определяет, когда Tools автоматически обновляются для виртуальной машины. Варианты: `"MANUAL"` `"UPGRADE_AT_POWER_CYCLE"`
vcenter_hostname string / обязательно	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
vcenter_password string / обязательно	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file string	Вы можете использовать этот необязательный параметр для установки местоположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на хосте, на котором запущен модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_REST_LOG_FILE`.
vcenter_username string / обязательно	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
vcenter_validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, когда сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm string / обязательно	Идентификатор виртуальной машины. Параметр должен быть id ресурса, возвращаемого vmware.vmware_rest.vcenter_vm_info. Этот параметр обязателен.

Примечания

Примечание

Тестировалось на vSphere 7.0.3

Примеры

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Retrive vm-tools information
  vmware.vmware_rest.vcenter_vm_tools:
    vm: '{{ test_vm1_info.id }}'
  register: _result

- name: Change vm-tools upgrade policy to UPGRADE_AT_POWER_CYCLE
  vmware.vmware_rest.vcenter_vm_tools:
    vm: '{{ test_vm1_info.id }}'
    upgrade_policy: UPGRADE_AT_POWER_CYCLE
  register: _result

- name: Change vm-tools upgrade policy to MANUAL
  vmware.vmware_rest.vcenter_vm_tools:
    vm: '{{ test_vm1_info.id }}'
    upgrade_policy: MANUAL
  register: _result

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

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

Ключ	Описание
id dictionary	moid ресурса Возвращается: При успехе
value dictionary	Получение информации о vm-tools Возвращается: При успехе Пример: `{"auto_update_supported": 0, "install_attempt_count": 0, "install_type": "OPEN_VM_TOOLS", "run_state": "RUNNING", "upgrade_policy": "MANUAL", "version": "10346", "version_number": 10346, "version_status": "UNMANAGED"}`

Авторы

Ansible Cloud Team (@ansible-collections)

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

© 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/vmware/vmware_rest/vcenter_vm_tools_module.html