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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.xenserver_guest_info.

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

Описание

Этот модуль можно использовать для сбора основных фактов о ВМ.

Требования

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

XenAPI

Параметры

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

Атрибуты

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

Примечания

Примечание

Минимальная поддерживаемая версия 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. Библиотека также доступна в 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: Gather facts
  community.general.xenserver_guest_info:
    hostname: "{{ xenserver_hostname }}"
    username: "{{ xenserver_username }}"
    password: "{{ xenserver_password }}"
    name: testvm_11
  delegate_to: localhost
  register: facts

Значения возврата

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

Ключ	Описание
instance словарь	Метаданные о ВМ Возвращаемое значение: всегда Пример: {"cdrom": {"type": "none"}, "customization_agent": "native", "disks": [{"name": "testvm_11-0", "name_desc": "", "os_device": "xvda", "size": 42949672960, "sr": "Local storage", "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075", "vbd_userdevice": "0"}, {"name": "testvm_11-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": "testvm_11", "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": "testvm_11-0", "name_desc": "", "os_device": "xvda", "size": 42949672960, "sr": "Local storage", "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075", "vbd_userdevice": "0"}, {"name": "testvm_11-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": "testvm_11", "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/xenserver_guest_info_module.html