summaryrefslogtreecommitdiffstats
path: root/src/man/sssd.8.xml
blob: 5fda3ad71d43af84f2e6d020fce4f84fbc2c1f91 (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
<?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>sssd</refentrytitle>
        <manvolnum>8</manvolnum>
    </refmeta>

    <refnamediv id='name'>
        <refname>sssd</refname>
        <refpurpose>System Security Services Daemon</refpurpose>
    </refnamediv>

    <refsynopsisdiv id='synopsis'>
        <cmdsynopsis>
            <command>sssd</command>
            <arg choice='opt'>
                <replaceable>options</replaceable>
            </arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1 id='description'>
        <title>DESCRIPTION</title>
        <para>
            <command>SSSD</command> provides a set of daemons to manage access to remote
            directories and authentication mechanisms. It provides an NSS and
            PAM interface toward the system and a pluggable backend system to
            connect to multiple different account sources as well as D-Bus
            interface. It is also the basis to provide client auditing and
            policy services for projects like FreeIPA. It provides a more robust database
            to store local users as well as extended user data.
        </para>
    </refsect1>

    <refsect1 id='options'>
        <title>OPTIONS</title>
        <variablelist remap='IP'>
            <varlistentry>
                <term>
                    <option>-d</option>,<option>--debug-level</option>
                    <replaceable>LEVEL</replaceable>
                </term>
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/debug_levels.xml" />
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--debug-timestamps=</option><replaceable>mode</replaceable>
                </term>
                <listitem>
                    <para>
                        <emphasis>1</emphasis>: Add a timestamp to the debug messages
                    </para>
                    <para>
                        <emphasis>0</emphasis>: Disable timestamp in the debug messages
                    </para>
                    <para>
                        Default: 1
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--debug-microseconds=</option><replaceable>mode</replaceable>
                </term>
                <listitem>
                    <para>
                        <emphasis>1</emphasis>: Add microseconds to the timestamp in debug messages
                    </para>
                    <para>
                        <emphasis>0</emphasis>: Disable microseconds in timestamp
                    </para>
                    <para>
                        Default: 0
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-f</option>,<option>--debug-to-files</option>
                </term>
                <listitem>
                    <para>
                        Send the debug output to files instead of stderr. By default, the
                        log files are stored in <filename>/var/log/sssd</filename> and
                        there are separate log files for every SSSD service and domain.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-D</option>,<option>--daemon</option>
                </term>
                <listitem>
                    <para>
                        Become a daemon after starting up.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-i</option>,<option>--interactive</option>
                </term>
                <listitem>
                    <para>
                        Run in the foreground, don't become a daemon.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-c</option>,<option>--config</option>
                </term>
                <listitem>
                    <para>
                        Specify a non-default config file. The default is
                        <filename>/etc/sssd/sssd.conf</filename>. For reference
                        on the config file syntax and options, consult the
                        <citerefentry>
                            <refentrytitle>sssd.conf</refentrytitle>
                            <manvolnum>5</manvolnum>
                        </citerefentry>
                        manual page.
                    </para>
                </listitem>
            </varlistentry>
            <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
        </variablelist>
    </refsect1>

    <refsect1>
        <title>Signals</title>
        <variablelist remap='IP'>
            <varlistentry>
                <term>SIGTERM/SIGINT</term>
                <listitem>
                    <para>
                        Informs the SSSD to gracefully terminate all of its
                        child processes and then shut down the monitor.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>SIGHUP</term>
                <listitem>
                    <para>
                        Tells the SSSD to stop writing to its current debug
                        file descriptors and to close and reopen them. This is
                        meant to facilitate log rolling with programs like
                        logrotate.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>SIGUSR1</term>
                <listitem>
                    <para>
                        Tells the SSSD to simulate offline operation for one
                        minute. This is mostly useful for testing purposes.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>SIGUSR2</term>
                <listitem>
                    <para>
                        Tells the SSSD to go online immediately. This is mostly
                        useful for testing purposes.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    <refsect1 id='see_also'>
        <title>SEE ALSO</title>
        <para>
            <citerefentry>
                <refentrytitle>sssd.conf</refentrytitle><manvolnum>5</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_groupadd</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_groupdel</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_useradd</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>.
        </para>
    </refsect1>
</refentry>
</reference>