Warning

There are known security vulnerabilities in Open XDMoD versions ≤11.0.2. We strongly encourage upgrading immediately to the latest version of Open XDMoD, 11.0.3, which contains fixes for these vulnerabilities.

To upgrade version 8.1 to 11.0.3, you will first need to upgrade to version 8.5.0, then upgrade to version 9.0.0, then upgrade to version 9.5.0, then upgrade to version 10.0.3, then upgrade to version 10.5.1, then upgrade to version 11.0.3.

If you cannot upgrade immediately, you can follow the instructions below to manually patch your installation as a temporary workaround before upgrading later.

Workaround instructions
  1. First, make sure you are on the correct web page for your version of Open XDMoD. The web page you are on now is for version 8.1. Other versions' pages are linked below:
  2. Download the patch file for your version:
  3. Copy the patch file to your Open XDMoD web server.
  4. Make sure you have the patch command installed; it can be installed with dnf install patch.
  5. Apply the patch by running the command below, replacing [PATH_TO_XDMOD_SHARE_DIR] with the path to the share directory (/usr/share/xdmod for RPM-based installs, /opt/xdmod/share or another location for source code installs) and replacing [PATH_TO_PATCH_FILE] with the path to the patch file. 
    # patch -p1 -d [PATH_TO_XDMOD_SHARE_DIR] < [PATH_TO_PATCH_FILE]
  6. Upgrade to the latest version of Open XDMoD as soon as you can.

Using → Command Reference

Open XDMoD includes several command line utilities that are available to users.

xdmod-setup

The xdmod-setup command is used to configure the Open XDMoD portal and initialize the databases used by Open XDMoD. See the Configuration Guide for more details.

xdmod-upgrade

The xdmod-upgrade command is used to upgrade the Open XDMoD databases and configuration files to be compatible with the currently installed version of Open XDMoD. See the Upgrade Guide for more details.

xdmod-admin

The xdmod-admin command is used to perform various administrative tasks. Currently supported tasks include listing all the resources configured in Open XDMoD and truncating all job data from the Open XDMoD databases.

xdmod-shredder

The xdmod-shredder command is used to load data from log files into the Open XDMoD databases. This command writes data to the mod_shredder database. See the Shredder Guide for more details.

xdmod-slurm-helper

The xdmod-slurm-helper command is used to load data from Slurm’s sacct command into the Open XDMoD databases. See the Slurm Notes for more details.

xdmod-ingestor

The xdmod-ingestor command is used to prepare data that has already been loaded into the Open XDMoD database for querying by the Open XDMoD portal. This command reads from the mod_shredder database and writes to mod_hpcdb, modw, modw_aggregates, and modw_filters databases. See the Ingestor Guide for more details.

xdmod-import-csv

The xdmod-import-csv command is used to load data from CSV files into the Open XDMoD database. This command writes data to the mod_hpcdb database. See the User Name Guide and Hierarchy Guide for more details.

xdmod-update-resource-specs

The xdmod-update-resource-specs command is used to update your resource_specs.json file.

xdmod-check-config

The xdmod-check-config command is used to check your Open XDMoD environment for any problems. See the Troubleshooting Guide for more details.

xdmod-build-filter-lists

The xdmod-build-filter-lists command is used to build filter lists for the different realms. Ability to auto detect and build all or specify a specific realm or realms to process.

acl-config

The acl-config command ensures that all acl related tables are present, required configuration files are valid, and the acl related database tables are populated correctly.