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