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
FtpUserAccountManager Class Reference

FtpUserAccountManager manages user accounts for FTP servers. More...

Public Member Functions

void addFtpUser (string, string, string)
 Adds an FTP user account with the specified username, password, and permissions. More...
 
void removeFtpUser (string)
 Removes the specified FTP user account. More...
 
bool isExistingUser (string)
 Returns true if the specified username already exists, otherwise false. More...
 
int getUsersCount ()
 Returns the number of users accounts. More...
 
string getUsernameAt (int)
 Returns the username at given index. More...
 
string getPasswordAt (int)
 Returns the password at given index. More...
 
string getPermissionAt (int)
 Returns the permission at given index. More...
 

Detailed Description

FtpUserAccountManager manages user accounts for FTP servers.

Member Function Documentation

◆ addFtpUser()

void FtpUserAccountManager::addFtpUser ( string  ,
string  ,
string   
)

Adds an FTP user account with the specified username, password, and permissions.

Parameters
username,theusername for the account.
password,thepassword for the account.
perms,thepermissions for the account. Permissions: R - Read W - Write N - Rename L - List D - Delete Example: "RW" will permit read and write operations

◆ getPasswordAt()

string FtpUserAccountManager::getPasswordAt ( int  )

Returns the password at given index.

Parameters
i,indexof the user.
Returns
string, the password at given index.

◆ getPermissionAt()

string FtpUserAccountManager::getPermissionAt ( int  )

Returns the permission at given index.

Parameters
i,indexof the user.
Returns
string, the permission at given index.

◆ getUsernameAt()

string FtpUserAccountManager::getUsernameAt ( int  )

Returns the username at given index.

Parameters
i,indexof the user.
Returns
string, the username at given index.

◆ getUsersCount()

int FtpUserAccountManager::getUsersCount ( )

Returns the number of users accounts.

Returns
int, the number of users accounts.

◆ isExistingUser()

bool FtpUserAccountManager::isExistingUser ( string  )

Returns true if the specified username already exists, otherwise false.

Parameters
username,theusername of the account of interest.
Returns
bool, true if the specified username already exists, otherwise false.

◆ removeFtpUser()

void FtpUserAccountManager::removeFtpUser ( string  )

Removes the specified FTP user account.

Parameters
username,theusername of the account of interest.

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