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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.xenserver_guest_powerstate.

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

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

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

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

XenAPI

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).

Примечания

Примечание

Минимальная поддерживаемая версия 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": "Local storage", "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075", "vbd_userdevice": "0"}, {"name": "windows-template-testing-1", "name_desc": "", "os_device": "xvdb", "size": 42949672960, "sr": "Local storage", "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": "Pool-wide network associated with 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": "poweredon", "uuid": "e3c0b2d5-5f05-424e-479c-d3df8b3e7cda", "xenstore_data": {"vm-data": ""}}

Ключ

Описание

instance

словарь

Метаданные виртуальной машины.

Возвращается: всегда

Пример: {"cdrom": {"type": "none"}, "customization_agent": "native", "disks": [{"name": "windows-template-testing-0", "name_desc": "", "os_device": "xvda", "size": 42949672960, "sr": "Local storage", "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075", "vbd_userdevice": "0"}, {"name": "windows-template-testing-1", "name_desc": "", "os_device": "xvdb", "size": 42949672960, "sr": "Local storage", "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": "Pool-wide network associated with 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": "poweredon", "uuid": "e3c0b2d5-5f05-424e-479c-d3df8b3e7cda", "xenstore_data": {"vm-data": ""}}

Авторы

Bojan Vitnik (@bvitnik)

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

© 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/general/xenserver_guest_powerstate_module.html