Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Administration Guide

API reference

The following tables provide API reference values.

Disconnect(bstrTunnelName As String)

Close the named VPN tunnel.

GetPolicy pbAV As Boolean, pbAS As Boolean, pbFW As Boolean, pbWF As Boolean)

Command was deprecated in FortiClient 5.0.

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

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

MakeSystemPolicyCompliant()

Command was deprecated in FortiClient 5.0.

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.

SetPolicy (bAV As Boolean, bAS As Boolean, bFW As Boolean, bWF As Boolean)

Command was deprecated in FortiClient 5.0.

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.

OnOutOfCompliance(bAV As Boolean, bAS As Boolean, bFW As Boolean, bWF As Boolean)

Command was deprecated in FortiClient 5.0.

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.

GetPolicy pbAV As Boolean, pbAS As Boolean, pbFW As Boolean, pbWF As Boolean)

Command was deprecated in FortiClient 5.0.

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

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

MakeSystemPolicyCompliant()

Command was deprecated in FortiClient 5.0.

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.

SetPolicy (bAV As Boolean, bAS As Boolean, bFW As Boolean, bWF As Boolean)

Command was deprecated in FortiClient 5.0.

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.

OnOutOfCompliance(bAV As Boolean, bAS As Boolean, bFW As Boolean, bWF As Boolean)

Command was deprecated in FortiClient 5.0.

OnXAuthRequest(bstrTunnelName As String)

The VPN peer on the named connection requests XAuth authentication.