Documentation

ftpuser

Table of Contents

Functions

add_ftpusers()  : mixed
Anlegen eines FTP Nutzers
delete_ftpuser()  : mixed
Löschen eines FTP Nutzers
get_ftpusers()  : mixed
Auslesen der FTP Nutzer
update_ftpuser()  : mixed
Bearbeiten eines FTP Nutzers

Functions

add_ftpusers()

Anlegen eines FTP Nutzers

add_ftpusers(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • ftp_password: das FTP Passwort
  • ftp_comment: der Kommentar
  • ftp_path: der Pfad zum Login (optional, default /)
  • ftp_permission_read: der Nutzer darf lesen: Y|N (optional, default Y)
  • ftp_permission_write: der Nutzer darf lesen: Y|N (optional, default Y)
  • ftp_permission_list: der Nutzer darf lesen: Y|N (optional, default Y)
  • ftp_virus_clamav: der Nutzer hat einen Virenschutz: Y|N (optional, default Y)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
couldnt_get_kas_ressources
throws
ftp_comment_syntax_incorrect
throws
ftp_permission_list_syntax_incorrect
throws
ftp_permission_read_syntax_incorrect
throws
ftp_permission_write_syntax_incorrect
throws
ftp_virus_clamav_syntax_incorrect
throws
max_ftpuser_reached
throws
missing_parameter
throws
password_syntax_incorrect
throws
path_syntax_incorrect

delete_ftpuser()

Löschen eines FTP Nutzers

delete_ftpuser(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • ftp_login: das zu löschende Login
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
ftp_login_belongs_to_account
throws
ftp_login_not_found
throws
ftp_login_syntax_incorrect

get_ftpusers()

Auslesen der FTP Nutzer

get_ftpusers(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • ftp_login: das gewünschte FTP Login (optional)
Tags
link

Beispiel

throws
array_return

Array mit den vorhandenen FTP Nutzern im Account

update_ftpuser()

Bearbeiten eines FTP Nutzers

update_ftpuser(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • ftp_login: das zu bearbeitende Login
  • ftp_path: der Pfad zum Login (optional)
  • ftp_new_password: das neue FTP Passwort (optional)
  • ftp_comment: der Kommentar (optional)
  • ftp_permission_read: der Nutzer darf lesen: Y|N (optional)
  • ftp_permission_write: der Nutzer darf lesen: Y|N (optional)
  • ftp_permission_list: der Nutzer darf lesen: Y|N (optional)
  • ftp_virus_clamav: der Nutzer hat einen Virenschutz: Y|N (optional)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
nothing_to_do

es wurde nichts geändert

throws
ftp_comment_syntax_incorrect
throws
ftp_login_not_found
throws
ftp_login_syntax_incorrect
throws
ftp_path_syntax_incorrect
throws
ftp_permission_list_syntax_incorrect
throws
ftp_permission_read_syntax_incorrect
throws
ftp_permission_write_syntax_incorrect
throws
ftp_virus_clamav_syntax_incorrect
throws
password_syntax_incorrect

        
On this page

Search results