Jan Ulrich Hasecke
2019-11-06 8d081ac85398030bb1c1f5f6e59e5c995a6987fa
commit | author | age
8d081a 1 .. _kap-modul-user:
JUH 2
3 ==========
4 Modul user
5 ==========
6
7 Funktionen
8 ==========
9
10 .. option:: user.search
11
12    Suche Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten
13
14 .. option:: user.add
15
16    Füge einen neuen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten hinzu.
17
18 .. option:: user.update
19
20    Aktualisiere einen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten.
21
22 .. option:: user.remove
23
24    Lösche einen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten.
25
26 Editierbare Felder
0a126d 27 ==================
JUH 28
8d081a 29 Das HSAdmin-Modul ``user`` kann entsprechend der folgenden Befehlssyntax von :command:`HSADmin` Felder setzen oder verändern::
0a126d 30
8d081a 31    user.function({where:{field:'value',...}, set:{field:'value',...}})
0a126d 32
8d081a 33 Im Modul ``user`` stehen folgende Felder zur Verfügung.
JUH 34
35 name
36    Benutzerkennung (z.B. xyz00-abc)
37
38 comment
39    Kommentar, in dem zum Beispiel die Funktion des Benutzers beschrieben werden kann
40
41 password
42    Das Passwort
43
44 shell
45   Die zugewiesene Shell (z.B. ``/bin/bash``) 
46
47 quota_softlimit
48   Das zugewiesene :term:`Quota` in Megabyte
49
50 quote_hardlimit
51   Grenze der :term:`Grace Period`, bis zu der Überschreitungen des Softlimit toleriert werden. Angabe in Megabyte
52
53
54 Beispiele
55 =========
56
57 In einer interaktiven Sitzung wird mit folgendem Befehl der neue Benutzer ``xyz00-mustermann`` angelegt.
0a126d 58
JUH 59 .. code-block:: console
60
61     xyz00@hsadmin> user.add ({set:{name:'xyz00-mustermann',comment:'Max Mustermann',password:'!1?2-3aBc',shell:'/bin/bash',quota_softlimit:'50',quota_hardlimit:'75'}})
8d081a 62
JUH 63
64 .. todo:: Weitere Beispiele, mindestens noch eins mit where-Kondition