Модуль vmware.vmware_rest.vcenter_vm_guest_power — отправляет гостевой операционной системе запрос на мягкое выключение, переход в режим ожидания (приостановку) или мягкую перезагрузку

Примечание

Этот модуль входит в коллекцию 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_guest_power.

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

УСТАРЕЛО
Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалён в версии:: 5.0.0
Причина:: Этот модуль перенесён в новую коллекцию vmware.vmware
Альтернатива:: Вместо него используйте vmware.vmware.vm_powerstate.

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

Отправляет гостевой операционной системе запрос на мягкое выключение, переход в режим ожидания (приостановку) или мягкую перезагрузку. Запрос возвращается немедленно и не ожидает завершения работы гостевой операционной системы.

Требования

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

vSphere 7.0.3 или новее
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
session_timeout float добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для клиентского сеанса. Максимальное количество секунд, отведённое на всю операцию, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state string / обязательный	Допустимые значения: `"reboot"` `"shutdown"` `"standby"`
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 / обязательный	Идентификатор виртуальной машины. Параметр должен содержать идентификатор ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр является обязательным.

Примечания

Примечание

Проверено на vSphere 7.0.3

См. также

vmware.vmware_rest.vcenter_vm_power: Модуль для запуска, принудительного выключения и принудительной перезагрузки гостевой системы

Примеры

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}"
      folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      hot_add_enabled: true
      size_MiB: 1024
    disks:
    - type: SATA
      backing:
        type: VMDK_FILE
        vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk'
    - type: SATA
      new_vmdk:
        name: second_disk
        capacity: 32000000000
    cdroms:
    - type: SATA
      sata:
        bus: 0
        unit: 2
    nics:
    - backing:
        type: STANDARD_PORTGROUP
        network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: my_vm

- name: Shut down the VM
  vmware.vmware_rest.vcenter_vm_guest_power:
    state: shutdown
    vm: '{{ my_vm.id }}'

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

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

Ключ	Описание
value dictionary	Выключение виртуальной машины Возвращается: При успешном выполнении Пример: `{}`

Статус

Этот модуль будет удалён в версии 5.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Команда 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_guest_power_module.html