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

Примечание

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

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

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

Для использования в playbook, укажите: 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 или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `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 или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, когда сертификаты не заслуживают доверия. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- 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 словарь	метаданные о состоянии системы хоста Возвращается: всегда Пример: `{"esxi01": {"error": "", "msg": "power down 'esxi01' to standby"}}`

Авторы

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