Skip to main content
ONTAP tools for VMware vSphere 9.12
A newer release of this product is available.

How to deploy ONTAP tools


You should deploy ONTAP tools in your environment, and specify the required parameters, to be able to use the appliance.

What you will need

  • You must be running a supported release of vCenter Server.

    Note ONTAP tools can be registered either with a Windows deployment of vCenter Server or a VMware vCenter Server Virtual Appliance (vCSA) deployment.
  • You must have configured and set up your vCenter Server environment.

  • You must have set up an ESXi host for your virtual machine.

  • You must have downloaded the .ova file.

  • You must have the administrator login credentials for your vCenter Server instance.

  • You should have logged out of and closed all of the browser sessions of vSphere Client, and deleted the browser cache to avoid any browser cache issue during the deployment of ONTAP tools.

  • You must have enabled Internet Control Message Protocol (ICMP).

    If ICMP is disabled, then the initial configuration of ONTAP tools fails, and VSC cannot start the VSC and VASA Provider services after deployment. You must manually enable the VSC and VASA Provider services after deployment.

About this task

If you are deploying a fresh installation of ONTAP tools, then VASA Provider is enabled by default. But in case of an upgrade from an earlier release of the ONTAP tools, the state of VASA Provider is retained and you might need to enable VASA Provider manually.


  1. Log in to the vSphere Client.

  2. Select Home > Host and Clusters.

  3. Right-click the required datacenter, and then click Deploy OVF template…​.

  4. Select the applicable method to provide the deployment file for ONTAP tools, and then click Next.




    Provide the URL for the .ova file for ONTAP tools.


    Extract the .zip file, which contains the .ova file onto your local system. On the Select an OVF template page, specify the location of the .ova file inside the extracted folder.

  5. Enter the details to customize the deployment wizard.

    (Optional) In the Configure vCenter or Enable VCF section, select the Enable VMware Cloud Foundation (VCF) checkbox and provide a password for ONTAP tools credentials. You do not need to provide IP address but providing a password is mandatory. See the following for complete details.

  6. Review the configuration data, and then click Next to finish deployment.

    As you wait for deployment to finish, you can view the progress of the deployment from the Tasks tab.

  7. Power on the ONTAP tools virtual machine, and then open a console of the virtual machine running the ONTAP tools.

  8. Verify that ONTAP tools is running after the deployment is completed.

  9. If ONTAP tools is not registered with any vCenter Server, use https://appliance_ip:8143/Register.html to register the VSC instance. The Register.html redirects you to the swagger page. From ONTAP tools 9.12 onwards the registration of ONTAP tools with vCenter happens from the swagger page.

    Use the POST API to register ONTAP tools with vCenter from 9.12 onwards.

  10. Log out and re-log in to the vSphere Client to view the deployed ONTAP tools.

    It might take a few minutes for the plug-in to be updated in the vSphere Client.

    Troubleshooting: If you cannot view the plug-in even after logging in, you must clean the vSphere Client cache.

Related information