.. _kap-modul-q:

=======
Modul q
=======

Funktionen
==========

.. option:: q.search

   Das HSAdmin-Modul hat nur die Funktion ``search``.
   Hiermit ist die Ausgabe der bereits ausgeführten HSAdmin-Aktionen möglich.
   Die Ausgabe zeigt an, ob eine Aktion erfolgreich abgeschlossen werden konnte
   oder ob beim Ausrollen der Konfiguration auf den Server Fehler aufgetreten sind.
   Im Erfolgsfall wird als Status 'done' angezeigt. Wenn Fehler aufgetreten sind 
   wird er Status 'error' ausgegeben. Daneben wird eine interne Fehlermeldung
   im Feld 'exception' angezeigt. Wenden Sie sich im Fehlerfall bitte an an den Service.
   

Beispiele
=========

.. code-block:: console

    $  q.search ({where:{user:'xyz00'}})