Auto / Manual Patching tool for Citrix XenServer Boxes
Switch branches/tags
Nothing to show
Clone or download
fetzerms and dalgibbard Add support for XS7.3 and XS7.4 (#77)
* Added XS73

* Revert back to original paths

* Add support for XS7.4
Latest commit 4aacd42 Mar 1, 2018

README.md

citrix_xenserver_patcher

Auto Patching tool for Citrix XenServer Boxes

Supports XenServer 6.0+ - designed primarily for 6.2+ where easy patch management via the GUI was removed for non-supported customers. This should allow individuals and the likes to patch their systems with ease.

Currently, this script is used directly on the Hypervisor itself (as root), and is tested working with both standalone nodes, and pools (must be run on the pool master!).

If there is a particular feature (or bug!) you want sorted, please feel free to raise an Issue here, and i'll look into it (or feel free to fork and commit fixes back!): https://github.com/dalgibbard/citrix_xenserver_patcher/issues

DISCLAIMER

Both myself and this code are in no way affiliated with Citrix. This code is not supported by Citrix in any way. Use of the code within this project is without warranty, and neither myself, the company I work for, nor other contributors of this project are to blame for any issues which may arise, and therefore cannot be held accountable. Any use of this code is done so at your own risk.

Anyway; enough of the nasty stuff.

How To Use

  • SSH to your XenServer Host (Use PuTTY if using a Windows PC).
  • Ensure you're logged on as the "root" user.
  • Get the XenServer Patcher Script
  • Set the permissions as executable
  • OPTIONAL: Create your own exclusions file. (Exclusions will be loaded from Github, but feel free to produce your own list too.)
  • Run it!
wget --no-check-certificate -O patcher.py https://raw.github.com/dalgibbard/citrix_xenserver_patcher/master/patcher.py
chmod a+x patcher.py

# Standalone node:
./patcher.py

# Pool Master node:
./patcher.py -p
  • Run the patcher, and follow the prompts :)

Citrix Account Login

As of patch XS65ESP1046, Citrix appears to be requiring an account login. This version will support authenticating against the Citrix site and then downloading patches. Login credentials can be set on the command line or placed permanently within the patcher.py file. The user variables are cuser and cpass.

A Note On Exclusions

Exclusions are necessary, particularly when Citrix release a Service Pack update which combines previously released patches (be sure to check the "to-be-installed" list for any "SP" patches, and report them if they're new!)

Exclusions are defined in two different ways, which can be utilised together, or individually.

Auto Exclusions

Automatic Exclusions are automatically loaded in via the internet (calls back to this project, to the files located within the 'exclusions' directory of this project). Please raise an issue, or raise a pull request with appropriate changes if you find anything to be wrong/missing. Auto-Exclusions can be DISABLED by using the -E flag, like so:

## NOTE: ** NOT RECOMMENDED! **
./patcher.py -E

Local / Manual Exclusions

If you want to define your own list of patches to exclude (example: the patcher is showing you a new patch file which you're not ready for yet), you can do so by providing the -e argument, and an appropriately formatted file. For an example of how this file should be formatted; see: exclusions/local_exclusions_example.py

Example on using this flag:

## Use a manual exclusions file, in _addition_ to the Auto-Exclusions file on Github:
./patcher.py -e /path/to/exclusions_file.py

## Use ONLY the manual exclusions file:
./patcher.py -E -e /path/to/exclusions_file.py

Usage:

  • The code supports a few other arguments too:
Usage: ./patcher.py [-p] [-e /path/to/exclude_file] [-E] [-a] [-r] [-l] [-U <username>] [-P <password>] [-D] [-C] [-v] [-q] [-h]

-p                          => POOL MODE: Apply Patches to the whole Pool. It must be done on the Pool Master.
-e /path/to/exclude_file    => Allows user to define a Python List of Patches NOT to install.
-E                          => *Disable* the loading of auto-exclusions list from Github
-a                          => Enables auto-apply of patches - will NOT reboot host without below option.
-r                          => Enables automatic reboot of Host on completion of patching without prompts.
-l                          => Just list available patches, and Exit. Cannot be used with '-a' or '-r'.
-U <username>               => Citrix account username
-P <password>               => Citrix account password
-D                          => Enable DEBUG output
-q                          => Quiet (less verbose) mode
-C                          => *Disable* the automatic cleaning of patches on success.
-v                          => Display Version and Exit.

citrix_xenserver_patch_checker

A tool to check for patches that can be run as a non root user with root credentials plus additions to format output for consumption by Nagios.

How To Use

  • SSH to your XenServer Host (Use PuTTY if using a Windows PC).
  • Ensure you have root user credentials
  • Get the XenServer Patch Checker Script
  • Set the permissions as executable
  • OPTIONAL: Create your own exclusions file. (Exclusions will be loaded from Github, but feel free to produce your own list too.)
  • Run it!
wget --no-check-certificate -O patch_checker.py https://raw.github.com/bkci/citrix_xenserver_patcher/master/patch_checker.py
chmod a+x patch_checker.py

# List patches:
./patch_checker.py -u root -p pass

# Pool Master node:
./patch_checker.py -u root -p pass -n

Usage:

Usage: ./patch_checker.py [-e /path/to/exclude_file] [-E] [-u <username>] [-p <password>] [-n] [-D] [-v] [-h]

-e /path/to/exclude_file    => Allows user to define a Python List of Patches NOT to install.
-E                          => *Disable* the loading of auto-exclusions list from Github
-n                          => Check for available patches and return Nagios OK or WARN for system monitoring
-u <username>               => xe username - for nagios monitoring
-p <password>               => xe password - for nagios monitoring
-D                          => Enable DEBUG output
-v                          => Display Version and Exit.
-h                          => Display this message and Exit.

Tags: XenServer Citrix Patch Patching Patcher Auto-Patcher Autopatcher Xen Server Python