.. _kap-hsadmin-syntax:
======
Die Funktionen von HSAdmin können über das Kommandozeilenprogramm :command:hsscript
aufgerufen werden, welches Befehle per Parameter, Dateiübergabe oder interaktiv entgegennimmt.
Der Aufruf erfolgt nach folgender Syntax:
.. code-block:: console
$ hsscript -u -e ...
Die folgenden Optionen können übergeben werden.
.. option:: -u --user
Benutzer, welcher zur Authentifizierung und Autorisierung verwendet werden soll, zum Beispiel xyz00
.
.. option:: -r --runas
Benutzer, mit dessen Rechten der Befehl ausgeführt werden soll, zum Beispiel xzy00-doms
.
.. option:: -e --expr
Der Befehl, der ausgeführt werden soll.
Er setzt sich aus einer Reihe von Parametern zusammen.
Der Befehl hat folgende Syntax::
module.function({where:{field:'value',...}, set:{field:'value',...}})
+-----------+---------------------------------------------------------------------------------------+
| Parameter | Erläuterung |
+===========+=======================================================================================+
| module | Modul, dessen Funktion aufgerufen werden soll (z.B. user
oder mysqldb
) |
+-----------+---------------------------------------------------------------------------------------+
| function | Funktion, welche aufgerufen werden soll (search
, add
, update
, remove
) |
+-----------+---------------------------------------------------------------------------------------+
| where | selektiert nach Wert eines oder mehrerer Felder |
+-----------+---------------------------------------------------------------------------------------+
| set | setzt oder aktualisiert den Wert eines oder mehrerer Felder |
+-----------+---------------------------------------------------------------------------------------+
Die Module und Funktionen werden in den folgenden Kapiteln erklärt.
.. option:: -f --file
Datei, aus welcher Befehle gelesen und ausgeführt werden sollen.
Lesen Sie dazu :numref:kap-hsscript-skript
.
.. option:: -i --interactive
Das Programm startet im interaktiven Modus.
Die Befehle können am Kommandozeilen-Prompt eingegeben werden.