Skip to main content

Updates

All updates are pushed through the updater, which is the central piece that keeps your XO Appliance running the latest Xen Orchestra code.

It also allows you to change your current version into another (Free, Starter, Enterprise or Premium) without downloading a new XOA.

tip

By design, the updater is only available in XOA. If you are using XO from the sources, update with git and rebuild.

Updating from XO 6

Updates are not managed from the XO 6 interface yet. From XO 6, click the XO 5 link in the top-right corner, then open the XOA → Updates view: everything below happens there. Your appliance and both interfaces update together.

Requirements

In order to work, the updater needs access to xen-orchestra.com (port 443) and nodejs.org (port 443).

Usage

The updater is configurable directly from the web interface, or via the CLI.

From the web interface

The updater is available in the "Update" menu:

zoomed detailThe Updates entry in the XOA menu
The Updates entry in the XOA menu

You can see the yellow bell icon: it means your appliance is not registered. You must register in order to have updates and a trial.

zoomed detailA yellow bell: the appliance is not registered yet
A yellow bell: the appliance is not registered yet

Register

Updates and trials will be available as soon as you register your appliance. To register, use your account.vates.tech credentials (your email and your password):

zoomed detailRegistering with your xen-orchestra.com account
Registering with your xen-orchestra.com account

Check for new versions

The updater will check for new versions periodically. A green tick in the menu means your version is up to date:

zoomed detailGreen tick: the appliance is up to date
Green tick: the appliance is up to date

However, if you want to start a manual check, you can do it by clicking on the "Update" button:

zoomed detailTrigger a manual check with the Update button
Trigger a manual check with the Update button

Release channel

In Xen Orchestra, you can make a choice between two different release channels.

Stable

The stable channel is intended to be a version of Xen Orchestra that is already one month old (and therefore will benefit from one month of community feedback and various fixes). This way, users more concerned with the stability of their appliance will have the option to stay on a slightly older (and tested) version of XO (still supported by our pro support).

Latest

The latest channel will include all the latest improvements available in Xen Orchestra. The version available in latest has already been QA'd by our team, but issues may still occur once deployed in vastly varying environments, such as our user base has.

tip

To select the release channel of your choice, go to the XOA > Updates view:

zoomed detailChoosing the release channel in the XOA Updates view
Choosing the release channel in the XOA Updates view

Upgrade

If a new version is found, you'll have an upgrade button and its tooltip displayed:

zoomed detailAn upgrade is available
An upgrade is available

Proxy configuration

If you are behind a proxy, you can edit your proxy settings in this panel:

zoomed detailUpdater proxy settings
Updater proxy settings

From the CLI

If your interface is not accessible, or you just prefer to use CLIs commands, it's still possible to perform the same steps. You need to access your XOA via SSH (remember the default credentials: xoa/xoa. Change them ASAP).

Register

xoa — register the appliance
# xoa-updater --register
Successfully connected to xoa-updater-service

Please enter your xen-orchestra.com identifiers to register your XOA:
? Email: myemail@example.net
? Password: *****

 Your Xen Orchestra Appliance has been successfully registered

Check for new versions

xoa — check for new versions
# xoa-updater
Successfully connected to xoa-updater-service
Checking new versions...ok 
New versions available:
xo-server 4.8.1

 xoa-updater may be run again to upgrade packages

Upgrade

xoa — upgrade
# xoa-updater --upgrade
Successfully connected to xoa-updater-service
Checking new versions...ok 
New versions available:
xo-server 4.8.1
[...]
Downloading packages...
Installing new packages...

 Your XOA has been successfully updated.

Troubleshooting

If your updater is down, restart it:

xoa — restart the updater
# systemctl restart xoa-updater

If you can't fetch updates, perform a few checks from your XOA:

  • you should be able to successfully ping xen-orchestra.com
  • if not, check your /etc/resolv.conf file and modify it if necessary (give a correct DNS server)
  • use ifconfig to check your network configuration
  • check your firewall(s) and allow XOA to reach xen-orchestra.com (port 443)

XenServer updates

Xen Orchestra can install XenServer hotfixes on your pools directly, from a pool's Patches view. Since September 2023, XenServer requires authentication to download hotfixes, so XO needs your XenServer Client ID credentials to fetch them on your behalf:

  1. Make sure your XenServer hosts have the proper licenses.
  2. Get your Client ID file (xencenter_client_id.json), which contains the username and API key XO will use.
  3. In Xen Orchestra, open your User Settings page (bottom left-hand corner) and upload the file in the "XenServer Client ID" section:
zoomed detailUploading xencenter_client_id.json in your XO user settings
Uploading xencenter_client_id.json in your XO user settings
  1. Go to a pool's Patches view and install the updates. A LICENCE_RESTRICTION error means your hosts are missing XenServer licenses.
warning

Citrix removed the self-service Client ID download page from its support portal. If you already have your xencenter_client_id.json, XO keeps using it; to obtain new credentials, go through Citrix support. Note that this hotfix mechanism concerns Citrix Hypervisor 8.2 CU1 and older (now end of life): XenServer 8 and 9 hosts fetch their updates themselves from the ops.xenserver.com channels, with XO showing the missing patches per pool and host.

tip

This authentication story only concerns XenServer. XCP-ng updates are plain RPM repositories, fully handled from Xen Orchestra: see the XCP-ng updates documentation.