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