Documentation

Funktionen

Table of Contents

Packages

account
cronjob
database
ddns
directoryprotection
dns
domain
ftpuser
mailaccount
mailforward
mailinglist
mailfilter
sambauser
session
softwareinstall
subdomain
symlink
statistic
chown
ssl

Functions

add_database()  : mixed
Anlegen einer Datenbank
add_directoryprotection()  : mixed
Anlegen eines Verzeichnisschutz-Einstellungen
add_mailinglist()  : mixed
Anlegen einer Mailingliste
delete_account()  : mixed
Löschen eines Accounts
delete_dns_settings()  : mixed
Löschen eines DNS Resource Records
delete_mailstandardfilter()  : mixed
Löschen der Standardfilter eines Mailkontos
delete_subdomain()  : mixed
Löschen einer Subdomain
get_accountresources()  : mixed
Auslesen der Accountressourcen
get_databases()  : mixed
Auslesen der Datenbanken
get_dns_settings()  : mixed
Auslesen der DNS Einstellungen einer Zone
get_mailaccounts()  : mixed
Auslesen der Mailaccounts
get_sambausers()  : mixed
Auslesen der Netzlaufwerksnutzer
get_subdomains()  : mixed
Auslesen der Subdomains
update_account()  : mixed
Bearbeiten eines Accounts
update_database()  : mixed
Bearbeiten einer Datenbank
update_directoryprotection()  : mixed
Bearbeiten der Verzeichnisschutz-Einstellungen
update_mailinglist()  : mixed
Bearbeiten einer Mailingliste

Functions

add_database()

Anlegen einer Datenbank

add_database(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
  • database_password: das Datenbankpasswort
  • database_comment: der Datenbankkommentar
  • database_allowed_hosts: erlaubte IP Adressen, die sich zur Datenbank verbinden dürfen (optional)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
account_is_dummyaccount
throws
cant_connect_to_mysql_on_this_server
throws
couldnt_get_kas_ressources
throws
database_allowed_hosts_syntax_incorrect
throws
database_comment_syntax_incorrect
throws
max_database_reached
throws
no_mysql_on_this_server
throws
password_syntax_incorrect

add_directoryprotection()

Anlegen eines Verzeichnisschutz-Einstellungen

add_directoryprotection(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
  • directory_user: das Login
  • directory_path: der Pfad
  • directory_password: das Passwort
  • directory_authname: der Kommentar
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
directory_password_syntax_incorrect
throws
directory_path_syntax_incorrect
throws
directory_user_count_neq_passcount
throws
directory_user_syntax_incorrect
throws
duplicate_directory_user
throws
max_directory_user_reached
throws
directory_authname_syntax_incorrect

add_mailinglist()

Anlegen einer Mailingliste

add_mailinglist(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
  • mailinglist_name: der Listenname
  • mailinglist_domain: der Domainname zur Liste
  • mailinglist_password: das Listenpasswort
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
couldnt_get_kas_ressources
throws
mailinglist_already_exists
throws
mailinglist_domain_doesnt_exist
throws
mailinglist_domain_syntax_incorrect
throws
mailinglist_syntax_incorrect
throws
max_mailinglists_reached
throws
missing_parameter
throws
password_syntax_incorrect

delete_account()

Löschen eines Accounts

delete_account(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
  • account_login: das zu löschene Accountlogin
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
account_has_active_subaccounts
throws
account_kas_password_for_subaccount_incorrect
throws
account_login_not_found
throws
kas_login_not_found

delete_dns_settings()

Löschen eines DNS Resource Records

delete_dns_settings(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
  • record_id: die ID des Resource Records
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
dns_settings_not_allowed
throws
record_id_not_found
throws
record_id_syntax_incorrect
throws
record_is_not_changeable

delete_mailstandardfilter()

Löschen der Standardfilter eines Mailkontos

delete_mailstandardfilter(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
  • mail_login: das Login für welches die Filter entfernt werden sollen
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
login_not_found
throws
mail_login_syntax_incorrect

delete_subdomain()

Löschen einer Subdomain

delete_subdomain(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
  • subdomain_name: der zu löschende Hostname
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
host_is_dummyhost
throws
subdomain_doenst_exist

get_accountresources()

Auslesen der Accountressourcen

get_accountresources(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
Tags
link

Beispiel

throws
array_return

Array mit den vorhandenen Ressourcen des Accounts

get_databases()

Auslesen der Datenbanken

get_databases(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
  • database_login: die gewünsche Datenbank (optional)
Tags
link

Beispiel

throws
array_return

Array mit den vorhandenen Datenbanken im Account

get_dns_settings()

Auslesen der DNS Einstellungen einer Zone

get_dns_settings(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
  • zone_host: die betreffende Zone
  • record_id: die ID des Resource Records (optional)
Tags
link

Beispiel

throwss

array_return Array der DNS Einstellungen zur Zone

get_mailaccounts()

Auslesen der Mailaccounts

get_mailaccounts(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
  • mail_login: das gewünschte Maillogin (optional)
Tags
link

Beispiel

throws
array_return

Array mit den vorhandenen Mailaccounts

get_sambausers()

Auslesen der Netzlaufwerksnutzer

get_sambausers(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
  • samba_login: das gewünschte Login (optional)
Tags
link

Beispiel

throws
array_return

Array der Netzlaufwerknutzer

get_subdomains()

Auslesen der Subdomains

get_subdomains(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
  • subdomain_name: die gewünsche Subdomain (optional)
Tags
link

Beispiel

throws
array_return

Array mit den vorhandenen Subdomains im Account

update_account()

Bearbeiten eines Accounts

update_account(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
  • account_login: der zu bearbeitende Account
  • account_kas_password: das KAS-Passwort (optional)
  • max_account: maximale Anzahl an Unteraccounts, die der Account anlegen darf (optional)
  • max_domain: maximale Anzahl an Domains (optional)
  • max_subdomain: maximale Anzahl an Subdomains (optional)
  • max_webspace: maximaler Speicherplatz in MB (optional)
  • max_mail_account: maximale Anzahl an Postfächern (optional)
  • max_mail_forward: maximale Anzahl an Weiterleitungen (optional)
  • max_mailinglist: maximale Anzahl an Mailinglisten (optional)
  • max_database: maximale Anzahl an MySQL Datenbanken (optional)
  • max_ftpuser: maximale Anzahl an zusätzlichen FTP-Nutzern (optional)
  • max_sambauser: maximale Anzahl an Netzlaufwerken (optional)
  • max_cronjobs: maximale Anzahl an Cronjobs (optional)
  • max_wbk: maximale Anzahl an WBKs (optional)
  • inst_htaccess: darf Verzeichnisschutz nutzen (optional)
  • inst_fpse: darf Frontpage-Servererweiterung nutzen (optional)
  • kas_access_forbidden: Zugang sperren (optional: N|Y|forbidden)
  • show_password: Hinweis zum Anzeigen der Passwörter (optional)
  • inst_software: darf Softwareinstallation nutzen (optional)
  • logging: Accesslog-Einstellung: voll|kurz|ohneip|keine (optional)
  • logage: Logs werden nach x Tagen entfernt: 1-999 (optional, default 190)
  • statistic: Statistiken (=/usage) erzeugen; in welcher Sprache? 0|de|ne (optional, default 0)
  • dns_settings: darf DNS Einstellungen nutzen (optional)
  • account_comment: der Accountkommentar (optional)
  • account_contact_mail: die Kontakt-Email (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
account_comment_syntax_incorrect
throws
account_contact_mail_syntax_incorrect
throws
account_kas_password_syntax_incorrect
throws
account_login_not_found
throws
couldnt_get_kas_ressources
throws
couldnt_get_subaccount_ressources
throws
dns_settings_not_allowed
throws
dns_settings_syntax_incorrect
throws
inst_fpse_not_allowed
throws
inst_fpse_syntax_incorrect
throws
inst_htaccess_not_allowed
throws
inst_htaccess_syntax_incorrect
throws
inst_software_not_allowed
throws
inst_software_syntax_incorrect
throws
kas_access_forbidden_syntax_incorrect
throws
logging_syntax_incorrect
throws
max_account_for_subaccount_gt_change_value
throws
max_account_reached
throws
max_account_syntax_incorrect
throws
max_cron_for_subaccount_gt_change_value
throws
max_cron_reached
throws
max_cron_syntax_incorrect
throws
max_database_for_subaccount_gt_change_value
throws
max_database_reached
throws
max_database_syntax_incorrect
throws
max_domain_for_subaccount_gt_change_value
throws
max_domain_reached
throws
max_domain_syntax_incorrect
throws
max_ftpuser_for_subaccount_gt_change_value
throws
max_ftpuser_reached
throws
max_ftpuser_syntax_incorrect
throws
max_mail_account_for_subaccount_gt_change_value
throws
max_mail_account_reached
throws
max_mail_account_syntax_incorrect
throws
max_mail_forward_for_subaccount_gt_change_value
throws
max_mail_forward_reached
throws
max_mail_forward_syntax_incorrect
throws
max_mailinglist_for_subaccount_gt_change_value
throws
max_mailinglist_reached
throws
max_mailinglist_syntax_incorrect
throws
max_sambauser_for_subaccount_gt_change_value
throws
max_sambauser_reached
throws
max_sambauser_syntax_incorrect
throws
max_subdomain_for_subaccount_gt_change_value
throws
max_subdomain_reached
throws
max_subdomain_syntax_incorrect
throws
max_webspace_for_subaccount_gt_change_value
throws
max_webspace_reached
throws
max_webspace_syntax_incorrect

update_database()

Bearbeiten einer Datenbank

update_database(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
  • database_login: das betreffende Datenbanklogin
  • database_new_password: das neue Datenbankpasswort (optional)
  • database_comment: der Datenbankkommentar (optional)
  • database_allowed_hosts: erlaubte IP Adressen, die sich zur Datenbank verbinden dürfen (optional)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
nothing_to_do

es wurde nichts geändert

throws
cant_connect_to_mysql_on_this_server
throws
database_comment_syntax_incorrect
throws
database_login_not_found
throws
database_allowed_hosts_syntax_incorrect
throws
no_mysql_on_this_server
throws
password_syntax_incorrect

update_directoryprotection()

Bearbeiten der Verzeichnisschutz-Einstellungen

update_directoryprotection(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
  • directory_user: das Login
  • directory_path: der Pfad
  • directory_password: das neue zu setzende Passwort
  • directory_authname: der Kommentar
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
directory_password_syntax_incorrect
throws
directory_path_syntax_incorrect
throws
directory_user_syntax_incorrect
throws
directory_authname_syntax_incorrect

update_mailinglist()

Bearbeiten einer Mailingliste

update_mailinglist(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
  • mailinglist_name: die zu bearbeitende Mailingliste
  • subscriber: die Listenteilnehmer als RFC2822 (mehrere mit Zeilenumbruch getrennt, optional)
  • restrict_post: die Resrict-Post-Adressen RFC2822 (mehrere mit Zeilenumbruch getrennt, optional)
  • config: die komplette Konfigurationsdatei als Klartext
  • is_active: ist die Mailingliste aktiv: 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
cannot_connect_to_majordomo
throws
cannot_login_to_majordomo
throws
cannot_open_tmp_config
throws
cannot_open_tmp_restrict_post
throws
cannot_open_tmp_subscriber
throws
cannot_write_tmp_config
throws
cannot_write_tmp_restrict_post
throws
cannot_write_tmp_subscriber
throws
cannot_write_to_majordomo
throws
is_active_syntax_incorrect
throws
mailinglist_not_found
throws
mailinglist_syntax_incorrect
throws
parse_error_in_tmp_config
throws
restrict_post_email_syntax_incorrect
throws
subscriber_email_syntax_incorrect

        
On this page

Search results