Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
EasyVpnClient Class Reference

EasyVpnClient is the process that handles the Easy VPN client. More...

Inheritance diagram for EasyVpnClient:
Process

Public Member Functions

void setServerIp (ip)
 Sets the server IP address for the Easy VPN client. More...
 
ip getServerIp ()
 Returns the server IP address for the Easy VPN client. More...
 
void setUsername (string)
 Sets the username for the Easy VPN client. More...
 
string getUsername ()
 Returns the username for the Easy VPN client. More...
 
void setPassword (string)
 Sets the password for the Easy VPN client. More...
 
string getPassword ()
 Returns the password for the Easy VPN client. More...
 
void setGroupName (string)
 Sets the group name for the Easy VPN client. More...
 
string getGroupName ()
 Returns the group name for the Easy VPN client. More...
 
void setGroupKey (string)
 Sets the group key for the Easy VPN client. More...
 
string getGroupKey ()
 Returns the group key for the Easy VPN client. More...
 
void setTunnelIp (ip)
 Sets the tunnel IP address for the Easy VPN client. More...
 
ip getTunnelIp ()
 Returns the tunnel IP address for the Easy VPN client. More...
 
void setTunnelMask (ip)
 Sets the tunnel mask for the Easy VPN client. More...
 
ip getTunnelMask ()
 Returns the tunnel mask for the Easy VPN client. More...
 
void connect ()
 Connects the Easy VPN client. More...
 
void disconnect ()
 Disconnects the Easy VPN client. More...
 
bool isConnected ()
 Returns true if the Easy VPN client is connected, false otherwise. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

EasyVpnClient is the process that handles the Easy VPN client.

Member Function Documentation

◆ connect()

void EasyVpnClient::connect ( )

Connects the Easy VPN client.

◆ disconnect()

void EasyVpnClient::disconnect ( )

Disconnects the Easy VPN client.

◆ getGroupKey()

string EasyVpnClient::getGroupKey ( )

Returns the group key for the Easy VPN client.

Returns
string, the group key for the Easy VPN client.

◆ getGroupName()

string EasyVpnClient::getGroupName ( )

Returns the group name for the Easy VPN client.

Returns
string, the group name for the Easy VPN client.

◆ getPassword()

string EasyVpnClient::getPassword ( )

Returns the password for the Easy VPN client.

Returns
string, the password for the Easy VPN client.

◆ getServerIp()

ip EasyVpnClient::getServerIp ( )

Returns the server IP address for the Easy VPN client.

Returns
ip, the server IP address for the Easy VPN client.

◆ getTunnelIp()

ip EasyVpnClient::getTunnelIp ( )

Returns the tunnel IP address for the Easy VPN client.

Returns
ip, the tunnel IP address for the Easy VPN client.

◆ getTunnelMask()

ip EasyVpnClient::getTunnelMask ( )

Returns the tunnel mask for the Easy VPN client.

Returns
ip, the tunnel mask for the Easy VPN client.

◆ getUsername()

string EasyVpnClient::getUsername ( )

Returns the username for the Easy VPN client.

Returns
string, the sername for the Easy VPN client.

◆ isConnected()

bool EasyVpnClient::isConnected ( )

Returns true if the Easy VPN client is connected, false otherwise.

Returns
bool, true if the Easy VPN client is connected, false otherwise.

◆ setGroupKey()

void EasyVpnClient::setGroupKey ( string  )

Sets the group key for the Easy VPN client.

Parameters
groupKey,thegroup key for the Easy VPN client.

◆ setGroupName()

void EasyVpnClient::setGroupName ( string  )

Sets the group name for the Easy VPN client.

Parameters
groupName,thegroup name for the Easy VPN client.

◆ setPassword()

void EasyVpnClient::setPassword ( string  )

Sets the password for the Easy VPN client.

Parameters
password,thepassword for the Easy VPN client.

◆ setServerIp()

void EasyVpnClient::setServerIp ( ip  )

Sets the server IP address for the Easy VPN client.

Parameters
serverIp,theserver IP address for the Easy VPN client.

◆ setTunnelIp()

void EasyVpnClient::setTunnelIp ( ip  )

Sets the tunnel IP address for the Easy VPN client.

Parameters
tunnelIp,thetunnel IP address for the Easy VPN client.

◆ setTunnelMask()

void EasyVpnClient::setTunnelMask ( ip  )

Sets the tunnel mask for the Easy VPN client.

Parameters
tunnelIp,thetunnel mask for the Easy VPN client.

◆ setUsername()

void EasyVpnClient::setUsername ( string  )

Sets the username for the Easy VPN client.

Parameters
username,theusername for the Easy VPN client.

The documentation for this class was generated from the following file: