~ubuntu-branches/ubuntu/karmic/likewise-open/karmic

« back to all changes in this revision

Viewing changes to packaging/debian/domainjoin-cli.8

  • Committer: Bazaar Package Importer
  • Author(s): Rick Clark
  • Date: 2008-08-27 08:56:20 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20080827085620-5q0f58b9qtog9myq
Tags: 4.1.0.2956-0ubuntu1
* missing-likewise-logo.diff: removed
* fixed copyright notice
* updated Standards-Version to 3.8.0
* removed path from command in prerm
* removed stop in S runlevel

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"     Title: domainjoin-cli
 
2
.\"    Author: 
 
3
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
 
4
.\"      Date: 03/14/2008
 
5
.\"    Manual: 
 
6
.\"    Source: 
 
7
.\"
 
8
.TH "DOMAINJOIN\-CLI" "8" "03/14/2008" "" ""
 
9
.\" disable hyphenation
 
10
.nh
 
11
.\" disable justification (adjust text to left margin only)
 
12
.ad l
 
13
.SH "NAME"
 
14
domainjoin\-cli \- Join a host to an Active Directory domain
 
15
.SH "SYNOPSIS"
 
16
.HP 15
 
17
\fBdomainjoin\-cli\fR [\fIoptions\fR] join [\fB\-\-ou\fR\ \fIorganizational_unit\fR]
 
18
.br
 
19
[\fB\-\-enable\fR\ \fImodule\fR...] [\fB\-\-disable\fR\ \fImodule\fR...]
 
20
.br
 
21
[\fB\-\-preview\fR] [\fB\-\-advanced\fR] [\fB\-\-details\fR\ \fImodule\fR]
 
22
.br
 
23
\fIdomain\fR \fIusername\fR [\fIpassword\fR]
 
24
.HP 15
 
25
\fBdomainjoin\-cli\fR [\fIoptions\fR] leave
 
26
.br
 
27
[\fB\-\-enable\fR\ \fImodule\fR...] [\fB\-\-disable\fR\ \fImodule\fR...]
 
28
.br
 
29
[\fB\-\-preview\fR] [\fB\-\-advanced\fR] [\fB\-\-details\fR\ \fImodule\fR]
 
30
.br
 
31
[\fIusername\fR\ [\fIpassword\fR]]
 
32
.HP 15
 
33
\fBdomainjoin\-cli\fR [\fIoptions\fR] query
 
34
.HP 15
 
35
\fBdomainjoin\-cli\fR [\fIoptions\fR] fixfqdn
 
36
.HP 15
 
37
\fBdomainjoin\-cli\fR [\fIoptions\fR] setname \fIname\fR
 
38
.SH "DESCRIPTION"
 
39
.PP
 
40
 
 
41
\fBdomainjoin\-cli\fR
 
42
is the command\-line version of the
 
43
\fILikewise\fR
 
44
AD domain join tool. In a basic invocation,
 
45
\fBdomainjoin\-cli\fR
 
46
will join the current machine into an AD domain, enable authentication of AD users, and enable group policy if it is available.
 
47
.PP
 
48
For systems with sensitive configurations,
 
49
\fBdomainjoin\-cli\fR
 
50
offers fine\-grained control over modifications to system configuration files that are typically required during a join, such as editing
 
51
\fI/etc/nsswitch.conf\fR
 
52
or the system PAM setup.
 
53
.SH "USAGE"
 
54
.SS "Commands"
 
55
.PP
 
56
 
 
57
\fBdomainjoin\-cli\fR
 
58
supports the following major modes of operation:
 
59
.PP
 
60
join
 
61
.RS 4
 
62
Joins the machine to the AD domain
 
63
\fIdomain\fR
 
64
and configures AD authentication and group policy (where applicable). This operation requires valid AD credentials for
 
65
\fIdomain\fR
 
66
to be specified as
 
67
\fIusername\fR
 
68
and
 
69
\fIpassword\fR. If
 
70
\fIpassword\fR
 
71
is not specified on the command line,
 
72
\fBdomainjoin\-cli\fR
 
73
will prompt you for it.
 
74
.sp
 
75
 
 
76
\fBdomainjoin\-cli\fR
 
77
supports joining the machine to a specific OU (Organizational Unit) with
 
78
\fB\-\-ou\fR \fIorganizational_unit\fR.
 
79
.RE
 
80
.PP
 
81
leave
 
82
.RS 4
 
83
Leaves the currently\-joined AD domain and deconfigures AD authentication and group policy (where applicable).
 
84
.sp
 
85
In order to actually disable the machine account in AD, either administrative credentials for
 
86
\fIdomain\fR
 
87
or the same credentials originally used to join the machine must be specified as
 
88
\fIusername\fR
 
89
and
 
90
\fIpassword\fR. If
 
91
\fIpassword\fR
 
92
is not specified on the command line,
 
93
\fBdomainjoin\-cli\fR
 
94
will prompt you for it.
 
95
.sp
 
96
If no credentials are specified, the machine will no longer behave as a member of
 
97
\fIdomain\fR
 
98
but its machine account will remain enabled in AD.
 
99
.RE
 
100
.PP
 
101
query
 
102
.RS 4
 
103
Displays information about the currently\-joined AD domain and OU.
 
104
.RE
 
105
.PP
 
106
fixfqdn
 
107
.RS 4
 
108
Makes local configuration modifications necessary to ensure that the fully\-qualified domain name of the machine is forward\- and backward\-resolvable. This can work around domain join issues on networks with sub\-optimal DNS setups.
 
109
.RE
 
110
.PP
 
111
setname
 
112
.RS 4
 
113
Changes the hostname of this machine to
 
114
\fIname\fR. As it is necessary to have a unique, non\-generic name before joining AD, this operation is provided as a convenient way to quickly rename this computer before performing a join.
 
115
.RE
 
116
.SS "Common options"
 
117
.PP
 
118
\fB\-\-log\fR \fIfilename\fR
 
119
.RS 4
 
120
Log details about the operation to
 
121
\fIfile\fR. If
 
122
\fIfile\fR
 
123
is ".", logging is directed to the console.
 
124
.RE
 
125
.PP
 
126
\fB\-\-loglevel\fR <error | warning | info | verbose >
 
127
.RS 4
 
128
Specifies the level of logging information which should be written to the log file.
 
129
.RE
 
130
.PP
 
131
\fB\-\-help\fR
 
132
.RS 4
 
133
Displays brief usage and help information. No operation is performed.
 
134
.RE
 
135
.SS "Join and leave options"
 
136
.PP
 
137
\fB\-\-ou\fR \fIorganizational_unit\fR
 
138
.RS 4
 
139
Joins the machine to the OU
 
140
\fIorganizational_unit\fR
 
141
instead of the default "Computers" OU. The OU to which a machine is joined determines which users will be able to authenticate against the machine and which group policies will be applied. This option has no effect when leaving a domain.
 
142
.RE
 
143
.PP
 
144
\fB\-\-enable\fR \fImodule\fR
 
145
.RS 4
 
146
Explicitly enables the configuration module
 
147
\fImodule\fR
 
148
during the join or leave operation.
 
149
.RE
 
150
.PP
 
151
\fB\-\-disable\fR \fImodule\fR
 
152
.RS 4
 
153
Explicitly disables the configuration module
 
154
\fImodule\fR
 
155
during the join or leave operation.
 
156
.sp
 
157
Note that some modules are necessary for the proper operation of
 
158
\fILikewise\fR
 
159
while joined to AD. If you attempt to disable such a module,
 
160
\fBdomainjoin\-cli\fR
 
161
will refuse to proceed with a join operation.
 
162
.sp
 
163
For some modules, it is possible to make the relevant configuration changes by hand;
 
164
\fBdomainjoin\-cli\fR
 
165
will inform you of the necessary changes and will proceed with the module disabled if it detects that the changes have been made.
 
166
.RE
 
167
.PP
 
168
\fB\-\-details\fR \fImodule\fR
 
169
.RS 4
 
170
Provide details about module
 
171
\fImodule\fR
 
172
and what specific configuration changes it would perform during a join or leave operation. No actual operation is performed.
 
173
.RE
 
174
.PP
 
175
\fB\-\-preview\fR
 
176
.RS 4
 
177
Provide a summary of what configuration modules would be run during a join or leave operation. No actual operation is performed.
 
178
.RE
 
179
.PP
 
180
\fB\-\-advanced\fR
 
181
.RS 4
 
182
Turns on debugging information during leave and join operations and provides more verbose output when using
 
183
\fB\-\-preview\fR. This is generally only helpful when diagnosing unusual system or network configuration issues.
 
184
.RE
 
185
.SH "EXAMPLES"
 
186
.PP
 
187
Example invocations of
 
188
\fBdomainjoin\-cli\fR
 
189
and their effects follow:
 
190
.sp
 
191
.RS 4
 
192
.nf
 
193
$ domainjoin\-cli join sales.my\-company.com Administrator@sales rosebud
 
194
.fi
 
195
.RE
 
196
.PP
 
197
Joins the AD domain
 
198
sales.my\-company.com
 
199
using
 
200
Administrator
 
201
as the username and
 
202
rosebud
 
203
as the password. This is the typical join scenario.
 
204
.sp
 
205
.RS 4
 
206
.nf
 
207
$ domainjoin\-cli \-\-log . leave
 
208
.fi
 
209
.RE
 
210
.PP
 
211
Leaves the current AD domain without attempting to disable the machine account as no user credentials were specified. Information about the process will be logged to the console at the default logging level.
 
212
.sp
 
213
.RS 4
 
214
.nf
 
215
$ domainjoin\-cli join \-\-disable nsswitch sales.my\-company.com Administrator@sales
 
216
.fi
 
217
.RE
 
218
.PP
 
219
Joins the AD domain
 
220
sales.my\-company.com
 
221
using
 
222
Administrator
 
223
as the username and prompting for the password. If possible, nsswitch configuration will not be modified.
 
224
.sp
 
225
.RS 4
 
226
.nf
 
227
$ domainjoin\-cli join \-\-preview sales.my\-company.com Administrator@sales rosebud
 
228
.fi
 
229
.RE
 
230
.PP
 
231
Show what configuration modules would be run when joining the AD domain
 
232
sales.my\-company.com.
 
233
.sp
 
234
.RS 4
 
235
.nf
 
236
$ domainjoin\-cli join \-\-details pam sales.my\-company.com Administrator@sales rosebud
 
237
.fi
 
238
.RE
 
239
.PP
 
240
Show what changes would be made to the system by the
 
241
pam
 
242
module when joining the AD domain
 
243
sales.my\-company.com.
 
244
.SH "VERSION"
 
245
.PP
 
246
This man page is correct for Likewise Open version 4.1.