summaryrefslogtreecommitdiffstats
path: root/src/man/sss_seed.8.xml
blob: 39f8c026c579e400613fa40334ea0e0c7e22fb00 (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
<?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_seed</refentrytitle>
        <manvolnum>8</manvolnum>
    </refmeta>

    <refnamediv id='name'>
        <refname>sss_seed</refname>
        <refpurpose>seed the SSSD cache with a user</refpurpose>
    </refnamediv>

    <refsynopsisdiv id='synopsis'>
        <cmdsynopsis>
            <command>sss_seed</command>
            <arg choice='opt'>
                <replaceable>options</replaceable>
            </arg>
            <arg choice='plain'>-D <replaceable>DOMAIN</replaceable></arg>
            <arg choice='plain'>-n <replaceable>USER</replaceable></arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1 id='description'>
        <title>DESCRIPTION</title>
        <para>
            <command>sss_seed</command> seeds the SSSD cache with a user entry
            and temporary password. If a user entry is already present in the
            SSSD cache then the entry is updated with the temporary password.
        </para>
        <para>
        </para>
    </refsect1>

    <refsect1 id='options'>
        <title>OPTIONS</title>
        <variablelist remap='IP'>
            <varlistentry>
                <term>
                    <option>-D</option>,<option>--domain</option>
                    <replaceable>DOMAIN</replaceable>
                </term>
                <listitem>
                    <para>
                        Provide the name of the domain in which the
                        user is a member of. The domain is also used to
                        retrieve user information. The domain must be configured
                        in sssd.conf. The <replaceable>DOMAIN</replaceable>
                        option must be provided.
                        Information retrieved from the domain
                        overrides what is provided in the options.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-n</option>,<option>--username</option>
                    <replaceable>USER</replaceable>
                </term>
                <listitem>
                    <para>
                        The username of the entry to be created or modified
                        in the cache. The <replaceable>USER</replaceable> option
                        must be provided.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-u</option>,<option>--uid</option>
                    <replaceable>UID</replaceable>
                </term>
                <listitem>
                    <para>
                        Set the UID of the user to
                        <replaceable>UID</replaceable>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-g</option>,<option>--gid</option>
                    <replaceable>GID</replaceable>
                </term>
                <listitem>
                    <para>
                        Set the GID of the user to
                        <replaceable>GID</replaceable>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-c</option>,<option>--gecos</option>
                    <replaceable>COMMENT</replaceable>
                </term>
                <listitem>
                    <para>
                        Any text string describing the user. Often used as
                        the field for the user's full name.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-h</option>,<option>--home</option>
                    <replaceable>HOME_DIR</replaceable>
                </term>
                <listitem>
                    <para>
                        Set the home directory of the user to
                        <replaceable>HOME_DIR</replaceable>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-s</option>,<option>--shell</option>
                    <replaceable>SHELL</replaceable>
                </term>
                <listitem>
                    <para>
                        Set the login shell of the user to
                        <replaceable>SHELL</replaceable>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-i</option>,<option>--interactive</option>
                </term>
                <listitem>
                    <para>
                        Interactive mode for entering user information. This
                        option will only prompt for information not provided in
                        the options or retrieved from the domain.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-p</option>,<option>--password-file</option>
                    <replaceable>PASS_FILE</replaceable>
                </term>
                <listitem>
                    <para>
                        Specify file to read user's password from. (if not
                        specified password is prompted for)
                    </para>
                </listitem>
            </varlistentry>
           <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
        </variablelist>
    </refsect1>

    <refsect1 id='notes'>
        <title>NOTES</title>
        <para>
            The length of the password (or the size of file specified with -p
            or --password-file option) must be less than or equal to PASS_MAX
            bytes (64 bytes on systems with no globally-defined PASS_MAX value).
        </para>
        <para>
        </para>
    </refsect1>


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

</refentry>
</reference>