Api Reference - Fortinet Version 4.0 MR1 Administration Manual

API reference

API reference
56
Table 6: Methods
Connect(bstrTunnelName As String)
Disconnect(bstrTunnelName As String)
GetPolicy
(pbAV As Boolean,
pbAS As Boolean,
pbFW As Boolean,
pbWF As Boolean)
GetRemainingKeyLife
(bstrTunnelName As String,
pSecs As Long,
pKBytes As Long)
MakeSystemPolicyCompliant()
SendXAuthResponse
(tunnelName As String,
userName As String,
password As String,
savePassword As Boolean)
SetPolicy
(bAV As Boolean,
bAS As Boolean,
bFW As Boolean,
bWF As Boolean)
Table 7: Functions
GetActiveTunnel() As String
GetTunnelList()
IsConnected
(bstrTunnelName As String)
As Boolean
IsIdle(bstrTunnelName As String)
As Boolean
Table 8: Events
OnConnect(bstrTunnelName As String)
OnDisconnect(bstrTunnelName As String)
OnIdle(bstrTunnelName As String)
OnOutOfCompliance(bAV As Boolean, bAS
As Boolean, bFW As Boolean, bWF As
Boolean)
OnXAuthRequest(bstrTunnelName As String) The VPN peer on the named connection requests
Open the named VPN tunnel. This connection
must already be configured in your FortiClient
application.
Close the named VPN tunnel.
Retrieve security policy settings for
Antivirus
AntiSpam
Firewall
Web Filter
True means feature must be enabled.
Retrieve the remaining key life for the named
connection. Whether keylife time (pSecs) or data
(pKBytes) are significant depends on the detailed
settings in the FortiClient application.
Apply the security policy defined by SetPolicy.
Send XAuth credentials for the named connection:
User name
Password
True if password should be saved.
Set security policy settings for
Antivirus
AntiSpam
Firewall
Web Filter
True means feature must be enabled.
Retrieve the name of the active connection.
Retrieve the list of all connections configured in the
FortiClient application.
Return True if the named connection is up.
Return True if the named connection is idle.
Connection established.
Connection disconnected.
Connection idle.
FortiClient has gone out of compliance with
security policy. Arguments correspond to features.
True indicates the feature is out of compliance with
security policy.
XAuth authentication.
FortiClient Endpoint Security Version 4.0 MR1 Administration Guide
Using the FortiClient API
04-40001-99556-20090626
http://docs.fortinet.com/ • Feedback