Skip to main content
ONTAP Mediator

Upgrade ONTAP Mediator

Contributors netapp-aoife netapp-camdenc

To upgrade ONTAP Mediator to a newer version without upgrading the host OS, download the installation package for the new version and run the installer on the host where ONTAP Mediator is already installed.

Note If you need to upgrade the host OS to a new release and reinstall or upgrade ONTAP Mediator as part of that process, see Upgrade the host OS and ONTAP Mediator instead.
Before you begin
About this task

Review the following information before upgrading ONTAP Mediator.

  • You should upgrade ONTAP Mediator to the latest version. Older versions still work with all ONTAP releases, but newer versions include security patches for third-party components.

  • When you upgrade to a new ONTAP Mediator version that includes the SCST package, the installer automatically upgrades to the recommended SCST version unless a higher version is available. For instructions on manually installing a higher SCST version, see Maintain the host OS for ONTAP Mediator. For supported versions, see the SCST support matrix.

Note
  • If the upgrade fails, you might need to try a newer version of ONTAP Mediator.

  • From June 15, 2025, you can't install or upgrade ONTAP Mediator 1.9 and 1.8 because their code signing certificates have expired. If the upgrade fails, use the ONTAP Mediator 1.9.1 patch version instead.

  • Beginning with ONTAP 9.19.1 and ONTAP Mediator 1.12, you have the option to install ONTAP Mediator with iSCSI and HTTPS support, or support for HTTPS only. If you choose to install ONTAP Mediator with support for HTTPS only, the SCST package is not installed.

  • If you upgrade from ONTAP Mediator 1.11 or earlier with SCST installed, and you choose the HTTPS only option during the upgrade, the SCST package is uninstalled and the new ONTAP Mediator version does not contain the SCST package.

  • If you plan to use ONTAP Mediator to monitor multiple MetroCluster IP configurations, the support depends on your Mediator type, ONTAP version, and OS. Refer to Use ONTAP Mediator to monitor multiple MetroCluster IP configurations for more information.

  • Installing ONTAP Mediator with support for HTTPS only is supported for the following use cases:

    • You plan to only use ONTAP Mediator to monitor your SnapMirror active sync clusters.

    • You plan to configure ONTAP Mediator with HTTPS to monitor one or more MetroCluster IP configurations.

  • ONTAP Mediator must be installed with support for iSCSI and HTTPS in the following scenario:

    • You plan to configure ONTAP Mediator with iSCSI to monitor one or more MetroCluster IP configurations.

  • When you run the installer against an existing ONTAP Mediator installation, it detects the current version and prompts you to confirm the upgrade:

    ONTAP Mediator will be upgraded from version <current-version> to <new-version>.

    Do you wish to continue? Y(es)/n(o):

  • As part of the upgrade, the installer captures a support bundle of your pre-upgrade configuration and migrates the database before upgrading the ONTAP Mediator software.

  • For automation use cases, you can use the ./ontap-mediator-1.13.0/ontap-mediator-1.13.0 -y command to skip the installer prompts.

Steps
  1. Before the upgrade, complete the following substep if you are upgrading to ONTAP Mediator 1.13 or later on an ONTAP Mediator instance that pairs with one of the following releases:

    • ONTAP 9.11.1 and earlier

    • ONTAP patch releases earlier than 9.12.1P15, 9.13.1P12, 9.14.1P8, and 9.15.1P2

      1. Add the following line to the /opt/netapp/lib/ontap_mediator/ontap_mediator/server_config/ontap_mediator.user_config.yaml file.

        'generate_unique_ca_name': false

        This file is preserved across ONTAP Mediator upgrades.

  2. Run the installer for the new version and respond to the prompts as required:

    ./ontap-mediator-1.13.0/ontap-mediator-1.13.0
    Note

    To skip the signature check during the upgrade, use the ./ontap-mediator-1.13.0/ontap-mediator-1.13.0 --skip-code-signature-check command

    The installer detects the existing installation and prompts you to upgrade, then installs the required packages and migrates your configuration.

    Example ONTAP Mediator upgrade with HTTPS and iSCSI support (console output)
    [root@mediator-host ~]# ontap-mediator-1.13.0/ontap-mediator-1.13.0
    
    + Extracting the ONTAP Mediator installation/upgrade archive
    + Performing the ONTAP Mediator run-time code signature check
       Using openssl from the path: /usr/bin/openssl configured for CApath:/etc/pki/tls
    Error querying OCSP responder
    40B70028217F0000:error:1E800080:HTTP routines:OSSL_HTTP_REQ_CTX_nbio:failed reading data:crypto/http/http_client.c:596:
    40B70028217F0000:error:1E800067:HTTP routines:OSSL_HTTP_REQ_CTX_exchange:error receiving:crypto/http/http_client.c:1046:server=http://ocsp.entrust.net:80
       WARNING: The OCSP check failed while attempting to test the Code-Signature-Check certificate
       Continue without code signature checking (only recommended if integrity has been established manually)? y(es)/N(o): yes
     SKIPPING: Code signature check, manual override due to lack of OCSP response
    + Unpacking the ONTAP Mediator installer
    + ONTAP_MEDIATOR_INSTALL_HTTPS_ONLY is set to '0', args are: ''
    + Starting ONTAP Mediator install/update process: previous installation_mode is ''
    
    
    ONTAP Mediator can be installed with iSCSI and HTTPS support, or HTTPS support only.
    Do you wish to install ONTAP Mediator with iSCSI and HTTPS support? Y(es)/n(o): yes
    ONTAP Mediator will be installed with mode: ISCSI_HTTPS
    Selected install package mode: ISCSI_HTTPS
    ONTAP Mediator will be upgraded from version 1.12.1 to 1.13.0.
    Do you wish to continue? Y(es)/n(o): yes
    Capturing support_bundle to save pre-upgrade configuration. API Credentials are required.
        Mediator API User Name: mediatoradmin
                     Password: Running plugins, please wait...
    
    Running 1/11: apis...
    
    Creating tar archive...
    Support bundle has been generated at /opt/netapp/data/support_bundles/sdot-r730-0003a-d4.gdl.englab.netapp.com_1792143997_BASIC.tgz
    Testing the DB can be upgraded
    Cloning database...
    Cloning successful.
    Verifying database is up-to-date...
    Database out-of-date.Migrations are necessary:
    Current revision: 45ca93e60653, Head revision: 086df085a190
    Performing database migrations against clone...
    Migrations successful.
    Database upgrade operation complete.
    + Adding python312 specific packages
    + Upgrading ONTAP Mediator. (Log: /root/ontap_mediator.FO5UgL/ontap-mediator-1.13.0/ontap-mediator-1.13.0/upgrade_20261016054617.log)
    fapolicyd not installed or no rules.d directory found, skipping fapolicyd configuration
        ONTAP Mediator rsyslog and logging rotation enabled
    + Upgrade successful. (Moving log to /opt/netapp/lib/ontap_mediator/log/upgrade_20261016054617.log)\n
    + WARNING: This system supports UEFI
               Secure Boot (SB) is currently enabled on this system.
               The following action need be taken:
               Using the keys in /opt/netapp/lib/ontap_mediator/ontap_mediator/SCST_mod_keys follow
               instructions in /opt/netapp/lib/ontap_mediator/ontap_mediator/SCST_mod_keys/README.module-signing
               to sign the SCST kernel module. Note that reboot will be needed.
         SCST will not start automatically when Secure Boot is enabled and not configured properly.
    
    + Note: ONTAP Mediator generated a self-signed server certificate for temporary use on
        this host. If the DNS name or IP address for the host is changed, the certificate
        will no longer be valid. The default certificates should be replaced with secure
        trusted certificates signed by a known certificate authority prior to use for production.
        For more information, see /opt/netapp/lib/ontap_mediator/README
    
    + Note: ONTAP Mediator uses a kernel module compiled specifically for the current
            OS. Using 'yum update' to upgrade the kernel might cause service interruption.
        For more information, see /opt/netapp/lib/ontap_mediator/README
    [root@mediator-host ~]#
    Example of ONTAP Mediator upgrade with support for HTTPS only (console output)
    [root@mediator-host ~]# ontap-mediator-1.13.0/ontap-mediator-1.13.0 --https-only
    
    ONTAP Mediator: Self Extracting Installer
    
    + Extracting the ONTAP Mediator installation/upgrade archive
    + Performing the ONTAP Mediator run-time code signature check
       Using openssl from the path: /usr/bin/openssl configured for CApath:/etc/pki/tls
    Error querying OCSP responder
    40A73D8E847F0000:error:1E800080:HTTP routines:OSSL_HTTP_REQ_CTX_nbio:failed reading data:crypto/http/http_client.c:614:
    40A73D8E847F0000:error:1E800067:HTTP routines:OSSL_HTTP_REQ_CTX_exchange:error receiving:crypto/http/http_client.c:1075:server=http://ocsp.entrust.net:80
       WARNING: The OCSP check failed while attempting to test the Code-Signature-Check certificate
       Continue without code signature checking (only recommended if integrity has been established manually)? y(es)/N(o): yes
     SKIPPING: Code signature check, manual override due to lack of OCSP response
    + Unpacking the ONTAP Mediator installer
    + ONTAP_MEDIATOR_INSTALL_HTTPS_ONLY is set to '1', args are: ''
    + Starting ONTAP Mediator install/update process: previous installation_mode is 'HTTPS_ONLY'
    + Selected install package mode: HTTPS_ONLY
    ONTAP Mediator will be upgraded from version 1.12.1 to 1.13.0.
    
    
    Do you wish to continue? Y(es)/n(o): yes
    Capturing support_bundle to save pre-upgrade configuration. API Credentials are required.
        Mediator API User Name: mediatoradmin
                     Password: Running plugins, please wait...
    
    
    Creating tar archive...
    Support bundle has been generated at /opt/netapp/data/support_bundles/sdot-r730-0003a-d4.gdl.englab.netapp.com_1792151055_BASIC.tgz
    Testing the DB can be upgraded
    Cloning database...
    Cloning successful.
    Verifying database is up-to-date...
    Database out-of-date.Migrations are necessary:
    Current revision: 45ca93e60653, Head revision: 086df085a190
    Performing database migrations against clone...
    Migrations successful.
    Database upgrade operation complete.
    + Adding python312 specific packages
    + Upgrading ONTAP Mediator. (Log: /root/ontap_mediator.qmrGsH/ontap-mediator-1.13.0/ontap-mediator-1.13.0/upgrade_20261016074342.log)
    fapolicyd not installed or no rules.d directory found, skipping fapolicyd configuration
        ONTAP Mediator rsyslog and logging rotation enabled
    + Upgrade successful. (Moving log to /opt/netapp/lib/ontap_mediator/log/upgrade_20261016074342.log)\n
    + WARNING: This system supports UEFI
    + Note: Not signing the SCST modules since they were not installed by this installation.
    + Note: SCST will not start automatically if Secure Boot is enabled and not configured properly.
    
    + Note: ONTAP Mediator generated a self-signed server certificate for temporary use on
        this host. If the DNS name or IP address for the host is changed, the certificate
        will no longer be valid. The default certificates should be replaced with secure
        trusted certificates signed by a known certificate authority prior to use for production.
        For more information, see /opt/netapp/lib/ontap_mediator/README
    
    + Note: ONTAP Mediator uses a kernel module compiled specifically for the current
            OS. Using 'yum update' to upgrade the kernel might cause service interruption.
        For more information, see /opt/netapp/lib/ontap_mediator/README
    [root@mediator-host ~]#