Skip to main content
Upgrade Health Checker

Automate generating upgrade plans with Upgrade Health Checker

Contributors netapp-ivanad netapp-barbe
PDFs

You can automate generating Upgrade Health Checker reports to reduce your manual effort when planning ONTAP upgrades in large, complex environments.

About this task

Upgrade Health Checker supports upgrades for on-premises ONTAP versions 9.11.1 and later. If you are using Cloud Volumes ONTAP, refer to Upgrade Cloud Volumes ONTAP for information on upgrading your system.

Steps

  1. To ensure the successful creation of your upgrade reports, complete any necessary set up steps and one-time tasks outlined in Generate an ONTAP upgrade report.

  2. Create a script to run Upgrade Health Checker with the appropriate parameters for your environment.

    ./uhc \
  --cluster-ip=<cluster-ip> \
  --cluster-username=<cluster-username> \
  --cluster-password=<cluster-password> \
  --target-ontap-version=<target-ontap-version> \
  --accept-eula=true

    Here is an example of a cronjob that runs the tool Monday through Friday at 4AM. The binary and config.yaml files have been installed into /opt/uhc/tool/.

    Bash script:

    #!/bin/bash
cd /opt/uhc/tool
/opt/uhc/tool/uhc --accept-eula true --cluster-ip cluster-mgmt1.example.com --target-ontap-version current --cluster-username uhctool --cluster-password passw0rd
/opt/uhc/tool/uhc --accept-eula true --cluster-ip cluster-mgmt2.example.com --target-ontap-version 9.14.1 --cluster-username uhctool --cluster-password passw0rd

    Cron job:

    0 4 * * 1-5 /usr/local/bin/uhccron.sh

  3. 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.

  4. Open the report file (named uhc_<cluster-name>_<YYYYMMDDHHMMSS>) in a web browser, Microsoft Excel, or JSON viewer to view the report. If you are running Upgrade Health Checker on a remote host, first download the report file to a machine where you can view the report on a web browser, in Excel, or in a JSON viewer.

    The log path and report path are as follows:

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

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

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

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