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

Примечание

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

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

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

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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

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

Этот модуль позволяет управлять состояниями питания хост-систем в заданной инфраструктуре vCenter.
Пользователь может задавать состояния питания ‘power-down-to-standby’, ‘power-up-from-standby’, ‘shutdown-host’ и ‘reboot-host’.
Состояния ‘reboot-host’, ‘shutdown-host’ и ‘power-down-to-standby’ поддерживаются не всеми хост-системами.

Параметры

Параметр	Комментарии
cluster_name string	Имя кластера, хост-системы которого будут использоваться. Этот параметр обязателен, если не указан `esxi_hostname`.
esxi_hostname string	Имя хост-системы, с которой нужно работать. Этот параметр обязателен, если не указан `cluster_name`.
force boolean	Этот параметр указывает, следует ли переводить хост в заданное пользователем состояние питания независимо от того, находится ли он в режиме обслуживания. Если `state=reboot-host` и `force=true`, хост-система перезагружается независимо от того, находится ли она в режиме обслуживания. Если `state=shutdown-host` и `force=true`, хост-система выключается независимо от того, находится ли она в режиме обслуживания. Если `state=power-down-to-standby` и `force=true`, все выключенные виртуальные машины будут эвакуированы. Не применяется, если `state=power-up-from-standby`. Варианты: `false` ← (по умолчанию) `true`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_HOST`.
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`.
state string	Задаёт состояние хост-системы. Варианты: `"power-down-to-standby"` `"power-up-from-standby"` `"shutdown-host"` ← (по умолчанию) `"reboot-host"`
timeout integer	Этот параметр задаёт время ожидания для `state=power-down-to-standby` или `state=power-up-from-standby`. Игнорируется, если `state=reboot-host` или `state=shutdown-host`. Значение параметра указывается в секундах. По умолчанию: `600`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Set the state of a host system to reboot
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: reboot-host
  delegate_to: localhost
  register: reboot_host

- name: Set the state of a host system to power down to standby
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: power-down-to-standby
  delegate_to: localhost
  register: power_down

- name: Set the state of all host systems from cluster to reboot
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    state: reboot-host
  delegate_to: localhost
  register: reboot_host

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
result dictionary	метаданные о состоянии хост-системы Возвращается: всегда Пример: `{"esxi01": {"error": "", "msg": "power down 'esxi01' to standby"}}`

Авторы

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_host_powerstate_module.html