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

Примечание

Этот модуль входит в коллекцию 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_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 string / обязательный	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
vcenter_password string / обязательный	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file string	Этот необязательный параметр позволяет задать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия с HTTP REST API. Файл будет сохранён на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_REST_LOG_FILE`.
vcenter_username string / обязательный	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
vcenter_validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Если сертификаты не являются доверенными, задайте значение `false`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm string	Идентификатор виртуальной машины. Параметр должен содержать идентификатор ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_vm_info. Обязателен при state=[‘get’]

Примечания

Примечание

Проверено на 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 dictionary	Получение информации о питании гостевой системы Возвращается: при успехе Пример: `{"state": "POWERED_ON"}`

Авторы

Команда Ansible Cloud (@ansible-collections)

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

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