sssd.8.xml revision 6d2942eb10f5fc4f791498d7f6c2ef021c3b8777
7cb128dc4cae2a03a742f63ba7afee23c78e3af0Phil Carmody<?xml version="1.0" encoding="UTF-8"?>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
9ca6d68fbad1892423ca798818f579c95475a19aTimo Sirainen<reference>
e65df911d966a0b4623e287d4669253cc46bbe0fTimo Sirainen<title>SSSD Manual pages</title>
e65df911d966a0b4623e287d4669253cc46bbe0fTimo Sirainen<refentry>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen
1af95e0fea59835842dafe207e86ebc53691c596Timo Sirainen <refmeta>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <refentrytitle>sssd</refentrytitle>
9ca6d68fbad1892423ca798818f579c95475a19aTimo Sirainen <manvolnum>8</manvolnum>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </refmeta>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <refnamediv id='name'>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <refname>sssd</refname>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <refpurpose>System Security Services Daemon</refpurpose>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen </refnamediv>
9ca6d68fbad1892423ca798818f579c95475a19aTimo Sirainen
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <refsynopsisdiv id='synopsis'>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <cmdsynopsis>
9ca6d68fbad1892423ca798818f579c95475a19aTimo Sirainen <command>sssd</command>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <arg choice='opt'>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <replaceable>options</replaceable>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen </arg>
b1a2d2042e8c7e99983175eb462b82cc7a8cb70bTimo Sirainen </cmdsynopsis>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen </refsynopsisdiv>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <refsect1 id='description'>
9ca6d68fbad1892423ca798818f579c95475a19aTimo Sirainen <title>DESCRIPTION</title>
9ca6d68fbad1892423ca798818f579c95475a19aTimo Sirainen <para>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen <command>SSSD</command> provides a set of daemons to manage access to remote
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen directories and authentication mechanisms. It provides an NSS and
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen PAM interface toward the system and a pluggable backend system to
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen connect to multiple different account sources as well as D-Bus
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen interface. It is also the basis to provide client auditing and
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen policy services for projects like FreeIPA. It provides a more robust database
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen to store local users as well as extended user data.
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen </para>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen </refsect1>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen <refsect1 id='options'>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen <title>OPTIONS</title>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen <variablelist remap='IP'>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen <varlistentry>
e39459afd08b437e72fd72cd60ff409230695bceTimo Sirainen <term>
e39459afd08b437e72fd72cd60ff409230695bceTimo Sirainen <option>-d</option>,<option>--debug-level</option>
e39459afd08b437e72fd72cd60ff409230695bceTimo Sirainen <replaceable>LEVEL</replaceable>
e39459afd08b437e72fd72cd60ff409230695bceTimo Sirainen </term>
e39459afd08b437e72fd72cd60ff409230695bceTimo Sirainen <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/debug_levels.xml" />
b50e80d237435686c4ea525643f266731a600981Timo Sirainen </varlistentry>
e39459afd08b437e72fd72cd60ff409230695bceTimo Sirainen <varlistentry>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen <term>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen <option>--debug-timestamps=</option><replaceable>mode</replaceable>
854574e0a4a4d38b0ada296cc85eed3530436c69Timo Sirainen </term>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen <listitem>
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen <para>
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen <emphasis>1</emphasis>: Add a timestamp to the debug messages
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen </para>
2769852989e20e50b437550bda3489e0950942a6Timo Sirainen <para>
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen <emphasis>0</emphasis>: Disable timestamp in the debug messages
2769852989e20e50b437550bda3489e0950942a6Timo Sirainen </para>
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen <para>
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen Default: 1
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen </para>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen </listitem>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen </varlistentry>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen <varlistentry>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen <term>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen <option>--debug-microseconds=</option><replaceable>mode</replaceable>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen </term>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen <listitem>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen <para>
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen <emphasis>1</emphasis>: Add microseconds to the timestamp in debug messages
bff477af402040474e42fd43c361fbd5ba21d3d8Timo Sirainen </para>
bff477af402040474e42fd43c361fbd5ba21d3d8Timo Sirainen <para>
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen <emphasis>0</emphasis>: Disable microseconds in timestamp
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen </para>
d5e131e809cf52342d904857d41c2bb41973dde8Timo Sirainen <para>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen Default: 0
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </para>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </listitem>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </varlistentry>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <varlistentry>
e2170d0dfac94f795ab5dbe05939393c14b1946cTimo Sirainen <term>
e2170d0dfac94f795ab5dbe05939393c14b1946cTimo Sirainen <option>-f</option>,<option>--debug-to-files</option>
e2170d0dfac94f795ab5dbe05939393c14b1946cTimo Sirainen </term>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <listitem>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <para>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen Send the debug output to files instead of stderr. By default, the
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen log files are stored in <filename>/var/log/sssd</filename> and
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen there are separate log files for every SSSD service and domain.
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen </para>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen </listitem>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen </varlistentry>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <varlistentry>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <term>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <option>-D</option>,<option>--daemon</option>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </term>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <listitem>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <para>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen Become a daemon after starting up.
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </para>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </listitem>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen </varlistentry>
14e45b91d0ce2c213b6f8f8e027171f0d08a84baTimo Sirainen <varlistentry>
14e45b91d0ce2c213b6f8f8e027171f0d08a84baTimo Sirainen <term>
94a77d6e5d7600859e4c5e4a7ea19dc3e91998b9Timo Sirainen <option>-i</option>,<option>--interactive</option>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </term>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <listitem>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <para>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen Run in the foreground, don't become a daemon.
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </para>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </listitem>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </varlistentry>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <varlistentry>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <term>
5940a2b112cdabc534df17179e63208f4c81a28bTimo Sirainen <option>-c</option>,<option>--config</option>
5940a2b112cdabc534df17179e63208f4c81a28bTimo Sirainen </term>
5940a2b112cdabc534df17179e63208f4c81a28bTimo Sirainen <listitem>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <para>
13aff14ae8b2fb88c39bacc132b468ae82d63145Timo Sirainen Specify a non-default config file. The default is
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <filename>/etc/sssd/sssd.conf</filename>. For reference
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen on the config file syntax and options, consult the
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <citerefentry>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <refentrytitle>sssd.conf</refentrytitle>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <manvolnum>5</manvolnum>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </citerefentry>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen manual page.
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </para>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </listitem>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
13aff14ae8b2fb88c39bacc132b468ae82d63145Timo Sirainen <varlistentry>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <term>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen <option>--version</option>
4f75b5bff4ec7e825a55bfbe743fb00c52e15abcTimo Sirainen </term>
5940a2b112cdabc534df17179e63208f4c81a28bTimo Sirainen <listitem>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <para>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen Print version number and exit.
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </para>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </listitem>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </varlistentry>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </variablelist>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen </refsect1>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <refsect1>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <title>Signals</title>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <variablelist remap='IP'>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <varlistentry>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <term>SIGTERM/SIGINT</term>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <listitem>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen <para>
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen Informs the SSSD to gracefully terminate all of its
adcb46fe2c6d1139dfbd8ab08a8fbe96e53f8fd6Timo Sirainen child processes and then shut down the monitor.
13aff14ae8b2fb88c39bacc132b468ae82d63145Timo Sirainen </para>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </listitem>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen </varlistentry>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <varlistentry>
9fb018dea4e2073639249ea8a14ae27cab2c0aacTimo Sirainen <term>SIGHUP</term>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <listitem>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <para>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen Tells the SSSD to stop writing to its current debug
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen file descriptors and to close and reopen them. This is
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen meant to facilitate log rolling with programs like
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen logrotate.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </para>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </listitem>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <term>SIGUSR1</term>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <listitem>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <para>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen Tells the SSSD to simulate offline operation for one
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen minute. This is mostly useful for testing purposes.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </para>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </listitem>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <term>SIGUSR2</term>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <listitem>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <para>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen Tells the SSSD to go online immediately. This is mostly
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen useful for testing purposes.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </para>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </listitem>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </variablelist>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </refsect1>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <refsect1 id='notes'>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <title>NOTES</title>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <para>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen If the environment variable SSS_NSS_USE_MEMCACHE is set to "NO",
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen client applications will not use the fast in memory cache.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </para>
214fc90c61133ea4a3521dd7313fe488a55ac0c6Timo Sirainen </refsect1>
214fc90c61133ea4a3521dd7313fe488a55ac0c6Timo Sirainen
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen</refentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen</reference>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen