Functions
Anlegen eines Accounts
add_account(array $parameter)
Parameters
$parameter
arrayfolgende Parameter sind möglich:
- kas_login: das betreffende KAS Login
- kas_auth_data: die Authentifizierungsdaten
- kas_auth_type: der Authentifizierungstyp
- account_kas_password: KAS-Passwort des neuen Accounts
- account_ftp_password: FTP-Passwort des neuen Accounts
- account_comment: der Accountkommentar (optional, default = hostname_part1.hostname_part2)
- account_contact_mail: die Kontakt-Email (optional)
- hostname_art: Art des Accounts: domain|subdomain|, = ohne Host
- domain:einen Subdomainaccount anlegen
- subdomain:einen Subdomainaccount anlegen
- leer lassen:einen Account ohne Host anlegen
- hostname_part1:
- wenn hostname_art=domain: das Domainlabel (z.B.: "meine-domain")
- wenn hostname_art=subdomain: das Subdomainlabel (z.B.: "forum")
- hostname_part2:
- wenn hostname_art=domain: das TLD Label (z.B.: "com" oder "de")
- wenn hostname_art=subdomain: die Domain zur Subdomain (z.B.: "meine-domain.de")
- hostname_path: Pfad zum Hostnamen (optional, default /hostname_part1.hostname_part2/)
- max_account: maximale Anzahl an Unteraccounts, die der Account anlegen darf (optional, default 0)
- max_domain: maximale Anzahl an Domains (optional, default 0)
- max_subdomain: maximale Anzahl an Subdomains (optional, default 0)
- max_webspace: maximaler Speicherplatz in MB (optional, default 0)
- max_mail_account: maximale Anzahl an Postfächern (optional, default 0)
- max_mail_forward: maximale Anzahl an Weiterleitungen (optional, default 0)
- max_mailinglist: maximale Anzahl an Mailinglisten (optional, default 0)
- max_database: maximale Anzahl an MySQL Datenbanken (optional, default 0)
- max_ftpuser: maximale Anzahl an zusätzlichen FTP-Nutzern (optional, default 0)
- max_sambauser: maximale Anzahl an Netzlaufwerken (optional, default 0)
- max_cronjobs: maximale Anzahl an Cronjobs (optional, default 0)
- inst_htaccess: darf Verzeichnisschutz nutzen (optional, default Y)
- inst_fpse: darf Frontpage-Servererweiterung nutzen (optional, default N)
- kas_access_forbidden: Zugang zum KAS sperren (optional, default N)
- inst_software: darf Softwareinstallation nutzen (optional, default Y)
- logging: Log-Einstellung: voll|kurz|ohneip|keine (optional, default keine)
- 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, default N)
- show_password: Hinweis zum Anzeigen der Passwörter (optional, default N)
Exceptions
TRUE |
die Aktion wurde durchgeführt |
\missing_parameter |
ein Pflichtparameter fehlt |
\account_comment_syntax_incorrect |
|
\account_contact_mail_syntax_incorrect |
|
\account_ftp_password_syntax_incorrect |
|
\account_kas_password_syntax_incorrect |
|
\couldnt_get_kas_ressources |
|
\dns_settings_not_allowed |
|
\dns_settings_syntax_incorrect |
|
\domain_syntax_incorrect |
|
\domain_tld_not_allowed |
|
\hostname_art_syntax_incorrect |
|
\hostname_exist_as_domain |
|
\hostname_exist_as_subdomain |
|
\hostname_forbidden |
|
\hostname_for_this_subdomain_doesnt_exist |
|
\hostname_has_active_mail_addresses |
|
\hostname_syntax_incorrect |
|
\path_syntax_incorrect |
|
\inst_fpse_syntax_incorrect |
|
\inst_htaccess_syntax_incorrect |
|
\inst_software_syntax_incorrect |
|
\kas_access_forbidden_syntax_incorrect |
|
\kas_login_syntax_incorrect |
|
\logging_syntax_incorrect |
|
\max_account_reached |
|
\max_account_syntax_incorrect |
|
\max_cron_reached |
|
\max_cron_syntax_incorrect |
|
\max_database_reached |
|
\max_database_syntax_incorrect |
|
\max_domain_reached |
|
\max_domain_syntax_incorrect |
|
\max_ftpuser_reached |
|
\max_ftpuser_syntax_incorrect |
|
\max_mail_account_reached |
|
\max_mail_account_syntax_incorrect |
|
\max_mail_forward_reached |
|
\max_mail_forward_syntax_incorrect |
|
\max_mailinglist_reached |
|
\max_mailinglist_syntax_incorrect |
|
\max_sambauser_reached |
|
\max_sambauser_syntax_incorrect |
|
\max_subdomain_reached |
|
\max_subdomain_syntax_incorrect |
|
\max_webspace_reached |
|
\max_webspace_syntax_incorrect |
|
\subdomain_syntax_incorrect |
|
\wildcardsubdomain_not_in_contract |
|
Löschen eines Accounts
delete_account(array $parameter)
Parameters
$parameter
arrayfolgende 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
Exceptions
TRUE |
die Aktion wurde durchgeführt |
\missing_parameter |
ein Pflichtparameter fehlt |
\in_progress |
das KAS Objekt ist zZt noch in Bearbeitung |
\account_has_active_subaccounts |
|
\account_kas_password_for_subaccount_incorrect |
|
\account_login_not_found |
|
\kas_login_not_found |
|
Auslesen der Accountressourcen
get_accountresources(array $parameter)
Parameters
$parameter
arrayfolgende Parameter sind möglich:
- kas_login: das betreffende KAS Login
- kas_auth_data: die Authentifizierungsdaten
- kas_auth_type: der Authentifizierungstyp
Exceptions
\array_return |
Array mit den vorhandenen Ressourcen des Accounts |
Auslesen der Accountressourcen
get_accountressources(array $parameter)
| deprecated |
2018-10-30: typo error, use get_accountresources() |
Parameters
$parameter
arrayfolgende Parameter sind möglich:
- kas_login: das betreffende KAS Login
- kas_auth_data: die Authentifizierungsdaten
- kas_auth_type: der Authentifizierungstyp
Exceptions
\array_return |
Array mit den vorhandenen Ressourcen des Accounts |
Auslesen der Accounts
get_accounts(array $parameter)
Parameters
$parameter
arrayfolgende Parameter sind möglich:
- kas_login: das betreffende KAS Login
- kas_auth_data: die Authentifizierungsdaten
- kas_auth_type: der Authentifizierungstyp
- account_login: das gewünschte Accountlogin (optional)
Exceptions
\array_return |
Array mit den vorhandenen Unteraccounts |
Auslesen der Accounteinstellungen
get_accountsettings(array $parameter)
Parameters
$parameter
arrayfolgende Parameter sind möglich:
- kas_login: das betreffende KAS Login
- kas_auth_data: die Authentifizierungsdaten
- kas_auth_type: der Authentifizierungstyp
Exceptions
\array_return |
Array mit den Accounteinstellungen |
Bearbeiten eines Accounts
update_account(array $parameter)
Parameters
$parameter
arrayfolgende 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
- 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)
- 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)
Exceptions
TRUE |
die Aktion wurde durchgeführt |
\missing_parameter |
ein Pflichtparameter fehlt |
\in_progress |
das KAS Objekt ist zZt noch in Bearbeitung |
\account_comment_syntax_incorrect |
|
\account_contact_mail_syntax_incorrect |
|
\account_kas_password_syntax_incorrect |
|
\account_login_not_found |
|
\couldnt_get_kas_ressources |
|
\couldnt_get_subaccount_ressources |
|
\dns_settings_not_allowed |
|
\dns_settings_syntax_incorrect |
|
\inst_fpse_not_allowed |
|
\inst_fpse_syntax_incorrect |
|
\inst_htaccess_not_allowed |
|
\inst_htaccess_syntax_incorrect |
|
\inst_software_not_allowed |
|
\inst_software_syntax_incorrect |
|
\kas_access_forbidden_syntax_incorrect |
|
\logging_syntax_incorrect |
|
\max_account_for_subaccount_gt_change_value |
|
\max_account_reached |
|
\max_account_syntax_incorrect |
|
\max_cron_for_subaccount_gt_change_value |
|
\max_cron_reached |
|
\max_cron_syntax_incorrect |
|
\max_database_for_subaccount_gt_change_value |
|
\max_database_reached |
|
\max_database_syntax_incorrect |
|
\max_domain_for_subaccount_gt_change_value |
|
\max_domain_reached |
|
\max_domain_syntax_incorrect |
|
\max_ftpuser_for_subaccount_gt_change_value |
|
\max_ftpuser_reached |
|
\max_ftpuser_syntax_incorrect |
|
\max_mail_account_for_subaccount_gt_change_value |
|
\max_mail_account_reached |
|
\max_mail_account_syntax_incorrect |
|
\max_mail_forward_for_subaccount_gt_change_value |
|
\max_mail_forward_reached |
|
\max_mail_forward_syntax_incorrect |
|
\max_mailinglist_for_subaccount_gt_change_value |
|
\max_mailinglist_reached |
|
\max_mailinglist_syntax_incorrect |
|
\max_sambauser_for_subaccount_gt_change_value |
|
\max_sambauser_reached |
|
\max_sambauser_syntax_incorrect |
|
\max_subdomain_for_subaccount_gt_change_value |
|
\max_subdomain_reached |
|
\max_subdomain_syntax_incorrect |
|
\max_webspace_for_subaccount_gt_change_value |
|
\max_webspace_reached |
|
\max_webspace_syntax_incorrect |
|
Bearbeiten der eigenen Accounteinstellungen
update_accountsettings(array $parameter)
Parameters
$parameter
arrayfolgende Parameter sind möglich:
- kas_login: das betreffende KAS Login
- kas_auth_data: die Authentifizierungsdaten
- kas_auth_type: der Authentifizierungstyp
- account_password: das KAS-Passwort (optional)
- show_password: Hinweis zum Anzeigen der Passwörter (optional) (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)
- account_comment: der Accountkommentar (optional)
- account_contact_mail: die Kontakt-Email (optional)
Exceptions
TRUE |
die Aktion wurde durchgeführt |
\in_progress |
das KAS Objekt ist zZt noch in Bearbeitung |
\nothing_to_do |
es wurde nichts geändert |
\account_comment_syntax_incorrect |
|
\account_contact_mail_syntax_incorrect |
|
\account_kas_password_syntax_incorrect |
|
\logging_syntax_incorrect |
|
\show_password_syntax_incorrect |
|
Bearbeiten der Superuser-Accounteinstellungen
update_superusersettings(array $parameter)
die Funktion darf nur vom Hauptaccount ausgeführt werden, welcher dann
bestimmte Unteraccounteinstellungen bearbeiten kann.
Parameters
$parameter
arrayfolgende Parameter sind möglich:
- kas_login: das betreffende KAS Login
- kas_auth_data: die Authentifizierungsdaten
- kas_auth_type: der Authentifizierungstyp
- account_login: das zu bearbeitende Accountlogin
- ssh_access: aktiviert den SSH Zugang eines Accounts: Y|N (optional)
- ssh_keys: SSH Schlüssel für die Public-Key-Authentifizierung (optional)
Exceptions
TRUE |
die Aktion wurde durchgeführt |
\missing_parameter |
ein Pflichtparameter fehlt |
\in_progress |
das KAS Objekt ist zZt noch in Bearbeitung |
\nothing_to_do |
es wurde nichts geändert |
\account_doesnt_belong_to_you |
|
\kas_login_is_no_main_login |
kas_login ist nicht der Hauptaccount |
\settings_not_in_contract |
|
\ssh_access_syntax_incorrect |
|
\ssh_keys_syntax_incorrect |
|