community.general.xenserver_guest_powerstate – Управляет состояниями питания виртуальных машин, работающих на хосте или пуле Citrix Hypervisor/XenServer

Примечание

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

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

Для использования в плейбуке укажите: community.general.xenserver_guest_powerstate.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль может использоваться для включения, выключения, перезагрузки или приостановки виртуальной машины и плавного перезапуска или выключения гостевой операционной системы виртуальной машины.

Требования

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

python >= 2.6
XenAPI

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
hostname строка	Значение по умолчанию: "localhost"	Имя хоста или IP-адрес хоста XenServer или главного узла пула XenServer. Если значение не указано в задаче, используется значение переменной окружения `XENSERVER_HOST`. псевдонимы: host, pool
name строка		Имя виртуальной машины для управления. Виртуальные машины, работающие на XenServer, необязательно имеют уникальные имена. Модуль завершится ошибкой, если найдено несколько виртуальных машин с одинаковым именем. В случае нескольких виртуальных машин с одинаковым именем, используйте `uuid`, чтобы однозначно указать виртуальную машину для управления. Этот параметр чувствителен к регистру. псевдонимы: name_label
password строка		Пароль для подключения к XenServer. Если значение не указано в задаче, используется значение переменной окружения `XENSERVER_PASSWORD`. псевдонимы: pass, pwd
state строка	Варианты: включена выключена перезагружена выключить-гостевую перезапустить-гостевую приостановлена настоящая ←	Укажите состояние, в котором должна находиться виртуальная машина. Если `state` установлено в значение, отличное от `present`, то виртуальная машина переводится в необходимое состояние, и возвращаются факты. Если `state` установлено в `present`, то виртуальная машина проверяется только на наличие и возвращаются факты.
state_change_timeout целое число	Значение по умолчанию: 0	По умолчанию модуль будет ожидать неопределенное время, пока виртуальная машина не изменит состояние или не получит IP-адрес, если `wait_for_ip_address: yes`. Если этот параметр установлен на положительное значение, модуль вместо этого будет ожидать указанное количество секунд для изменения состояния. В случае истечения времени ожидания модуль выведет сообщение об ошибке.
username строка	Значение по умолчанию: "root"	Имя пользователя для подключения к XenServer. Если значение не указано в задаче, используется значение переменной окружения `XENSERVER_USER`. псевдонимы: admin, user
uuid строка		UUID виртуальной машины для управления, если известен. Это уникальный идентификатор XenServer. Требуется, если имя не уникально.
validate_certs логическое значение	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false`, если сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной окружения `XENSERVER_VALIDATE_CERTS`.
wait_for_ip_address логическое значение	Варианты: нет ← да	Ожидать, пока XenServer не обнаружит IP-адрес виртуальной машины. Для правильной работы требуется предварительная установка XenServer Tools на виртуальной машине.

Примечания

Примечание

Минимальная поддерживаемая версия XenServer — 5.6.
Модуль был протестирован с XenServer 6.5, 7.1, 7.2, 7.6, Citrix Hypervisor 8.0, XCP-ng 7.6 и 8.0.
Чтобы получить библиотеку XenAPI Python, просто выполните pip install XenAPI на узле управления Ansible. Библиотека также находится в SDK Citrix Hypervisor/XenServer (скачивается с веб-сайта Citrix). Скопируйте файл XenAPI.py из SDK в папку site-packages Python на узле управления Ansible, чтобы использовать его. Последнюю версию библиотеки также можно получить с GitHub: https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py
Если в hostname не указан протокол, модуль по умолчанию использует http://, потому что https:// проблематичен в большинстве настроек. Убедитесь, что вы получаете доступ к хосту XenServer в надёжной среде или используйте явно протокол https://.
Чтобы использовать протокол https:// для hostname, необходимо либо импортировать сертификат хоста в хранилище сертификатов вашей операционной системы, либо использовать validate_certs: no, что требует библиотеки XenAPI из SDK XenServer 7.2 или более поздней версии и Python 2.7.9 или более поздней версии.

Примеры

- name: Power on VM
  community.general.xenserver_guest_powerstate:
    hostname: "{{ xenserver_hostname }}"
    username: "{{ xenserver_username }}"
    password: "{{ xenserver_password }}"
    name: testvm_11
    state: powered-on
  delegate_to: localhost
  register: facts

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

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

Ключ	Возвращённое значение	Описание
instance словарь	всегда	Метаданные о виртуальной машине Пример: {'cdrom': {'type': 'none'}, 'customization_agent': 'native', 'disks': [{'name': 'windows-template-testing-0', 'name_desc': '', 'os_device': 'xvda', 'size': 42949672960, 'sr': 'Локальное хранилище', 'sr_uuid': '0af1245e-bdb0-ba33-1446-57a962ec4075', 'vbd_userdevice': '0'}, {'name': 'windows-template-testing-1', 'name_desc': '', 'os_device': 'xvdb', 'size': 42949672960, 'sr': 'Локальное хранилище', 'sr_uuid': '0af1245e-bdb0-ba33-1446-57a962ec4075', 'vbd_userdevice': '1'}], 'domid': '56', 'folder': '', 'hardware': {'memory_mb': 8192, 'num_cpu_cores_per_socket': 2, 'num_cpus': 4}, 'home_server': '', 'is_template': False, 'name': 'windows-template-testing', 'name_desc': '', 'networks': [{'gateway': '192.168.0.254', 'gateway6': 'fc00::fffe', 'ip': '192.168.0.200', 'ip6': ['fe80:0000:0000:0000:e9cb:625a:32c5:c291', 'fc00:0000:0000:0000:0000:0000:0000:0001'], 'mac': 'ba:91:3a:48:20:76', 'mtu': '1500', 'name': 'Сеть пула, связанная с eth1', 'netmask': '255.255.255.128', 'prefix': '25', 'prefix6': '64', 'vif_device': '0'}], 'other_config': {'base_template_name': 'Windows Server 2016 (64-bit)', 'import_task': 'OpaqueRef:e43eb71c-45d6-5351-09ff-96e4fb7d0fa5', 'install-methods': 'cdrom', 'instant': 'true', 'mac_seed': 'f83e8d8a-cfdc-b105-b054-ef5cb416b77e'}, 'platform': {'acpi': '1', 'apic': 'true', 'cores-per-socket': '2', 'device_id': '0002', 'hpet': 'true', 'nx': 'true', 'pae': 'true', 'timeoffset': '-25200', 'vga': 'std', 'videoram': '8', 'viridian': 'true', 'viridian_reference_tsc': 'true', 'viridian_time_ref_count': 'true'}, 'state': 'включена', 'uuid': 'e3c0b2d5-5f05-424e-479c-d3df8b3e7cda', 'xenstore_data': {'vm-data': ''}}

Авторы

Боян Витник (@bvitnik) <bvitnik@mainstream.rs>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/xenserver_guest_powerstate_module.html