samba_gpoupdate: Rename the command to samba-gpupdate
[nivanova/samba-autobuild/.git] / source4 / scripting / man / samba-gpupdate.8.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3 <refentry id="samba-gpupdate.8">
4 <refentryinfo><date>2017-07-11</date></refentryinfo>
5
6 <refmeta>
7         <refentrytitle>SAMBA_GPOUPDATE</refentrytitle>
8         <manvolnum>8</manvolnum>
9         <refmiscinfo class="source">Samba</refmiscinfo>
10         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
11         <refmiscinfo class="version">4.8.0</refmiscinfo>
12 </refmeta>
13
14 <refnamediv>
15         <refname>samba-gpupdate</refname>
16         <refpurpose>apply group policy</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>samba-gpupdate</command>
22         </cmdsynopsis>
23
24         <cmdsynopsis>
25                 <command>samba-gpupdate</command>
26                 <arg choice="opt">
27                 <replaceable>options</replaceable>
28                 </arg>
29         </cmdsynopsis>
30
31 </refsynopsisdiv>
32
33
34 <refsect1>
35         <title>DESCRIPTION</title>
36         <para>This tool is part of the
37         <citerefentry><refentrytitle>samba</refentrytitle>
38         <manvolnum>1</manvolnum></citerefentry> suite.</para>
39
40         <para><command>samba-gpupdate</command> a script for
41         applying and unapplying Group Policy. Group Policy
42         application is experimental. Currently this applies
43         password policies (minimum/maximum password age,
44         minimum password length, and password complexity) and
45         kerberos policies (user/service ticket lifetime and
46         renew lifetime).</para>
47
48 </refsect1>
49
50 <refsect1>
51         <title>OPTIONS</title>
52
53 <para><option>-h</option>, <option>--help</option>
54        show this help message and exit</para>
55
56 <para><option>-H </option>URL, <option>--url</option>=<emphasis remap="I">URL</emphasis>
57        URL for the samdb</para>
58
59 <para><option>-X</option>, <option>--unapply</option>
60        Unapply Group Policy</para>
61
62 <para>Samba Common Options:</para>
63
64 <para><option>-s </option>FILE, <option>--configfile</option>=<emphasis remap="I">FILE</emphasis>
65        Configuration file</para>
66
67 <para><option>-d </option>DEBUGLEVEL, <option>--debuglevel</option>=<emphasis remap="I">DEBUGLEVEL</emphasis>
68        debug level</para>
69
70 <para><option>--option</option>=<emphasis remap="I">OPTION</emphasis>
71        set smb.conf option from command line</para>
72
73 <para><option>--realm</option>=<emphasis remap="I">REALM</emphasis>
74        set the realm name</para>
75
76 <para>Version Options:</para>
77
78 <para><option>-V</option>, <option>--version</option>
79        Display version number</para>
80
81 <para>Credentials Options:</para>
82
83 <para><option>--simple-bind-dn</option>=<emphasis remap="I">DN</emphasis>
84        DN to use for a simple bind</para>
85
86 <para><option>--password</option>=<emphasis remap="I">PASSWORD</emphasis>
87        Password</para>
88
89 <para><option>-U </option>USERNAME, <option>--username</option>=<emphasis remap="I">USERNAME</emphasis>
90        Username</para>
91
92 <para><option>-W </option>WORKGROUP, <option>--workgroup</option>=<emphasis remap="I">WORKGROUP</emphasis>
93        Workgroup</para>
94
95 <para><option>-N</option>, <option>--no-pass</option>
96        Don't ask for a password</para>
97
98 <para><option>-k </option>KERBEROS, <option>--kerberos</option>=<emphasis remap="I">KERBEROS</emphasis>
99        Use Kerberos</para>
100
101 <para><option>--ipaddress</option>=<emphasis remap="I">IPADDRESS</emphasis>
102        IP address of server</para>
103
104 <para><option>-P</option>, <option>--machine-pass</option>
105        Use stored machine account password</para>
106
107 </refsect1>
108
109 <refsect1>
110         <title>AUTHOR</title>
111         <para>The original Samba software and related utilities were
112         created by Andrew Tridgell. Samba is now developed by the
113         Samba Team as an Open Source project similar to the way the
114         Linux kernel is developed.</para>
115 </refsect1>
116
117 </refentry>