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