Модуль vmware.vmware_rest.vcenter_vm_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_power.
Добавлено в vmware.vmware_rest 0.1.0
- УСТАРЕЛО
- Краткое описание
- Требования
- Параметры
- Примечания
- См. также
- Примеры
- Возвращаемые значения
- Статус
УСТАРЕЛО
- Удалено в:
-
версии 5.0.0
- Причина:
-
Этот модуль перенесён в новую коллекцию vmware.vmware
- Альтернатива:
-
Вместо него используйте vmware.vmware.vm_powerstate.
Краткое описание
- Запрос к vCenter на загрузку, принудительное выключение или принудительную перезагрузку гостевой системы.
Требования
Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.
- vSphere 7.0.3 или более поздней версии
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
session_timeout float добавлено в vmware.vmware_rest 2.1.0 | Настройки тайм-аута клиентского сеанса. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
state string / обязательный | Допустимые значения:
|
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-сертификатах. Установите значение Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Допустимые значения:
|
vm string / обязательный | Идентификатор виртуальной машины. Параметр должен содержать идентификатор ресурса, возвращаемый модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр обязателен. |
Примечания
Примечание
- Проверено на vSphere 7.0.3
См. также
См. также
- vmware.vmware_rest.vcenter_vm_guest_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: Turn the power of the VM on
vmware.vmware_rest.vcenter_vm_power:
state: start
vm: '{{ my_vm.id }}'
- name: Turn on the power of the VM
vmware.vmware_rest.vcenter_vm_power:
state: start
vm: '{{ my_vm.id }}'
- 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: Turn the power of the VM on
vmware.vmware_rest.vcenter_vm_power:
state: start
vm: '{{ test_vm1_info.id }}'
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
msg string | Выключить виртуальную машину Возвращается: при успешном выполнении Пример: |
results list / элементы=string | Выключить виртуальную машину Возвращается: при успешном выполнении Пример: |
Статус
- Этот модуль будет удалён в версии 5.0.0. [устарел]
- Дополнительные сведения см. в разделе УСТАРЕЛО.
Ссылки на коллекцию
© 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_module.html
