community.vmware.vmware_guest_powerstate – Управляет состояниями питания виртуальных машин в vCenter

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install community.vmware.

Для использования в playbook, укажите: community.vmware.vmware_guest_powerstate.

Обзор
Требования
Параметры
Примеры

Обзор

Включение/выключение/перезагрузка виртуальной машины.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

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 логическое	Варианты: нет ← да	Игнорировать предупреждения и выполнить действия. Этот параметр полезен при принудительном изменении состояния виртуальной машины.
hostname строка		Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
moid строка		Идентификатор управляемого объекта экземпляра для управления, если он известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Требуется, если не указаны `name` или `uuid`.
name строка		Имя виртуальной машины для работы. Имена виртуальных машин в vCenter не обязательно уникальны, что может вызвать проблемы, см. `name_match`.
name_match строка	Варианты: первый ← последний	Если несколько виртуальных машин соответствуют имени, используется первая или последняя найденная.
password строка		Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в Ansible 2.6. Псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в Ansible 2.6.
proxy_host строка		Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
schedule_task_description строка		Описание задачи планирования. Допустимо только если указано `scheduled_at`.
schedule_task_enabled логическое	Варианты: нет да ←	Флаг, указывающий, включена или выключена запланированная задача.
schedule_task_name строка		Имя задачи планирования. Допустимо только если указано `scheduled_at`.
scheduled_at строка		Дата и время в строчном формате, когда должна быть выполнена заданная задача. Требуемый формат даты и времени — 'дд/мм/гггг чч:мм'. Для планирования задачи требуется сервер vCenter. У автономного сервера ESXi этот параметр недоступен.
state строка	Варианты: выключено включено перезагрузка-гостя перезагружено выключение-гостя приостановлено наличие ←	Установить состояние виртуальной машины.
state_change_timeout целое число	Значение по умолчанию: 0	Если `state` установлено в `shutdown-guest`, по умолчанию модуль возвращает результат сразу после отправки сигнала выключения. Если этот аргумент установлен на положительное целое число, модуль вместо этого ждет, пока VM перейдет в выключенное состояние. Значение устанавливает таймаут в секундах для ожидания изменения состояния модулем.
use_instance_uuid логическое	Варианты: нет ← да	Использовать UUID экземпляра VMware вместо BIOS UUID.
username строка		Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. Псевдонимы: admin, user
uuid строка		UUID экземпляра для управления, если известен. Это уникальный идентификатор VMware. Требуется, если не указаны `name` или `moid`.
validate_certs логическое	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в `false` при недоверенных сертификатах. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено в `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примеры

- name: Set the state of a virtual machine to poweroff
  community.vmware.vmware_guest_powerstate:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    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
  community.vmware.vmware_guest_powerstate:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    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
  community.vmware.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
  community.vmware.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

Авторы

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.10/collections/community/vmware/vmware_guest_powerstate_module.html