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

Примечание

Этот модуль входит в коллекцию community.vmware (версия 4.7.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_guest_powerstate.

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

Обзор

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

Параметры

Параметр	Комментарии
answer список / элементы=словарь	Список ответов на вопросы, которые могут возникнуть при ожидании завершения задачи. Часто используется для возможности изменения CD-ROM, даже если он заблокирован, или для ответа на вопрос о том, была ли виртуальная машина скопирована или перемещена. Может быть использован, если `state=powered-on`.
question строка / обязательный	Идентификатор сообщения, например `msg.uuid.altered`.
response строка / обязательный	Ключ выбора, например `button.uuid.copiedTheVM`.
datacenter строка	Центр обработки данных, где находится виртуальная машина, над которой нужно выполнить операцию с питанием. По умолчанию: `"ha-datacenter"`
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 логическое	Проигнорировать предупреждения и выполнить действия. Этот параметр полезен для принудительного изменения состояния виртуальной машины. Варианты: `false` ← (по умолчанию) `true`
hostname строка	Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`.
moid строка	Идентификатор управляемого объекта экземпляра для управления, если он известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Это требуется, если `name` или `uuid` не указаны.
name строка	Имя виртуальной машины, с которой нужно работать. Имена виртуальных машин в vCenter не обязательно уникальны, что может быть проблематично, см. `name_match`.
name_match строка	Если несколько виртуальных машин соответствуют имени, использовать первую или последнюю найденную. Варианты: `"first"` ← (по умолчанию) `"last"`
password псевдонимы: pass, pwd строка	Пароль от сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port целое число	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`

state string	Установите состояние виртуальной машины. Варианты: `"powered-off"` `"powered-on"` `"reboot-guest"` `"restarted"` `"shutdown-guest"` `"suspended"` `"present"` ← (по умолчанию)
state_change_timeout integer	Если `state=shutdown-guest`, по умолчанию модуль вернётся сразу после отправки сигнала завершения работы. Если этот аргумент задан положительным целым числом, модуль будет ожидать, пока ВМ перейдёт в состояние выключения. Значение задаёт таймаут в секундах для ожидания изменения состояния модулем. По умолчанию: `0`
use_instance_uuid boolean	Использовать UUID экземпляра VMware вместо BIOS UUID. Варианты: `false` ← (по умолчанию) `true`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задании, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
uuid string	UUID экземпляра для управления, если известен. Это уникальный идентификатор VMware. Требуется, если `name` или `moid` не указаны.
validate_certs boolean	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false`, если сертификаты не доверяются. Если значение не указано в задании, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Все модули требуют доступ к API для записи и поэтому не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- 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

- name: Automatically answer if a question locked a virtual machine
  block:
    - name: Power on a virtual machine without the answer param
      community.vmware.vmware_guest_powerstate:
        hostname: "{{ esxi_hostname }}"
        username: "{{ esxi_username }}"
        password: "{{ esxi_password }}"
        validate_certs: false
        folder: "{{ f1 }}"
        name: "{{ vm_name }}"
        state: powered-on
  rescue:
    - name: Power on a virtual machine with the answer param
      community.vmware.vmware_guest_powerstate:
        hostname: "{{ esxi_hostname }}"
        username: "{{ esxi_username }}"
        password: "{{ esxi_password }}"
        validate_certs: false
        folder: "{{ f1 }}"
        name: "{{ vm_name }}"
        answer:
          - question: "msg.uuid.altered"
            response: "button.uuid.copiedTheVM"
        state: powered-on

Авторы

Abhijeet Kasurde (@Akasurde)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_guest_powerstate_module.html