vmware_guest_powerstate – Управление состояниями питания виртуальных машин в vCenter
Новая версия 2.5.
Обзор
- Включение/выключение/перезагрузка виртуальной машины.
Требования
Ниже перечислены требования, необходимые для хоста, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| folder строка | Путь к папке назначения для поиска существующей виртуальной машины. Папка должна содержать центр данных. Центр данных ESXi — 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 | |
| force булево добавлено в 2.5 |
| Игнорировать предупреждения и выполнить действия. Этот параметр полезен для принудительного изменения состояния виртуальной машины. |
| hostname строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения VMWARE_HOST. Поддержка переменных окружения добавлена в Ansible 2.6. | |
| name строка | Имя виртуальной машины для работы. Имена виртуальных машин в vCenter не обязательно уникальны, что может быть проблематично, см. name_match. | |
| name_match строка |
| Если найдено несколько виртуальных машин, соответствующих имени, используется первая или последняя найденная. |
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения VMWARE_PASSWORD. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | По умолчанию: 443 | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения VMWARE_PORT. Поддержка переменных окружения добавлена в Ansible 2.6. |
| scheduled_at строка | Дата и время в строковом формате, в которые нужно выполнить задачу. Требуемый формат даты и времени — 'дд/мм/гггг чч:мм'. Планирование задач требует сервера vCenter. Отдельный сервер ESXi эту опцию не поддерживает. | |
| state строка |
| Установить состояние виртуальной машины. |
| state_change_timeout - добавлено в 2.6 | По умолчанию: 0 | Если state установлено в shutdown-guest, по умолчанию модуль возвращает результат сразу после отправки сигнала выключения.Если этот параметр установлен на положительное целое число, модуль вместо этого ожидает, пока ВМ перейдет в состояние выключено. Значение задает тайм-аут в секундах для ожидания изменения состояния модулем. |
| use_instance_uuid булево добавлено в 2.8 |
| Использовать UUID экземпляра VMware вместо UUID BIOS. |
| username строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения VMWARE_USER. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user | |
| uuid строка | UUID экземпляра для управления, если известен, это уникальный идентификатор VMware. Это необходимо, если имя не указано. | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в значение false при недоверенных сертификатах.Если значение не указано в задаче, используется значение переменной окружения VMWARE_VALIDATE_CERTS. Поддержка переменных окружения добавлена в Ansible 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.8/modules/vmware_guest_powerstate_module.html
