summaryrefslogtreecommitdiffstats
path: root/src/man/sss_override.8.xml
blob: 349bba27cdced4379bffab72f816bca271eeb2dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<reference>
<title>SSSD Manual pages</title>
<refentry>
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />

    <refmeta>
        <refentrytitle>sss_override</refentrytitle>
        <manvolnum>8</manvolnum>
    </refmeta>

    <refnamediv id='name'>
        <refname>sss_override</refname>
        <refpurpose>create local overrides of user and group attributes</refpurpose>
    </refnamediv>

    <refsynopsisdiv id='synopsis'>
        <cmdsynopsis>
            <command>sss_override</command>
            <arg choice='plain'><replaceable>COMMAND</replaceable></arg>
            <arg choice='opt'>
                <replaceable>options</replaceable>
            </arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1 id='description'>
        <title>DESCRIPTION</title>
        <para>
            <command>sss_override</command> enables to create a client-side
            view and allows to change selected values of specific user
            and groups. This change takes effect only on local machine.
        </para>
        <para>
            Overrides data are stored in the SSSD cache. If the cache is deleted,
            all local overrides are lost. Please note that after the first
            override is created using any of the following
            <emphasis>user-add</emphasis>, <emphasis>group-add</emphasis>,
            <emphasis>user-import</emphasis> or
            <emphasis>group-import</emphasis> command. SSSD needs to be
            restarted to take effect.
            <emphasis>sss_override</emphasis> prints message when a restart is
            required.
        </para>
    </refsect1>

    <refsect1 id='commands'>
        <title>AVAILABLE COMMANDS</title>
        <para>
            Argument <emphasis>NAME</emphasis> is the name of original object
            in all commands. It is not possible to override
            <emphasis>uid</emphasis> or <emphasis>gid</emphasis> to 0.
        </para>
        <variablelist remap='IP'>
            <varlistentry>
                <term>
                    <option>user-add</option>
                    <emphasis>NAME</emphasis>
                    <optional><option>-n,--name</option> NAME</optional>
                    <optional><option>-u,--uid</option> UID</optional>
                    <optional><option>-g,--gid</option> GID</optional>
                    <optional><option>-h,--home</option> HOME</optional>
                    <optional><option>-s,--shell</option> SHELL</optional>
                    <optional><option>-c,--gecos</option> GECOS</optional>
                    <optional><option>-x,--certificate</option>
                                     BASE64 ENCODED CERTIFICATE</optional>
                </term>
                <listitem>
                    <para>
                        Override attributes of an user. Please be aware that
                        calling this command will replace any previous override
                        for the (NAMEd) user.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>user-del</option>
                    <emphasis>NAME</emphasis>
                </term>
                <listitem>
                    <para>
                        Remove user overrides. However be aware that overridden
                        attributes might be returned from memory cache. Please
                        see SSSD option <emphasis>memcache_timeout</emphasis>
                        for more details.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>user-find</option>
                    <optional><option>-d,--domain</option> DOMAIN</optional>
                </term>
                <listitem>
                    <para>
                        List all users with set overrides.
                        If <emphasis>DOMAIN</emphasis> parameter is set,
                        only users from the domain are listed.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>user-show</option>
                    <emphasis>NAME</emphasis>
                </term>
                <listitem>
                    <para>
                        Show user overrides.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>user-import</option>
                    <emphasis>FILE</emphasis>
                </term>
                <listitem>
                    <para>
                        Import user overrides from <emphasis>FILE</emphasis>.
                        Data format is similar to standard passwd file.
                        The format is:
                    </para>
                    <para>
                        original_name:name:uid:gid:gecos:home:shell:base64_encoded_certificate
                    </para>
                    <para>
                        where original_name is original name of the user whose
                        attributes should be overridden. The rest of fields
                        correspond to new values. You can omit a value simply
                        by leaving corresponding field empty.
                    </para>
                    <para>
                        Examples:
                    </para>
                    <para>
                        ckent:superman::::::
                    </para>
                    <para>
                        ckent@krypton.com::501:501:Superman:/home/earth:/bin/bash:
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>user-export</option>
                    <emphasis>FILE</emphasis>
                </term>
                <listitem>
                    <para>
                        Export all overridden attributes and store them in
                        <emphasis>FILE</emphasis>. See
                        <emphasis>user-import</emphasis> for data format.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>group-add</option>
                    <emphasis>NAME</emphasis>
                    <optional><option>-n,--name</option> NAME</optional>
                    <optional><option>-g,--gid</option> GID</optional>
                </term>
                <listitem>
                    <para>
                        Override attributes of a group. Please be aware that
                        calling this command will replace any previous override
                        for the (NAMEd) group.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>group-del</option>
                    <emphasis>NAME</emphasis>
                </term>
                <listitem>
                    <para>
                        Remove group overrides. However be aware that overridden
                        attributes might be returned from memory cache. Please
                        see SSSD option <emphasis>memcache_timeout</emphasis>
                        for more details.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>group-find</option>
                    <optional><option>-d,--domain</option> DOMAIN</optional>
                </term>
                <listitem>
                    <para>
                        List all groups with set overrides.
                        If <emphasis>DOMAIN</emphasis> parameter is set,
                        only groups from the domain are listed.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>group-show</option>
                    <emphasis>NAME</emphasis>
                </term>
                <listitem>
                    <para>
                        Show group overrides.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>group-import</option>
                    <emphasis>FILE</emphasis>
                </term>
                <listitem>
                    <para>
                        Import group overrides from <emphasis>FILE</emphasis>.
                        Data format is similar to standard group file.
                        The format is:
                    </para>
                    <para>
                        original_name:name:gid
                    </para>
                    <para>
                        where original_name is original name of the group whose
                        attributes should be overridden. The rest of fields
                        correspond to new values. You can omit a value simply
                        by leaving corresponding field empty.
                    </para>
                    <para>
                        Examples:
                    </para>
                    <para>
                        admins:administrators:
                    </para>
                    <para>
                        Domain Users:Users:501
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>group-export</option>
                    <emphasis>FILE</emphasis>
                </term>
                <listitem>
                    <para>
                        Export all overridden attributes and store them in
                        <emphasis>FILE</emphasis>. See
                        <emphasis>group-import</emphasis> for data format.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    <refsect1 id='options'>
        <title>COMMON OPTIONS</title>
        <para>
            Those options are available with all commands.
        </para>
        <variablelist remap='IP'>
            <varlistentry>
                <term>
                    <option>--debug</option>
                    <replaceable>LEVEL</replaceable>
                </term>
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/debug_levels.xml" />
            </varlistentry>
        </variablelist>
    </refsect1>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />

</refentry>
</reference>