Fortinet black logo

Administration Guide

API reference

API reference

The following tables provide API reference values:

Disconnect(bstrTunnelName As String)

Close the named VPN tunnel.

GetRemainingKeyLife(bstrTunnelName As String, pSecs As Long, pKBytes As Long)

Retrieve the named connection remaining key life. Whether key life time (pSecs) or data (pKBytes) are significant depends on the detailed settings in the FortiClient application.

SendXAuthResponse (tunnelName As String, userName As String, password As String, savePassword As Boolean)

Send XAuth credentials for the named connection:
  • Username, password
  • True if password should be saved

GetTunnelList()

Retrieve the list of all connections configured in the FortiClient application.

IsConnected (bstrTunnelName As String) As Boolean

Return True if the named connection is up.

IsIdle (bstrTunnelName As String) As Boolean

Return True if the named connection is idle.

OnDisconnect(bstrTunnelName As String)

Connection disconnected.

OnIdle(bstrTunnelName As String)

Connection idle.

OnXAuthRequest(bstrTunnelName As String)

The VPN peer on the named connection requests XAuth authentication.

API reference

The following tables provide API reference values:

Disconnect(bstrTunnelName As String)

Close the named VPN tunnel.

GetRemainingKeyLife(bstrTunnelName As String, pSecs As Long, pKBytes As Long)

Retrieve the named connection remaining key life. Whether key life time (pSecs) or data (pKBytes) are significant depends on the detailed settings in the FortiClient application.

SendXAuthResponse (tunnelName As String, userName As String, password As String, savePassword As Boolean)

Send XAuth credentials for the named connection:
  • Username, password
  • True if password should be saved

GetTunnelList()

Retrieve the list of all connections configured in the FortiClient application.

IsConnected (bstrTunnelName As String) As Boolean

Return True if the named connection is up.

IsIdle (bstrTunnelName As String) As Boolean

Return True if the named connection is idle.

OnDisconnect(bstrTunnelName As String)

Connection disconnected.

OnIdle(bstrTunnelName As String)

Connection idle.

OnXAuthRequest(bstrTunnelName As String)

The VPN peer on the named connection requests XAuth authentication.