Reinstall Xentools (Linux)

Prev Next

Available in VPC

Xentools is used to forward a variety of information from a Linux server to a XEN hypervisor. This page describes how to reinstall Xentools on a Linux server with the aim of troubleshooting.

Check if the hypervisor hosting the VM is XEN.

# Method 1
[root@xen-rockylinux810 ~]# dmesg | grep "Hypervisor detected" | awk -F': ' '{print $2}'
Xen HVM

# Method 2
[root@xen-rockylinux810 ~]# virt-what
xen
xen-hvm

Reinstall Xentools using scripts

Note

This feature is available on CentOS 7 and Ubuntu 18.04.

To reinstall Xentools using a script, follow these steps:

Download and install Xentools

Download Xentools using the script provided on NAVER Cloud Platform Linux server.

  1. Run the script with the following command:
  • Public domain environment server.
    $ wget https://kr.object.ncloudstorage.com/xen-tools-install/linux_xentools_install.sh
$ chmod u+x linux_xentools_install.sh
$ ./linux_xentools_install.sh
  • Private domain environment server.
    $ wget https://kr.object.private.ncloudstorage.com/xen-tools-install/linux_xentools_install.sh
$ chmod u+x linux_xentools_install.sh
$ ./linux_xentools_install.sh
  1. Reboot the server when installation is complete.

Check Xentools operation status

After reinstalling Xentools, verify that the Xentools operation status is normal.

  1. Run the following command.
    Check if the service status is active (running).
     [root@xen-centos78 ~]# systemctl status xe-linux-distribution.service
 ● xe-linux-distribution.service - LSB: Virtual Machine daemon providing host integration services
    Loaded: loaded (/etc/rc.d/init.d/xe-linux-distribution; bad; vendor preset: disabled)
    Active: active (running) since Tue 2025-06-24 16:39:18 KST; 18h ago
      Docs: man:systemd-sysv-generator(8)
   Process: 933 ExecStart=/etc/rc.d/init.d/xe-linux-distribution start (code=exited, status=0/SUCCESS)
    CGroup: /system.slice/xe-linux-distribution.service
            ├─1005 /usr/sbin/xe-daemon -p /var/run/xe-daemon.pid
            ├─1016 logger -t xe-daemon
            └─1021 logger -t xenstore

 Jun 24 16:39:17 xen-centos78 systemd[1]: Starting LSB: Virtual Machine daemon providing host integration services...
 Jun 24 16:39:17 xen-centos78 xe-linux-distribution[933]: Mounting xenfs on /proc/xen: [  OK  ]
 Jun 24 16:39:18 xen-centos78 xe-linux-distribution[933]: Detecting Linux distribution version: [  OK  ]
 Jun 24 16:39:18 xen-centos78 xe-linux-distribution[933]: Starting xe daemon:  [  OK  ]
 Jun 24 16:39:18 xen-centos78 systemd[1]: Started LSB: Virtual Machine daemon providing host integration services.

Check Xentools using NTK

Note

This feature is available on Rocky Linux 8 and Ubuntu 20.04.
As of June 20, 2025, the latest NTK version is v0.8.0, on which this section is based.

Run Linux NTK

To run NTK on a Linux server, follow these steps:

  1. Go to the path where the NTK file is located.
    [root@xen-rockylinux810 ~]# cd /usr/local/etc
  2. Unzip the NTK file.
    [root@xen-rockylinux810 etc]# tar zxvf ntk.tar.gz
  3. Run NTK.
    [root@xen-rockylinux810 etc]# cd ntk; ./ntk

Install new Xentools

If Xentools Guest Agent is not present in the VM, install a new Xentools Guest Agent.

  1. Check if Xentools is installed on the VM.
    If not installed, proceed with the following steps. If already installed, see Check Xentools status or Reinstall Xentools.
    # RockyLinux 8
# If installed
[root@xen-rockylinux810 ~]# rpm -qa | grep xe-guest
xe-guest-utilities-xenstore-7.20.2-1.x86_64
xe-guest-utilities-7.20.2-1.x86_64

# If not installed
[root@xen-rockylinux810 ntk]# rpm -qa | grep xe-guest
[root@xen-rockylinux810 ntk]#

# Ubuntu 20.04
# If installed
root@xen-ubuntu2004:~# dpkg -l | grep xe-guest
ii  xe-guest-utilities                   7.20.0-1                              amd64        Virtual Machine Monitoring Scripts

# If not installed
root@xen-ubuntu2004:~# dpkg -l | grep xe-guest
root@xen-ubuntu2004:~#
  2. Select (E) EXECUTE - << Run System Apps >>.
    xen-guest-agent01
  3. Select (X) XENTOOLS - XENTOOLS INSTALL >>.
    xen-guest-agent02
  4. Check if there is no installed version at the top left, and select (R) RE-INSTALL XEN GUEST AGENT (Xentools) >>.
    xen-guest-agent03
  5. If the installation proceeds successfully, the installation log will display as follows:
    xen-guest-agent04
  6. Check the installed version and click OK to complete reinstallation.
    xen-guest-agent05
  7. Check the installed version at the top left. When the installation is complete, reboot the server.

Check Xentools status

Check the status of the Xentools service.

  1. Select (E) EXECUTE - << Run System Apps >>.
    xen-guest-agent07
  2. Select (X) XENTOOLS - XENTOOLS INSTALL >>.
    xen-guest-agent08
  3. Select (S) XEN GUEST AGENT (Xentools) STATUS >>.
    xen-guest-agent09
  4. Check if the Xentools service status is active (running).
    xen-guest-agent10

Restart Xentools

Restart the Xentools process.

  1. Select (E) EXECUTE - << Run System Apps >>.
    xen-guest-agent11
  2. Select (X) XENTOOLS - XENTOOLS INSTALL >>.
    xen-guest-agent12
  3. Select (T) RE-START XEN GUEST AGENT (Xentools) >>.
    xen-guest-agent13
  4. Check if the Xentools service status is active (running).
    xen-guest-agent14

Reinstall Xentools

Delete existing Xentools and proceed with reinstallation.

  1. Select (E) EXECUTE - << Run System Apps >>.
    xen-guest-agent15
  2. Select (X) XENTOOLS - XENTOOLS INSTALL >>.
    xen-guest-agent16
  3. Select (R) RE-INSTALL XEN GUEST AGENT (Xentools) >>.
    xen-guest-agent17
  4. If the installation proceeds successfully, the reinstallation log will display as follows:
    • Stop a running Xentools Agent.
    • Remove the existing Xentools Agent.
    • Reinstall Xentools Agent
      xen-guest-agent18
  5. Check the installed version and click OK to complete reinstallation.
    xen-guest-agent19
  6. Reboot the server when installation is complete.

Reinstall Xentools using NTK CLI (ntk-cli.sh)

Note

This feature is available on Rocky Linux 8 and Ubuntu 20.04.
As of June 20, 2025, the latest NTK version is v0.8.0, on which this section is based.

To run ntk-cli.sh, a NTK CLI command, on a Linux server, follow these steps:

  1. Go to the path where the NTK file is located.
    [root@xen-rockylinux810 ~]# cd /usr/local/etc
  2. Unzip the NTK file.
    [root@xen-rockylinux810 etc]# tar zxvf ntk.tar.gz
  3. Run ntk-cli.sh.
    [root@xen-rockylinux810 etc]# cd ntk

[root@xen-rockylinux810 ntk]# ls
apps  core  logs  ntk  ntk-cli.sh  ntk_main  tree-dir.sh

[root@xen-rockylinux810 ntk]# ./ntk-cli.sh
Option is not correct
Version: NTK v0.8.0
Usage: ntk-cli.sh Option
Option:
    --help              show this page
    --check-ncp-vm      check NCP VM configuration in a XEN environment

Xentools:
    --xentools          check and install Xentools agent
                        CentOS 7      : 7.4.0-1
                        Rocky Linux 8 : 7.20.2-1
                        Ubuntu 18.04  : 7.4.0-1
                        Ubuntu 20.04  : 7.20.2-1
    --xentools-latest   install latest Xentools agent (please refer to the belew version)
                        CentOS 7      : 7.4.0-1  => 7.20.2-1
                        Rocky Linux 8 : 7.20.2-1 => 8.2.1-1
                        Ubuntu 18.04  : 7.4.0-1  => 7.20.2-1
                        Ubuntu 20.04  : 7.20.2-1 => 8.2.1-1

Xen2KVM Migration:
    --x2k_validate      validation check VM to migrate from XEN to KVM
  4. When you install a designated version depending on your OS version, you can designate (–-xentools option) and a higher version (--xentools-latest option) to install.
    [root@xen-rockylinux810 ntk]# ./ntk-cli.sh --xentools

Executing ... /usr/local/etc/ntk/apps/ntk-cli/xentools-agent.sh


Package-Searching...


Download Package...

--2025-06-27 15:49:08--  http://init.ncloud.com/server/linux/xentools/CitrixVMTools-Linux-7.20.2-1.tar.gz
Resolving init.ncloud.com (init.ncloud.com)... 169.254.1.5, 169.254.80.160
Connecting to init.ncloud.com (init.ncloud.com)|169.254.1.5|:80... connected.
HTTP request sent, awaiting response... 200 OK
Length: 8252206 (7.9M) [application/x-gzip]
Saving to: '/usr/local/etc/ntk/apps/system_agent/CitrixVMTools-Linux-7.20.2-1.tar.gz'
2025-06-27 15:49:08 (171 MB/s) - '/usr/local/etc/ntk/apps/system_agent/CitrixVMTools-Linux-7.20.2-1.tar.gz' saved [8252206/8252206]


Remove Old Package...


Install New Package...

LinuxGuestTools-7.20.2-1/
LinuxGuestTools-7.20.2-1/versions.rpm
LinuxGuestTools-7.20.2-1/xe-guest-utilities-xenstore-7.20.2-1.i386.rpm
LinuxGuestTools-7.20.2-1/xe-linux-distribution
LinuxGuestTools-7.20.2-1/versions.tgz
LinuxGuestTools-7.20.2-1/install.sh
LinuxGuestTools-7.20.2-1/versions.deb
LinuxGuestTools-7.20.2-1/xe-guest-utilities_7.20.2-1_i386.deb
LinuxGuestTools-7.20.2-1/xen-vcpu-hotplug.rules
LinuxGuestTools-7.20.2-1/xe-guest-utilities-xenstore-7.20.2-1.x86_64.rpm
LinuxGuestTools-7.20.2-1/SRPM/
LinuxGuestTools-7.20.2-1/SRPM/xe-guest-utilities-7.20.2-1.src.rpm
LinuxGuestTools-7.20.2-1/xe-linux-distribution.service
LinuxGuestTools-7.20.2-1/xe-daemon
LinuxGuestTools-7.20.2-1/xe-guest-utilities_7.20.2-1_amd64.deb
LinuxGuestTools-7.20.2-1/LICENSE
LinuxGuestTools-7.20.2-1/xe-guest-utilities-7.20.2-1.x86_64.rpm
LinuxGuestTools-7.20.2-1/README.txt
LinuxGuestTools-7.20.2-1/xe-guest-utilities_7.20.2-1_all.tgz
LinuxGuestTools-7.20.2-1/xe-guest-utilities-7.20.2-1.i386.rpm
LinuxGuestTools-7.20.2-1/DEB_SRC_PACKAGES/
LinuxGuestTools-7.20.2-1/DEB_SRC_PACKAGES/xe-guest-utilities_7.20.2-1.dsc
LinuxGuestTools-7.20.2-1/DEB_SRC_PACKAGES/xe-guest-utilities_7.20.2-1.tar.gz
Detected `Rocky Linux release 8.10 (Green Obsidian)' (rocky version 8).

The following changes will be made to this Virtual Machine:
  * packages to be installed/upgraded:
    - xe-guest-utilities-7.20.2-1.x86_64.rpm
    - xe-guest-utilities-xenstore-7.20.2-1.x86_64.rpm



Verifying...                          ########################################
Preparing...                          ########################################
Updating / installing...
xe-guest-utilities-xenstore-7.20.2-1  ########################################
xe-guest-utilities-7.20.2-1           ########################################

You should now reboot this Virtual Machine.

# systemctl status xe-linux-distribution.service
* xe-linux-distribution.service - LSB: Virtual Machine daemon providing host integration services
   Loaded: loaded (/etc/rc.d/init.d/xe-linux-distribution; generated)
   Active: active (running) since Fri 2025-06-27 15:49:11 KST; 50ms ago
     Docs: man:systemd-sysv-generator(8)
  Process: 125068 ExecStart=/etc/rc.d/init.d/xe-linux-distribution start (code=exited, status=0/SUCCESS)
    Tasks: 9 (limit: 23076)
   Memory: 1.6M
   CGroup: /system.slice/xe-linux-distribution.service
           |-125084 /usr/sbin/xe-daemon -p /var/run/xe-daemon.pid
           `-125088 logger -t xe-daemon -p debug

Jun 27 15:49:11 xen-rockylinux810 systemd[1]: Starting LSB: Virtual Machine daemon providing host integration services...
Jun 27 15:49:11 xen-rockylinux810 xe-linux-distribution[125068]: Detecting Linux distribution version: [  OK  ]
Jun 27 15:49:11 xen-rockylinux810 xe-linux-distribution[125068]: Starting xe daemon:  [  OK  ]
Jun 27 15:49:11 xen-rockylinux810 systemd[1]: Started LSB: Virtual Machine daemon providing host integration services.

# ps -ef|grep xe-daemon
root      125084       1  0 15:49 ?        00:00:00 /usr/sbin/xe-daemon -p /var/run/xe-daemon.pid

Press Any Key to exit
  5. Press the Enter key to finalize.

Xentools Guest Agent FAQs

Q. On the MC console, I received the notification: "Guest Agent is not installed." What should I do?

The notification occurs when Xentools is not installed or when the process is not running even if Xentools is installed. You can check directly based in the following order:

  1. Check if Xentools is running properly.
    For more information on the status check, see Check Xentools status. If you are accessing a server, check if the status is active (running) using the following commands:

    [root@xen-rockylinux810 ~]# systemctl status xe-linux-distribution.service
● xe-linux-distribution.service - LSB: Virtual Machine daemon providing host integration services
   Loaded: loaded (/etc/rc.d/init.d/xe-linux-distribution; generated)
   Active: active (running) since Wed 2025-06-25 11:15:26 KST; 26s ago
     Docs: man:systemd-sysv-generator(8)
  Process: 35015 ExecStop=/etc/rc.d/init.d/xe-linux-distribution stop (code=exited, status=0/SUCCESS)
  Process: 35243 ExecStart=/etc/rc.d/init.d/xe-linux-distribution start (code=exited, status=0/SUCCESS)
    Tasks: 10 (limit: 23076)
   Memory: 3.8M
   CGroup: /system.slice/xe-linux-distribution.service
           ├─35259 /usr/sbin/xe-daemon -p /var/run/xe-daemon.pid
           └─35263 logger -t xe-daemon -p debug

Jun 25 11:15:26 xen-rockylinux810 systemd[1]: Starting LSB: Virtual Machine daemon providing host integration services...
Jun 25 11:15:26 xen-rockylinux810 xe-linux-distribution[35243]: Detecting Linux distribution version: [  OK  ]
Jun 25 11:15:26 xen-rockylinux810 xe-linux-distribution[35243]: Starting xe daemon:  [  OK  ]
Jun 25 11:15:26 xen-rockylinux810 systemd[1]: Started LSB: Virtual Machine daemon providing host integration services.

  2. If Xentools is running properly, check the last time it communicated with the XEN hypervisor.

    Note

    XEN hypervisor updates the status at 1-minute intervals.
    You can view only on Rocky Linux 8 and Ubuntu 20.04.

    xen-guest-agent20

  3. If the last communication time is outdated, restart Xentools to check if the time is updated.
    For more information on how to restart Xentools, see Restart Xentools. If you are accessing a server, you can restart and check the status using the following commands:

    [root@xen-rockylinux810 ~]# systemctl restart xe-linux-distribution.service
[root@xen-rockylinux810 ~]# systemctl status xe-linux-distribution.service
● xe-linux-distribution.service - LSB: Virtual Machine daemon providing host integration services
   Loaded: loaded (/etc/rc.d/init.d/xe-linux-distribution; generated)
   Active: active (running) since Wed 2025-06-25 11:17:54 KST; 9s ago
     Docs: man:systemd-sysv-generator(8)
  Process: 35689 ExecStop=/etc/rc.d/init.d/xe-linux-distribution stop (code=exited, status=0/SUCCESS)
  Process: 35698 ExecStart=/etc/rc.d/init.d/xe-linux-distribution start (code=exited, status=0/SUCCESS)
    Tasks: 9 (limit: 23076)
   Memory: 2.2M
   CGroup: /system.slice/xe-linux-distribution.service
           ├─35714 /usr/sbin/xe-daemon -p /var/run/xe-daemon.pid
           └─35718 logger -t xe-daemon -p debug

Jun 25 11:17:54 xen-rockylinux810 systemd[1]: Starting LSB: Virtual Machine daemon providing host integration services...
Jun 25 11:17:54 xen-rockylinux810 xe-linux-distribution[35698]: Detecting Linux distribution version: [  OK  ]
Jun 25 11:17:54 xen-rockylinux810 xe-linux-distribution[35698]: Starting xe daemon:  [  OK  ]
Jun 25 11:17:54 xen-rockylinux810 systemd[1]: Started LSB: Virtual Machine daemon providing host integration services.