vmware_guest_powerstate - Управление состояниями питания виртуальных машин в vCenter
Новое в версии 2.5.
Обзор
- Включение/выключение/перезагрузка виртуальной машины.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| folder | По умолчанию: "/vm" | Папка назначения, абсолютный или относительный путь к существующей виртуальной машине или для создания новой. Папка должна содержать центр обработки данных. Центр обработки данных ESX - ha-datacenter Примеры: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2 folder: vm/folder2 folder: folder2 |
| force bool (добавлен в 2.5) |
| Игнорировать предупреждения и выполнить действия. Этот параметр полезен при принудительном изменении состояния виртуальной машины. |
| hostname str | Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных окружения добавлена в версии 2.6. | |
| name | Имя виртуальной машины, с которой нужно работать. Имена виртуальных машин в vCenter не обязательно уникальны, что может быть проблематично, см. name_match. | |
| name_match |
| Если совпадает несколько виртуальных машин, используется первая или последняя найденная. |
| password str | Пароль сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD.Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port int (добавлен в 2.5) | По умолчанию: 443 | Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT.Поддержка переменных окружения добавлена в версии 2.6. |
| scheduled_at | Дата и время в строчном формате, к которому должна быть выполнена конкретная задача. Требуемый формат даты и времени - 'дд/мм/гггг чч:мм'. Для планирования задачи требуется сервер vCenter. У автономного сервера ESXi эта опция не поддерживается. | |
| state |
| Установить состояние виртуальной машины. |
| state_change_timeout (добавлен в 2.6) | По умолчанию: 0 | Если state установлено в shutdown-guest, по умолчанию модуль вернётся сразу после отправки сигнала выключения.Если этот аргумент установлен на положительное целое число, модуль вместо этого будет ожидать, пока VM достигнет состояния выключено. Значение задаёт таймаут в секундах для ожидания модулем изменения состояния. |
| username str | Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER.Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: admin, user | |
| uuid | UUID экземпляра для управления, если известен, это уникальный идентификатор VMware. Это требуется, если имя не указано. | |
| validate_certs bool |
| Разрешить подключение, когда сертификаты SSL недействительны. Установите в значение false при недоверии к сертификатам.Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.Поддержка переменных окружения добавлена в версии 2.6. Если установлено yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примеры
- name: Set the state of a virtual machine to poweroff
vmware_guest_powerstate:
hostname: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
folder: /testvms
name: testvm_2
state: powered-off
delegate_to: localhost
register: deploy
- name: Set the state of a virtual machine to poweroff at given scheduled time
vmware_guest_powerstate:
hostname: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
folder: /datacenter-1/vm/my_folder
name: testvm_2
state: powered-off
scheduled_at: "09/01/2018 10:18"
delegate_to: localhost
register: deploy_at_schedule_datetime
- name: Wait for the virtual machine to shutdown
vmware_guest_powerstate:
hostname: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
name: testvm_2
state: shutdown-guest
state_change_timeout: 200
delegate_to: localhost
register: deploy
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. в здесь.
Автор
- Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com>
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vmware_guest_powerstate_module.html
