Модуль vmware.vmware_rest.vcenter_vm_power_info – Возвращает информацию о состоянии питания виртуальной машины.

Примечание

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

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

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

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

Добавлен в vmware.vmware_rest 0.1.0

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

Описание

Возвращает информацию о состоянии питания виртуальной машины.

Требования

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

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

Параметры

Параметр	Комментарии
session_timeout float добавлен в vmware.vmware_rest 2.1.0	Настройки таймаута для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
vcenter_hostname строка / обязательно	Имя хоста или IP-адрес vCenter vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`.
vcenter_password строка / обязательно	Пароль vCenter vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`.
...	...

Примечания

Примечание

Тестировалось на 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: Get guest power information
  vmware.vmware_rest.vcenter_vm_power_info:
    vm: '{{ test_vm1_info.id }}'
  register: _result

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

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

Ключ	Описание
value словарь	Получить информацию о состоянии гостевой ОС Возвращается: При успехе Пример: `{"state": "POWERED_ON"}`

Авторы

Команда Ansible Cloud (@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_power_info_module.html