Documentation

account

Table of Contents

Functions

add_account()  : mixed
Anlegen eines Accounts
get_accounts()  : mixed
Auslesen der Accounts
get_accountsettings()  : mixed
Auslesen der Accounteinstellungen
get_server_information()  : mixed
Auslesen der zusätzlichen Serverinformationen zum Account, z.B.: verfügbare PHP Versionen
update_accountsettings()  : mixed
Bearbeiten der eigenen Accounteinstellungen
update_superusersettings()  : mixed
Bearbeiten der Superuser-Accounteinstellungen

Functions

add_account()

Anlegen eines Accounts

add_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_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)
  • max_wbk: maximale Anzahl an WBKs (optional, default 0)
  • inst_htaccess: darf Verzeichnisschutz nutzen (optional, default Y)
  • 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)
Tags
link

Beispiel: Domainaccount anlegen

link

Beispiel: Subdomainaccount anlegen

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
account_comment_syntax_incorrect
throws
account_contact_mail_syntax_incorrect
throws
account_ftp_password_syntax_incorrect
throws
account_kas_password_syntax_incorrect
throws
couldnt_get_kas_ressources
throws
dns_settings_not_allowed
throws
dns_settings_syntax_incorrect
throws
domain_syntax_incorrect
throws
domain_tld_not_allowed
throws
hostname_art_syntax_incorrect
throws
hostname_exist_as_domain
throws
hostname_exist_as_subdomain
throws
hostname_forbidden
throws
hostname_for_this_subdomain_doesnt_exist
throws
hostname_has_active_mail_addresses
throws
hostname_syntax_incorrect
throws
path_syntax_incorrect
throws
inst_fpse_syntax_incorrect
throws
inst_htaccess_syntax_incorrect
throws
inst_software_syntax_incorrect
throws
kas_access_forbidden_syntax_incorrect
throws
kas_login_syntax_incorrect
throws
logging_syntax_incorrect
throws
max_account_reached
throws
max_account_syntax_incorrect
throws
max_cron_reached
throws
max_cron_syntax_incorrect
throws
max_database_reached
throws
max_database_syntax_incorrect
throws
max_domain_reached
throws
max_domain_syntax_incorrect
throws
max_ftpuser_reached
throws
max_ftpuser_syntax_incorrect
throws
max_mail_account_reached
throws
max_mail_account_syntax_incorrect
throws
max_mail_forward_reached
throws
max_mail_forward_syntax_incorrect
throws
max_mailinglist_reached
throws
max_mailinglist_syntax_incorrect
throws
max_sambauser_reached
throws
max_sambauser_syntax_incorrect
throws
max_subdomain_reached
throws
max_subdomain_syntax_incorrect
throws
max_webspace_reached
throws
max_webspace_syntax_incorrect
throws
subdomain_syntax_incorrect
throws
wildcardsubdomain_not_in_contract

get_accounts()

Auslesen der Accounts

get_accounts(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 gewünschte Accountlogin (optional)
Tags
link

Beispiel

throws
array_return

Array mit den vorhandenen Unteraccounts

get_accountsettings()

Auslesen der Accounteinstellungen

get_accountsettings(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 Accounteinstellungen

get_server_information()

Auslesen der zusätzlichen Serverinformationen zum Account, z.B.: verfügbare PHP Versionen

get_server_information(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 Informationen

update_accountsettings()

Bearbeiten der eigenen Accounteinstellungen

update_accountsettings(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_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)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
nothing_to_do

es wurde nichts geändert

throws
account_comment_syntax_incorrect
throws
account_contact_mail_syntax_incorrect
throws
account_kas_password_syntax_incorrect
throws
logging_syntax_incorrect
throws
show_password_syntax_incorrect

update_superusersettings()

Bearbeiten der Superuser-Accounteinstellungen

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

die Funktion darf nur vom Hauptaccount ausgeführt werden, welcher dann bestimmte Unteraccounteinstellungen bearbeiten kann.

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 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)
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
account_doesnt_belong_to_you
throws
kas_login_is_no_main_login

kas_login ist nicht der Hauptaccount

throws
settings_not_in_contract
throws
ssh_access_syntax_incorrect
throws
ssh_keys_syntax_incorrect

        
On this page

Search results