Introduction

This article explains how to add new APIs to an existing vCommander® release.


Adding new APIs

To add new APIs to an existing vCommander release:


  1. Locate the vCommander installation directory. By default, for a Windows installation, the default full path is:

    C:\Program Files\Embotics\vCommander 
  2. Go to the webapps directory in the vCommander installation directory:

    <install_path >\tomcat\webapps 
  3. Back up the webservices.war file in this folder. 
  4. Stop the vCommander service. 
  5. Replace the webservices.war file with the new webservices.war file provided by Embotics as part of the drop-in package. 
  6. Delete the content of the following directory:

    <install_path>\tomcat\work 
  7. Start the vCommander service. 


You will now have access to the new API(s).


Updated REST clients

To access the new API, you need to use the updated PowerShell client provided by Embotics as part of  the drop-in package. See the vCommander REST API Getting Started Guide for installation instructions. 


Restoring the previous version in case of a problem 

To restore vCommander to the state prior to adding new APIs:


  1. Locate the vCommander installation directory. By default, for a Windows installation, the full path is:

    C:\Program Files\Embotics\vCommander 
  2. Stop the vCommander service. 
  3. Go to the webapps directory in the vCommander installation directory:

    <install_path >\tomcat\webapps 
  4. Replace the webservices.war file with the backup copy. 
  5. Delete the content of the following directory:

    <install_path>\tomcat\work
  6. Start the vCommander service.