iControl F5 Integration

iControl is an open API that enables applications to work in sync with the network based on the software integration. iControl uses SOAP/XML to ensure an open communication between dissimilar systems. It helps F5 customers, independent software vendors (ISVs), and solution providers leverage efficiency in automation and management of network objects and devices.

Users who want to use third party integrations to control their devices can integrate the required .jar file. The process begins with the user downloading the .jar file from the respective vendor. After downloading, the contents of the .jar file must be extracted into the external_libs directory. Finally, the plugin must be restarted for the changes to take effect.

  1. To integrate the iControl library into the required project, copy the library and paste it into the <user_home_dir>/installer/external_libs/ directory (create a directory if it does not exist).
  2. Visit devcentral f5 download page URL: iControl Library For Java With Source.
  3. Download the latest iControl integration library file from the list of libraries.
  4. Extract the downloaded zip file to: iControlAssembly_13_1_0-Java.
  5. Download the axis.jar from the axis library.
  6. Download the javax.xml.soap-api-1.4.0.jar from the file library.
  7. Copy the iControl.jar, axis.jar, and javax.xml.soap-api-1.4.0.jar files from the extracted package to the external_libs directory.
  8. If AppViewX is already installed or upgraded from an earlier version of AppViewX, move the iControl-13.1.0.jar, axis.jar, and javax.xml.soap-api-1.4.0.jar file to external_libs directory using command below 
    cp -r /lib/iControl-13.1.0.jar <user_home_dir>/appviewx_dependencies/external_libs/ directory
    cp -r axis-1.4.jar <user_home_dir>/appviewx_dependencies/external_libs/ directory
    cp -r javax.xml.soap-api-1.4.0.jar <user_home_dir>/appviewx_dependencies/external_libs/ directory
  9. If AppViewX is not installed, move the iControl-13.1.0.jar, axis.jar, and javax.xml.soap-api-1.4.0.jar file to external_libs directory using command 
    cp -r /lib/iControl-13.1.0.jar /home/appviewx/Installer/external_libs
    cp -r axis-1.4.jar /home/appviewx/Installer/external_libs
    cp -r  javax.xml.soap-api-1.4.0.jar /home/appviewx/Installer/external_libs
  10. In case of a multi node environment, copy the iControl-13.1.0.jar, axis.jar, and javax.xml.soap-api-1.4.0.jar file to all the servers where the avx_vendors plugin is running.
    Note: To restart the avx_vendors plugin followed by the gateway plugin, refer to the Restarting a plugin section.