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 boolean добавлено в 2.5 |
| Игнорировать предупреждения и выполнить действия. Этот параметр полезен при принудительном изменении состояния виртуальной машины. |
| hostname строка | Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в версии 2.6. | |
| name - | Имя виртуальной машины для работы. Имена виртуальных машин в vCenter не обязательно уникальны, что может быть проблематично, см. name_match. | |
| name_match - |
| Если несколько виртуальных машин соответствуют имени, используется первая или последняя найденная. |
| password строка | Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной среды VMWARE_PASSWORD.Поддержка переменных среды добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | По умолчанию: 443 | Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной среды VMWARE_PORT.Поддержка переменных среды добавлена в версии 2.6. |
| scheduled_at - | Дата и время в строчном формате, к которому должно быть выполнено указанное задание. Требуемый формат даты и времени — 'дд/мм/гггг чч:мм'. Планирование задач требует сервер vCenter. Отдельный сервер ESXi не поддерживает этот параметр. | |
| state - |
| Установить состояние виртуальной машины. |
| state_change_timeout - добавлено в 2.6 | По умолчанию: 0 | Если state установлено в shutdown-guest, по умолчанию модуль возвращает результат сразу после отправки сигнала остановки.Если этот аргумент установлен на положительное целое число, модуль вместо этого будет ожидать, пока VM перейдет в выключенное состояние. Значение задает тайм-аут в секундах для ожидания модулем изменения состояния. |
| username строка | Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной среды VMWARE_USER.Поддержка переменных среды добавлена в версии 2.6. псевдонимы: admin, user | |
| uuid - | UUID экземпляра для управления, если известен, это уникальный идентификатор VMware. Требуется, если имя не указано. | |
| validate_certs boolean |
| Позволяет подключиться, когда сертификаты 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: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
validate_certs: no
folder: /"{{ datacenter_name }}"/vm/my_folder
name: "{{ guest_name }}"
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: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
folder: /"{{ datacenter_name }}"/vm/my_folder
name: "{{ guest_name }}"
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: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
name: "{{ guest_name }}"
state: shutdown-guest
state_change_timeout: 200
delegate_to: localhost
register: deploy
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/vmware_guest_powerstate_module.html
