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

Примечание

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

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

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

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

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Статус

УСТАРЕЛО

Удалён в:: версии 7.0.0
Причина:: Этот модуль перенесён в новую коллекцию vmware.vmware
Альтернатива:: Используйте вместо него vmware.vmware.vm_powerstate.

Краткое описание

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

Параметры

Параметр	Комментарии
answer list / elements=dictionary	Список вопросов и ответов на них, которые могут появиться во время ожидания завершения задачи. Например, это можно использовать, чтобы разрешить замену CD-ROM, даже если он заблокирован, или ответить на вопрос о том, была ли виртуальная машина скопирована или перемещена. Можно использовать, если `state=powered-on`.
question string / обязательный	Идентификатор сообщения, например `msg.uuid.altered`.
response string / обязательный	Ключ выбранного ответа, например `button.uuid.copiedTheVM`.
datacenter string	Центр обработки данных, в котором находится виртуальная машина, для которой требуется управлять состоянием питания. По умолчанию: `"ha-datacenter"`
folder string	Папка назначения: абсолютный или относительный путь для поиска существующей гостевой системы. Путь к папке должен включать центр обработки данных. Центр обработки данных 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 boolean	Игнорировать предупреждения и выполнять действия. Этот параметр полезен при принудительном изменении состояния виртуальной машины. Варианты: `false` ← (по умолчанию) `true`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
moid string	Идентификатор управляемого объекта экземпляра, которым нужно управлять, если он известен. Этот уникальный идентификатор действует только в пределах одного экземпляра vCenter. Параметр обязателен, если не указан `name` или `uuid`.
name string	Имя виртуальной машины, с которой нужно работать. Имена виртуальных машин в vCenter не обязательно уникальны, что может вызвать проблемы; см. `name_match`.
name_match string	Если найдено несколько виртуальных машин с соответствующим именем, использовать первую или последнюю найденную. Варианты: `"first"` ← (по умолчанию) `"last"`
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать и перенаправлять все HTTPS-запросы. Укажите имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси-сервера, который будет получать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_PORT`.
schedule_task_description string	Описание запланированной задачи. Действительно, только если указан параметр `scheduled_at`.
schedule_task_enabled boolean	Флаг, указывающий, включена или отключена запланированная задача. Варианты: `false` `true` ← (по умолчанию)
schedule_task_name string	Имя запланированной задачи. Действительно, только если указан параметр `scheduled_at`.
scheduled_at string	Дата и время в строковом формате, когда должна быть выполнена указанная задача. Требуемый формат даты и времени — «dd/mm/yyyy hh:mm». Для планирования задачи требуется сервер vCenter. Автономный сервер ESXi не поддерживает этот параметр.
state string	Задать состояние виртуальной машины. Варианты: `"powered-off"` `"powered-on"` `"reboot-guest"` `"restarted"` `"shutdown-guest"` `"suspended"` `"present"` ← (по умолчанию)
state_change_timeout integer	Если выполняется `state=shutdown-guest`, по умолчанию модуль возвращает управление сразу после отправки сигнала выключения. Если для этого аргумента задано положительное целое число, модуль будет ожидать, пока виртуальная машина не перейдёт в состояние poweredoff. Значение задаёт время ожидания изменения состояния в секундах. По умолчанию: `0`
use_instance_uuid boolean	Использовать UUID экземпляра VMware вместо UUID BIOS. Варианты: `false` ← (по умолчанию) `true`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
uuid string	UUID экземпляра, которым нужно управлять, если он известен. Это уникальный идентификатор VMware. Параметр обязателен, если не указан `name` или `moid`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Если сертификатам не доверяют, задайте значение `false`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Всем модулям требуется доступ к API на запись, поэтому они не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не обращается к системному хранилищу сертификатов. Чтобы указать хранилище сертификатов, задайте переменную окружения REQUESTS_CA_BUNDLE. Учтите, что при задании этой переменной в некоторых случаях параметр ‘validate_certs’ со значением ‘false’ может игнорироваться. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- 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

Статус

Этот модуль будет удалён в версии 7.0.0. [устарело]
Подробнее см. раздел УСТАРЕЛО.

Авторы

Abhijeet Kasurde (@Akasurde)

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

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