virt-inspector(1)

НАЗВА
virt-inspector — показ версії операційної системи та інших даних щодо віртуальної машини

КОРОТКИЙ ОПИС
 virt-inspector [--параметри] -d назва_домену

 virt-inspector [--параметри] -a диск.img [-a диск.img ...]

Застарілий стиль:

 virt-inspector назва_домену

 virt-inspector диск.img [диск.img ...]

ОПИС
virt-inspector виконує вивчення віртуальної машини або образу диска і намагається визначити версію операційної системи та інші дані щодо віртуальної машини.

Virt-inspector виводить дані XML для обробки у інших програмах.

У звичайному режимі користуйтеся командою "virt-inspector -d назва_домену", де "назва_домену" — назва домену libvirt (див. "virsh list --all").

Ви також можете запускати virt-inspector безпосередньо для образів дисків з однієї віртуальної машини. Для цього слід використовувати команду "virt-inspector -a образ.диска". У рідкісних випадках у домені може бути декілька блокових пристроїв. У цьому випадку вам слід вказати список із декількох параметрів -a, один за одним. Перший має відповідати пристрою /dev/sda гостьової системи, другий — пристрою /dev/sdb гостьової системи тощо.

Ви також можете запускати virt-inspector для дисків для встановлення системи, образів компакт-дисків для портативних систем, призначених для завантаження образів флешок USB тощо.

Virt-inspector може одночасно інспектувати і створювати звіт лише для одного домену. Для інспектування декількох віртуальних машин вам доведеться запускати virt-inspector декілька разів (наприклад, із циклу for скрипту оболонки).

Оскільки virt-inspector потрібен безпосередній доступ до образів гостьової системи, програма, зазвичай, не працюватиме, якщо використовується віддалене з'єднання із libvirt.

Усі дані, які доступні за допомогою virt-inspector, також доступні і з основного програмного інтерфейсу інспектування libguestfs (див. "ІНСПЕКТУВАННЯ" in guestfs(3)). Ті самі дані можна також отримати за допомогою guestfish або прив'язок до libguestfs багатьма мовами програмування (див. "ОТРИМАННЯ ДАНИХ ІНСПЕКТУВАННЯ ЗА ДОПОМОГОЮ ПРОГРАМНОГО ІНТЕРФЕЙСУ LIBGUESTFS").

Additional information about bootloader, kernel and drivers inside a guest can be found using virt-drivers(1).

ПАРАМЕТРИ

--help
    Показати коротку довідку.

-a файл
--add файл
    Додати файл, який має бути образом диска з віртуальної машини. Якщо у віртуальній машині декілька блокових пристроїв, вам слід вказати їх усі за допомогою окремих записів параметра -a.

    Формат образу диска визначається автоматично. Щоб перевизначити його і примусово використати певний формат, скористайтеся параметром --format=...

-a адреса
--add адреса
    Додати віддалений диск. Див. "ДОДАВАННЯ ВІДДАЛЕНОГО СХОВИЩА" in guestfish(1).

--blocksize=512
--blocksize=4096
--blocksize
    This parameter sets the sector size of the disk image. It affects all explicitly added subsequent disks after this parameter. Using --blocksize with no argument switches the disk sector size to the default value which is usually 512 bytes. See also "guestfs_add_drive_opts" in guestfs(3).

-c адреса
--connect адреса
    Якщо використовується libvirt, встановити з’єднання з вказаним URI. Якщо пропущено, з’єднання буде встановлено з типовим гіпервізором libvirt.

    Libvirt використовуватиметься, лише якщо ви вкажете "назву домену" у рядку команди. Якщо вказати блокові пристрої гостьових систем безпосередньо (-a), libvirt не буде використовуватися взагалі.

-d гість
--domain гість
    Додати всі диски з вказаної гостьової системи libvirt. UUID доменів можна використовувати замість назв.

--echo-keys
    Типово, якщо virt-inspector попросить вас ввести ключ або пароль, програма не відтворюватиме введені символи на екрані. Якщо ви не боїтеся TEMPEST-нападів, або у вашій кімнаті нікого, окрім вас, немає, ви можете скористатися цим прапорцем, щоб бачити, які саме символи ви вводите.

--format=raw|qcow2|..
--format
    Визначає формат образу диска, назву якого вказано у рядку команди. Якщо формат не вказано, його буде визначено автоматично на основі вмісту образу диска.

    Якщо вказаний диск походить з libvirt, ця програма надішле запит щодо даних до libvirt. У цьому випадку вказане значення параметра формату буде проігноровано.

    Якщо ви працюєте із образами дисків гостьових систем у форматі raw із ненадійних джерел, вам слід завжди вказувати назву формату.

--key SELECTOR
    Specify a key for LUKS, to automatically open a LUKS device when using the inspection.

    --key NAME:key:KEY_STRING
    --key UUID:key:KEY_STRING
    --key all:key:KEY_STRING
        "NAME" is the libguestfs device name (eg. "/dev/sda1"). "UUID" is the device UUID. "all" means try the key against any encrypted device.

        Use the specified "KEY_STRING" as passphrase.

    --key NAME:file:FILENAME
    --key UUID:file:FILENAME
    --key all:file:FILENAME
        Read the passphrase from FILENAME.

    --key NAME:clevis
    --key UUID:clevis
    --key all:clevis
        Attempt passphrase-less unlocking for the device with Clevis, over the network. Please refer to "ENCRYPTED DISKS" in guestfs(3) for more information on network-bound disk encryption (NBDE).

        Note that if any such option is present on the command line, QEMU user networking will be automatically enabled for the libguestfs appliance.

--keys-from-stdin
    Read key or passphrase parameters from stdin. The default is to try to read passphrases from the user by opening /dev/tty.

    If there are multiple encrypted devices then you may need to supply multiple keys on stdin, one per line.

--no-applications
    Типово, виведені virt-inspector дані містять список програм, які встановлено у гостьовій системі, якщо такий список доступний.

    Вкажіть цей параметр, щоб вимкнути частину XML результату.

--no-icon
    Типово, виведені virt-inspector дані містять список програм, які встановлено у гостьовій системі, якщо такий список доступний (див. "icon").

    Вкажіть цей параметр, щоб вимкнути частину XML результату.

-v
--verbose
    Увімкнути докладний показ повідомлень з метою діагностики.

-V
--version
    Показати дані щодо версії і завершити роботу.

-x  Увімкнути трасування викликів програмного інтерфейсу libguestfs.

--xpath запит
    Виконати запит XPath до XML у stdin і вивести результат до stdout. У цьому режимі virt-inspector просто виконує запит XPath; усі інші функції інспектування буде вимкнено. Приклади запитів наведено у розділі "ЗАПИТИ XPATH" нижче.

ПАРАМЕТРИ КОМАНДНОГО РЯДКА У ФОРМАТІ ПОПЕРЕДНІХ ВЕРСІЙ
У попередніх версіях virt-inspector можна було використовувати або

 virt-inspector диск.img [диск.img ...]

або

 virt-inspector назва_гостьової_системи

тоді як у цій версії вам слід скористатися -a або -d, відповідно, щоб уникнути помилок у випадках, коли назва образу диска може збігатися із назвою гостьової системи.

З міркувань зворотної сумісності передбачено підтримку запису параметрів у застарілому форматі.

ФОРМАТ XML
Точний опис XML virt-inspector наведено у файлі схеми RELAX NG virt-inspector.rng, який постачається разом із libguestfs. Цей розділ містить лише поверхневий огляд.

Елементом верхнього рівня є <operatingsystems>. Він містить один або декілька елементів <operatingsystem>. Елементів <operatingsystem> буде декілька, лише якщо у віртуальній машині передбачено декілька варіантів завантаження. Такі випадки є дуже рідкісними у світі віртуальних машин.

  <operatingsystem>
Всередині теґу <operatingsystem> містяться різноманітні необов'язкові поля, які описують операційну систему, її архітектуру, містять описовий рядок «назва продукту», тип операційної системи тощо. Ось приклад:

 <operatingsystems>
   <operatingsystem>
     <root>/dev/sda2</root>
     <name>windows</name>
     <arch>i386</arch>
     <distro>windows</distro>
     <product_name>Windows 7 Enterprise</product_name>
     <product_variant>Client</product_variant>
     <major_version>6</major_version>
     <minor_version>1</minor_version>
     <windows_systemroot>/Windows</windows_systemroot>

Якщо коротко, <name> — клас операційної системи (щось подібне до "linux" або "windows"), <distro> — дистрибутив (наприклад, "fedora", але передбачено розпізнавання багатьох інших дистрибутивів), а <arch> — архітектура гостьової системи. Інші поля мають доволі зрозуміле призначення, але оскільки ці поля взято безпосередньо з програмного інтерфейсу інспектування libguestfs, їхній повний опис можна знайти у розділі "ІНСПЕКТУВАННЯ" in guestfs(3).

Елемент <root> є пристроєм кореневої файлової системи, але з точки зору libguestfs (блокові пристрої можуть мати зовсім інші назви у самій віртуальній машині).

  <mountpoints>
У Un*x-подібних гостьових системах типово міститься декілька файлових систем, які монтуються як різні точки монтування. Ці файлові системи описано у елементі <mountpoints>, який виглядає ось так:

 <operatingsystems>
   <operatingsystem>
     ...
     <mountpoints>
       <mountpoint dev="/dev/vg_f13x64/lv_root">/</mountpoint>
       <mountpoint dev="/dev/sda1">/boot</mountpoint>
     </mountpoints>

Як і з <root>, пристрої подано з точки зору libguestfs, отже вони можуть мати зовсім інші назви у гостьовій системі. У списку буде наведено лише монтовані файлові системи, а не щось подібне до пристроїв резервної пам'яті на диску.

  <filesystems>
Елемент <filesystems> подібний до <mountpoints>, але стосується файлових усіх файлових систем, що належать гостьовій операційній системі, зокрема розділів резервної пам'яті на диску та порожніх розділів. (У рідкісних випадках гостьової системи із варіантами завантаження, цей елемент стосується файлових систем, що належать цій операційній системі або є спільними для цієї операційної системи та інших операційних систем.)

Ви побачите щось таке:

 <operatingsystems>
   <operatingsystem>
     ...
     <filesystems>
       <filesystem dev="/dev/vg_f13x64/lv_root">
         <type>ext4</type>
         <label>Fedora-13-x86_64</label>
         <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>
       </filesystem>

Необов'язкові елементи у <filesystem> стосуються типу, мітки та UUID файлової системи.

  <applications>
Пов'язані елементи <package_format>, <package_management> та <applications> описують програми, які встановлено у віртуальній машині.

Елемент <package_format>, якщо він є, описує використану систему пакунків. Типовими значеннями цього елемента є "rpm" та "deb".

Елемент <package_management>, якщо такий є, описує засіб для керування пакунками. Серед типових значень елемента є "yum", "up2date" та "apt".

<applications> містить список пакунків або встановлених програм.

 <operatingsystems>
   <operatingsystem>
     ...
     <applications>
       <application>
         <name>coreutils</name>
         <version>8.5</version>
         <release>1</release>
       </application>

Для деяких типів гостьових системи дані полів версії і випуску можуть бути недоступними. Можлива поява інших полів, див. "guestfs_inspect_list_applications" in guestfs(3).

  <drive_mappings>
Для операційних систем, подібних до Windows, де для позначення дисків використовуються літери, virt-inspector може визначати прив'язки літер дисків до файлових систем.

 <operatingsystems>
   <operatingsystem>
     ...
     <drive_mappings>
       <drive_mapping name="C">/dev/sda2</drive_mapping>
       <drive_mapping name="E">/dev/sdb1</drive_mapping>
     </drive_mappings>

У наведеному вище прикладі диск C пов'язано із файловою системою на другому розділі першого диска, диск E — із файловою системою на першому розділі другого диска.

Зауважте, що це стосується лише постійних прив'язок дисків, а не прив'язок, які подібні до прив'язок до спільних ресурсів у мережі. Крім того, до цього списку може бути не включено точки монтування томів NTFS.

  <icon>
Іноді virt-inspector може видобути піктограму або логотип гостьової системи. Піктограму буде повернуто у форматі даних PNG у кодуванні base64. Зауважте, що піктограма може бути доволі великою і дуже якісною.

 <operatingsystems>
   <operatingsystem>
     ...
     <icon>
       iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]
       [... багато рядків даних base64 ...]
     </icon>

Для показу піктограми вам слід видобути ї і перетворити дані у кодуванні base64 знову у двійковий файл. Скористайтеся запитом XPath або простим редактором для видобування даних, а потім програмою base64(1) з coreutils для перетворення цих даних на файл PNG:

 base64 -i -d < дані.піктограми > icon.png

ЗАПИТИ XPATH
У virt-inspector передбачено вбудовану підтримку виконання запитів XPath. Причиною включення підтримкиXPath безпосередньо до virt-inspector є те, що не існує добрих і широкодоступних засобів командного рядка, які можуть виконувати запити XPath. Єдиним добрим засобом є xmlstarlet(1), але ця програма недоступна у Red Hat Enterprise Linux.

Для виконання запиту XPath скористайтеся параметром --xpath. Зауважте, що у цьому режимі virt-inspector просто читає XML зі stdin і виводить результат запиту до stdout. Усі інші можливості інспектування у цьому режимі вимкнено.

Приклад:

 $ virt-inspector -d Guest | virt-inspector --xpath '//filesystems'
 <filesystems>
      <filesystem dev="/dev/vg_f13x64/lv_root">
        <type>ext4</type>
 [...]

 $ virt-inspector -d Guest | \
     virt-inspector --xpath "string(//filesystem[@dev='/dev/sda1']/type)"
 ext4

 $ virt-inspector -d Guest | \
     virt-inspector --xpath 'string(//icon)' | base64 -i -d | display -
 [показує піктограму гостьової системи, якщо така існує]

ОТРИМАННЯ ДАНИХ ІНСПЕКТУВАННЯ ЗА ДОПОМОГОЮ ПРОГРАМНОГО ІНТЕРФЕЙСУ LIBGUESTFS
У ранніх версіях libguestfs virt-inspector був великим скриптом Perl, до якого було включено багато евристики для інспектування гостьових систем. Цей підхід мав декілька проблем: для виконання інспектування з інших інструментів (зокрема guestfish) нам доводилося викликати цей скрипт Perl; він ставив у пріоритетне становище Perl над іншими мовами програмування, підтримку яких передбачено у libguestfs.

До libguestfs 1.8 ми переписали код Perl на C і включили його до програмного інтерфейсу основи libguestfs (guestfs(3)). Тепер virt-inspector є простим тонким прошарком C над основним програмним інтерфейсом мовою C. Усі дані інспектування доступні з усіх мов програмування, підтримку яких передбачено у libguestfs, і з guestfish.

Опис програмного інтерфейсу інспектування мовою C наведено у розділі "ІНСПЕКТУВАННЯ" in guestfs(3).

Приклад коду, де використовується програмний інтерфейс інспектування мовою C, наведено у файлі inspect-vm.c, який постачається разом із libguestfs.

Крім того, inspect-vm.c трансльовано іншими мовами програмування. Наприклад, inspect_vm.pl є трансляцією на Perl. Також передбачено інші трансляції на OCaml, Python тощо. Див. "ВИКОРИСТАННЯ LIBGUESTFS ЗА ДОПОМОГОЮ ІНШИХ МОВ ПРОГРАМУВАННЯ" in guestfs(3), де наведено список сторінок підручника, де містяться приклади коду.

  ОТРИМАННЯ ДАНИХ ІНСПЕКТУВАННЯ ВІД GUESTFISH
Якщо ви використовуєте параметр guestfish -i, викликається основний програмний інтерфейс інспектування "guestfs_inspect_os" in guestfs(3) мовою C. Це еквівалент команди guestfish "inspect-os". Ви також можете викликати цю команду guestfish вручну.

"inspect-os" виконує інспектування поточного образу диска, повертаючи список знайдених операційних систем. Кожну операційну систему представлено її пристроєм кореневої файлової системи. У більшості випадків ця команда не виводить ніяких даних (не знайдено жодної операційної системи) або виводить єдиний кореневий пристрій, але ви маєте зважати на те, що ця команда може вивести декілька рядків, якщо у образі декілька операційних систем або із гостьовою системою з'єднано компакт-диск для встановлення.

 $ guestfish --ro -a F15x32.img
 ><fs> run
 ><fs> inspect-os
 /dev/vg_f15x32/lv_root

За допомогою кореневого пристрою ви можете отримати подальшу інформацію щодо гостьової системи:

 ><fs> inspect-get-type /dev/vg_f15x32/lv_root
 linux
 ><fs> inspect-get-distro /dev/vg_f15x32/lv_root
 fedora
 ><fs> inspect-get-major-version /dev/vg_f15x32/lv_root
 15
 ><fs> inspect-get-product-name /dev/vg_f15x32/lv_root
 Fedora release 15 (Lovelock)

Обмеження guestfish ускладнюють прив'язку кореневого пристрою до змінної (оскільки у guestfish немає змінних), отже, якщо вам потрібно робити це декілька разів, варто написати скрипт якоюсь іншою мовою програмування, підтримку якої передбачено програмним інтерфейсом libguestfs.

Для отримання списку програм вам спочатку слід змонтувати диски:

 ><fs> inspect-get-mountpoints /dev/vg_f15x32/lv_root
 /: /dev/vg_f15x32/lv_root
 /boot: /dev/vda1
 ><fs> mount-ro /dev/vg_f15x32/lv_root /
 ><fs> mount-ro /dev/vda1 /boot

а далі викличте програмний інтерфейс inspect-list-applications:

 ><fs> inspect-list-applications /dev/vg_f15x32/lv_root | head -28
 [0] = {
   app_name: ConsoleKit
   app_display_name:
   app_epoch: 0
   app_version: 0.4.5
   app_release: 1.fc15
   app_install_path:
   app_trans_path:
   app_publisher:
   app_url:
   app_source_package:
   app_summary:
   app_description:
 }
 [1] = {
   app_name: ConsoleKit-libs
   app_display_name:
   app_epoch: 0
   app_version: 0.4.5
   app_release: 1.fc15
   app_install_path:
   app_trans_path:
   app_publisher:
   app_url:
   app_source_package:
   app_summary:
   app_description:
 }

Зауважте, що для показу піктограми гостьової системи файлові системи має бути змонтовано у означений вище спосіб. Далі, ви можете зробити так:

 ><fs> inspect-get-icon /dev/vg_f15x32/lv_root | display -

ПОПЕРЕДНІ ВЕРСІЇ VIRT-INSPECTOR
Як ми вже вказували вище, ранні версії libguestfs постачалися із іншою програмою virt-inspector, написаною на Perl (поточну версію написано на C). Виведені дані XML virt-inspector на Perl були іншими, програма також могла виводити дані у інших форматах, зокрема текстовому.

Підтримку застарілої версії virt-inspector припинено, вона більше не постачається з libguestfs.

Крім того, до непорозумінь може призвести і те, що разом із Red Hat Enterprise Linux 6 ми постачаємо дві версії virt-inspector із різними назвами:

 virt-inspector     Стара версія на Perl.
 virt-inspector2    Нова версія на C.

СТАН ВИХОДУ
Ця програма повертає значення 0 у разі успішного завершення і ненульове значення, якщо сталася помилка.

ТАКОЖ ПЕРЕГЛЯНЬТЕ
guestfs(3), guestfish(1), http://www.w3.org/TR/xpath/, base64(1), xmlstarlet(1), virt-drivers(1), http://libguestfs.org/.

АВТОРИ

•   Richard W.M. Jones http://people.redhat.com/~rjones/

•   Matthew Booth mbooth@redhat.com

АВТОРСЬКІ ПРАВА
Copyright (C) 2010-2023 Red Hat Inc.

LICENSE

BUGS
To get a list of bugs against libguestfs, use this link: https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools

To report a new bug against libguestfs, use this link: https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools

When reporting a bug, please supply:

•   The version of libguestfs.

•   Where you got libguestfs (eg. which Linux distro, compiled from source, etc)

•   Describe the bug accurately and give a way to reproduce it.

•   Run libguestfs-test-tool(1) and paste the complete, unedited output into the bug report.