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

Примечание

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

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

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

Для использования в playbook, укажите: 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	Поддержка: отсутствует	В режиме diff вернет подробную информацию о том, что изменилось (или, возможно, что нужно изменить в `check_mode`),

Примечания

Примечание

Минимально поддерживаемая версия XenServer — 5.6.
Модуль тестировался с XenServer 6.5, 7.1, 7.2, 7.6, Citrix Hypervisor 8.0, XCP-ng 7.6 и 8.0.
Для получения Python библиотеки XenAPI просто выполните pip install XenAPI на вашем Ansible Control Node. Библиотеку также можно найти в SDK Citrix Hypervisor/XenServer (скачивается с сайта Citrix). Скопируйте файл XenAPI.py из SDK в вашу директорию Python site-packages на вашем Ansible Control Node для использования. Последнюю версию библиотеки также можно получить с 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 из XenServer 7.2 SDK или более поздней версии и 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": ""}}

Авторы

Боян Витник (@bvitnik)

Ссылки на сборку

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