Skip to main content
Upgrade Health Checker

Generate upgrade plan with Upgrade Health Checker

Contributors netapp-ivanad
PDFs

You can use Upgrade Health Checker to generate an upgrade plan for a single or multiple ONTAP clusters.

You can also automate generating upgrade reports to assist with maintaining up-to-date upgrade plans if you have a large, complex environment with multiple clusters.

Before you begin

To learn more about a specific Upgrade Health Checker parameter and the priority order for how the tool accepts input, refer to Learn about the input parameters for Upgrade Health Checker.

Steps

  1. Set the execute permission on the binary before running it the first time:

    chmod +x uhc
    Note Upgrade Health Checker is a self-contained package and will need to unpack itself before executing. This can take a few seconds.

  2. Before completing a full run of Upgrade Health Checker, perform a comprehensive check to ensure the tool can connect to the cluster and required endpoints:

    --test all

    The comprehensive check ensures the virtual machine hosting Upgrade Health Checker has:

  3. (Optional) If you want to use a configuration file to store parameters, rename the config.yaml.example file located in the same location you downloaded the binary to config.yaml.

    Here is an example config.yaml file:

    # Application Configuration
APP:
  RUNS_PATH: "/opt/uhc/runs"

# Cluster Credentials
CLUSTER:
  IP: "x.x.x.x"
  USERNAME: "admin"
  PASSWORD: "xyz"
  TARGET_ONTAP_VERSION: ""  # Optional: Specify target ONTAP version (e.g., "9.16.1" or "current" to keep existing version). Leave empty to prompt user.
  ACCEPT_EULA: false  # Optional: Set to true to accept EULA through config. If false/empty, user will be prompted interactively.

  4. Run Upgrade Health Checker by entering the ONTAP version you want to upgrade to and accepting the EULA, including additional parameters as needed.

    Note The EULA is a multi-page document. Enter all to see the entire document at once and enter y to accept it.

    After the AutoSupport log is downloaded for a cluster, processing generally takes one to two minutes depending on the number of cluster nodes. Because different ONTAP software versions handle AutoSupport collection differently, each Upgrade Health Checker run depends on the current load of the cluster and the current ONTAP version.

    1. Familiarize yourself with the available Upgrade Health Checker parameters, input priority order, and default values for certain parameters by referring to Learn about the input parameters for Upgrade Health Checker.

      The Input Parameters Guide also provides information for specifying a custom configuration file path and run path to streamline your workflow. The best practice is to create a custom output directory for each cluster to organize your reports and logs effectively.

    2. Run Upgrade Health Checker by accepting the EULA and entering the target ONTAP version and any additional parameters.

      ./uhc

  5. After Upgrade Health Checker completes its checks, navigate to the runs folder to view the upgrade plan and cluster report.

    Note Each execution of the program is a "unique run" and will have all the associated data, logs and results in the associated runs folder.

  6. Open the report file (named uhc_<cluster-name>_<YYYYMMDDHHMMSS>.html) in a web browser to view the report. If you are running it on a remote host, first download the report file to a machine where you can view the report on a web browser.

    The log path and report path are as follows:

    • Log Path: <output-path>/<unique-run-dir>/<cluster-name>/logs

    • Report Path: <output-path>/<unique-run-dir>/<cluster-name>/results/uhc_<cluster-name>_<YYYYMMDDHHMMSS>.html