Jan Ulrich Hasecke
2022-08-05 62b67dcded0b9ade05953ec2723444bd28eeefc6
commit | author | age
261280 1 # Syntax {#kap-hsadmin-syntax}
JUH 2
bd89e9 3 Die Funktionen von HSAdmin können über das Kommandozeilenprogramm `hsscript` aufgerufen werden, welches Befehle per Parameter, Dateiübergabe oder interaktiv entgegennimmt.
JUH 4 Der Aufruf erfolgt nach folgender Syntax:
261280 5
JUH 6 ``` console
7 $ hsscript -u <Benutzer> -e <Befehl>...
8 ```
9
10 Die folgenden Optionen können übergeben werden.
11
bd89e9 12 `-u \--user`
261280 13
bd89e9 14 :  Benutzer, welcher zur Authentifizierung und Autorisierung verwendet werden soll, zum Beispiel `xyz00`.
261280 15
bd89e9 16 `-r \--runas`
261280 17
bd89e9 18 :  Benutzer, mit dessen Rechten der Befehl ausgeführt werden soll, zum Beispiel `xzy00-doms`.
261280 19
bd89e9 20 `-e \--expr`
261280 21
bd89e9 22 :  Der Befehl, der ausgeführt werden soll.
JUH 23 Er setzt sich aus einer Reihe von Parametern zusammen.
24
25 Der Befehl hat folgende Syntax:
261280 26
JUH 27     module.function({where:{field:'value',...}, set:{field:'value',...}}) 
28
29
bd89e9 30 | Parameter | Erläuterung                                                                   |
JUH 31 |:-------------------|:------------------------------------------------------------------------------|
32 | module    | Modul, dessen Funktion aufgerufen werden soll (z.B. `user`   oder `mysqldb`)  |
33 | function  | Funktion, welche aufgerufen werden soll (`search`, `add`, `update`, `remove`) |
34 | where     | selektiert nach Wert eines oder mehrerer Felder                               |
35 | set       | setzt oder aktualisiert den Wert eines oder mehrerer Felder                   |
261280 36
bd89e9 37   : Die Parameter
261280 38
JUH 39 Die Module und Funktionen werden in den folgenden Kapiteln erklärt.
40
bd89e9 41 `-f \--file`
261280 42
bd89e9 43 : Datei, aus welcher Befehle gelesen und ausgeführt werden sollen.
62b67d 44 Lesen Sie dazu den Abschnitt [HSAdmin über Skripte steuern](#kap-hsscript-skript).
261280 45
bd89e9 46 `-i \--interactive`
261280 47
bd89e9 48 : Das Programm startet im interaktiven Modus.
JUH 49 Die Befehle können am Kommandozeilen-Prompt eingegeben werden.
50