vmware_guest_powerstate – Управляет состояниями питания виртуальных машин в vCenter
Новая версия с 2.5.
Обзор
- Включение/выключение/перезагрузка виртуальной машины.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| folder строка | Папка назначения, абсолютный или относительный путь к существующей гостевой системе. Папка должна включать в себя центр обработки данных. Центр обработки данных 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 | |
| force булево добавлен в 2.5 |
| Игнорировать предупреждения и выполнить действия. Этот параметр полезен при принудительном изменении состояния виртуальной машины. |
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задании, используется значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| moid строка добавлен в 2.9 | Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Это необходимо, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины для работы. Имена виртуальных машин в vCenter не обязательно уникальны, что может быть проблематично, см. name_match. | |
| name_match строка |
| Если несколько виртуальных машин соответствуют имени, используйте первую или последнюю найденную. |
| password строка | Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задании, используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлен в 2.5 | Значение по умолчанию: 443 | Порт сервера vCenter или ESXi vSphere. Если значение не указано в задании, используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host строка добавлен в 2.9 | Адрес прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задании, используется значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | |
| proxy_port целое число добавлен в 2.9 | Порт HTTP-прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их. Если значение не указано в задании, используется значение переменной среды VMWARE_PROXY_PORT. | |
| schedule_task_description строка добавлен в 2.9 | Описание задачи планирования. Действительно только если указан scheduled_at. | |
| schedule_task_enabled булево добавлен в 2.9 |
| Флаг, указывающий, включена или отключена запланированная задача. |
| schedule_task_name строка добавлен в 2.9 | Имя задачи планирования. Действительно только если указан scheduled_at. | |
| scheduled_at строка | Дата и время в строковом формате, когда должна быть выполнена указанная задача. Требуемый формат даты и времени — 'дд/мм/гггг чч:мм'. Для планирования задач требуется сервер vCenter. Отдельный сервер ESXi эту опцию не поддерживает. | |
| state строка |
| Установите состояние виртуальной машины. |
| state_change_timeout целое число добавлен в 2.6 | Значение по умолчанию: 0 | Если state установлено в shutdown-guest, по умолчанию модуль вернет результат сразу после отправки сигнала завершения.Если этот аргумент установлен на положительное целое число, модуль вместо этого подождет, пока VM не перейдет в состояние выключено. Значение устанавливает тайм-аут в секундах, в течение которого модуль ожидает изменения состояния. |
| use_instance_uuid булево добавлен в 2.8 |
| Использовать UUID экземпляра VMware вместо BIOS UUID. |
| username строка | Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задании, используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| uuid строка | UUID экземпляра для управления, если известен. Уникальный идентификатор VMware. Это необходимо, если name или moid не указаны. | |
| 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 poweron using MoID
vmware_guest_powerstate:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
validate_certs: no
folder: "/{{ datacenter_name }}/vm/my_folder"
moid: vm-42
state: powered-on
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"
schedule_task_name: "task_00001"
schedule_task_description: "Sample task to poweroff VM"
schedule_task_enabled: True
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.9/modules/vmware_guest_powerstate_module.html
