Appendix I: Using The Port Forwarder Api; General; Creating A Port Forwarder - Avaya VPN Gateway User Manual

Appendix I: Using the Port Forwarder API

General

This appendix describes some of the tasks needed when using the Port Forwarder API. The
JavaDoc will give you a more detailed view of the API.
The Port Forwarder API is used to provide tunnels through the Avaya VPN Gateway (AVG)
without having to start any applets from the Portal. It can be used by any type of Java
application or applet.
The tunnel specifications are set by defining a port forwarder in the CLI/BBI. It is then referred
to when setting up the Port Forwarder API.
Note:
Defined applications are only started automatically if the port forwarder API is used by an
applet.
The API and Demo application are available from the Portal. Example: https://
vpn.example.com/nortel_cacheable/portforwarder.zip
The zip file contains both a signed and an unsigned version of the API along with javadoc
documentation and a demo application with source code.

Creating a Port Forwarder

The Port Forwarder API is a collection of functions used to provide applications with the ability
to send traffic through a previously defined port forwarder link. For instructions on how to
configure a port forwarder link on the AVG Portal, see the chapter "Group Links" in the Avaya
Application Guide for VPN.
To be able to use the Port Forwarder API, two URLs are needed:
• URL for the Portal login (called loginUrl in the following examples) Example: http://
vpn.example.com/login_post.yaws?
user=test&password=test&authmethod=default&url= The parameters are the
same as if accessing the Portal through a web browser.
• URL for the actual port forwarder (called portForwarderUrl in the following examples)
Example: http://vpn.example.com/link.yaws?t=custom&a=1&b=1&c=1
User Guide April 2013 255