Модуль vmware.vmware_rest.vcenter_vm_power – Выполнение загрузки, принудительного завершения работы, принудительной перезагрузки или принудительной приостановки гостевой ОС.
Примечание
Этот модуль является частью коллекции 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_power.
Новое в vmware.vmware_rest 0.1.0
Краткое описание
- Запрос к 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 / обязательно | Идентификатор виртуальной машины. Параметр должен быть id ресурса, возвращаемого 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 / elements=string | Выключение виртуальной машины Возвращается: При успехе Пример: |
Ссылки на коллекцию
© 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_module.html
