src/man/sss_seed.8.xml

6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay<?xml version="1.0" encoding="UTF-8"?>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay<reference>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay<title>SSSD Manual pages</title>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay<refentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    <refmeta>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <refentrytitle>sss_seed</refentrytitle>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <manvolnum>8</manvolnum>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    </refmeta>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    <refnamediv id='name'>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <refname>sss_seed</refname>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <refpurpose>seed the SSSD cache with a user</refpurpose>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    </refnamediv>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    <refsynopsisdiv id='synopsis'>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <cmdsynopsis>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <command>sss_seed</command>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <arg choice='opt'>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <replaceable>options</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </arg>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <arg choice='plain'>-D <replaceable>DOMAIN</replaceable></arg>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <arg choice='plain'>-n <replaceable>USER</replaceable></arg>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        </cmdsynopsis>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    </refsynopsisdiv>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    <refsect1 id='description'>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <title>DESCRIPTION</title>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <command>sss_seed</command> seeds the SSSD cache with a user entry
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            and temporary password. If a user entry is already present in the
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            SSSD cache then the entry is updated with the temporary password.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    </refsect1>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    <refsect1 id='options'>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <title>OPTIONS</title>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        <variablelist remap='IP'>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-D</option>,<option>--domain</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <replaceable>DOMAIN</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Provide the name of the domain in which the
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        user is a member of. The domain is also used to
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        retrieve user information. The domain must be configured
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        in sssd.conf. The <replaceable>DOMAIN</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        option must be provided.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Information retrieved from the domain
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        overrides what is provided in the options.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-n</option>,<option>--username</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <replaceable>USER</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        The username of the entry to be created or modified
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        in the cache. The <replaceable>USER</replaceable> option
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        must be provided.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-u</option>,<option>--uid</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <replaceable>UID</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Set the UID of the user to
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        <replaceable>UID</replaceable>.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-g</option>,<option>--gid</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <replaceable>GID</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Set the GID of the user to
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        <replaceable>GID</replaceable>.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-c</option>,<option>--gecos</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <replaceable>COMMENT</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Any text string describing the user. Often used as
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        the field for the user's full name.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-h</option>,<option>--home</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <replaceable>HOME_DIR</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Set the home directory of the user to
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        <replaceable>HOME_DIR</replaceable>.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-s</option>,<option>--shell</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <replaceable>SHELL</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Set the login shell of the user to
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        <replaceable>SHELL</replaceable>.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-i</option>,<option>--interactive</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Interactive mode for entering user information. This
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        option will only prompt for information not provided in
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        the options or retrieved from the domain.
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            <varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <option>-p</option>,<option>--password-file</option>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <replaceable>PASS_FILE</replaceable>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </term>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                <listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    <para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        Specify file to read user's password from. (if not
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                        specified password is prompted for)
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                    </para>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay                </listitem>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay            </varlistentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay           <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay        </variablelist>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    </refsect1>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek    <refsect1 id='notes'>
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek        <title>NOTES</title>
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek        <para>
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek            The length of the password (or the size of file specified with -p
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek            or --password-file option) must be less than or equal to PASS_MAX
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek            bytes (64 bytes on systems with no globally-defined PASS_MAX value).
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek        </para>
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek        <para>
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek        </para>
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek    </refsect1>
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek
f0f2ac9ee5a0b83806899cc3636941acb87bbccfMichal Zidek
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay</refentry>
6ea6ec5cb7d9985e2730fb9d4657624d10aed4d8Nick Guay</reference>