mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-02-25 18:55:28 -06:00
6de0834fca
Unenrollment means that the host keytab is disabled on the server making it possible to re-install on the client. This host principal is how we distinguish an enrolled vs an unenrolled client machine on the server. I added a --unroll option to ipa-join that binds using the host credentials and disables its own keytab. I fixed a couple of other unrelated problems in ipa-join at the same time. I also documented all the possible return values of ipa-getkeytab and ipa-join. There is so much overlap because ipa-join calls ipa-getkeytab and it returns whatever value ipa-getkeytab returned on failure. ticket 242
124 lines
4.1 KiB
Groff
124 lines
4.1 KiB
Groff
.\" A man page for ipa-join
|
|
.\" Copyright (C) 2009 Red Hat, Inc.
|
|
.\"
|
|
.\" This is free software; you can redistribute it and/or modify it under
|
|
.\" the terms of the GNU Library General Public License as published by
|
|
.\" the Free Software Foundation; version 2 only
|
|
.\"
|
|
.\" This program is distributed in the hope that it will be useful, but
|
|
.\" WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
.\" General Public License for more details.
|
|
.\"
|
|
.\" You should have received a copy of the GNU Library General Public
|
|
.\" License along with this program; if not, write to the Free Software
|
|
.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
.\"
|
|
.\" Author: Rob Crittenden <rcritten@redhat.com>
|
|
.\"
|
|
.TH "ipa-join" "1" "Oct 8 2009" "freeipa" ""
|
|
.SH "NAME"
|
|
ipa\-join \- Join a machine to an IPA realm and get a keytab for the host service principal
|
|
.SH "SYNOPSIS"
|
|
ipa\-join [ \fB\-h\fR hostname ] [ \fB\-k\fR keytab\-file ] [ \fB\-s\fR server ] [ \fB\-w\fR bulk\-bind\-password ] [\fB\-u\fR] [ \fB\-d\fR ] [ \fB\-q\fR ]
|
|
|
|
.SH "DESCRIPTION"
|
|
Joins a host to an IPA realm and retrieves a kerberos \fIkeytab\fR for the host service principal, or unenrolls an enrolled host from an IPA server.
|
|
|
|
Kerberos keytabs are used for services (like sshd) to perform kerberos authentication. A keytab is a file with one or more secrets (or keys) for a kerberos principal.
|
|
|
|
The ipa\-join command will create and retrieve a service principal for host/foo.example.com@EXAMPLE.COM and place it by default into /etc/krb5.keytab. The location can be overridden with the \-k option.
|
|
|
|
The IPA server to contact is set in /etc/ipa/default.conf by default and can be overridden using the \-s,\-\-server option.
|
|
|
|
In order to join the machine needs to be authenticated. This can happen in one of two ways:
|
|
|
|
* Authenticate using the current kerberos principal
|
|
|
|
* Provide a password to authenticate with
|
|
|
|
If a client host has already been joined to the IPA realm the ipa\-join command will fail. The host will need to be removed from the server using `ipa host\-del FQDN` in order to join the client to the realm.
|
|
|
|
This command is normally executed by the ipa\-client\-install command as part of the enrollment process.
|
|
|
|
The reverse is unenrollment. Unenrolling a host removes the Kerberos key on the IPA server. This prepares the host to be re\-enrolled. This uses the host principal stored in /etc/krb5.conf to authenticate to the IPA server to perform the unenrollment.
|
|
.SH "OPTIONS"
|
|
.TP
|
|
\fB\-h,\-\-hostname hostname\fR
|
|
The hostname of this server (FQDN). By default of nodename from uname(2) is used.
|
|
.TP
|
|
\fB\-s,\-\-server server\fR
|
|
The hostname of this server (FQDN). By default of nodename from uname(2) is used.
|
|
.TP
|
|
\fB\-k,\-\-keytab keytab\-file\fR
|
|
The keytab file where to append the new key (will be created if it does not exist). Default: /etc/krb5.keytab
|
|
.TP
|
|
\fB\-w,\-\-bindpw password\fR
|
|
The password to use if not using kerberos to authenticate
|
|
.TP
|
|
\fB\-u,\-\-unenroll\fR
|
|
Unenroll this host from the IPA server
|
|
.TP
|
|
\fB\-q,\-\-quiet\fR
|
|
Quiet mode. Only errors are displayed.
|
|
.TP
|
|
\fB\-d,\-\-debug\fR
|
|
Debug mode.
|
|
.SH "EXAMPLES"
|
|
Join IPA domain and retrieve a keytab with kerberos credentials.
|
|
|
|
# kinit admin
|
|
# ipa\-join
|
|
|
|
Join IPA domain and retrieve a keytab using a one\-time password.
|
|
|
|
# ipa\-join \-w secret123
|
|
|
|
Join IPA domain and save the keytab in another location.
|
|
|
|
# ipa\-join \-k /tmp/host.keytab
|
|
.SH "EXIT STATUS"
|
|
The exit status is 0 on success, nonzero on error.
|
|
|
|
0 Success
|
|
|
|
1 Kerberos context initialization failed
|
|
|
|
2 Incorrect usage
|
|
|
|
3 Out of memory
|
|
|
|
4 Invalid service principal name
|
|
|
|
5 No Kerberos credentials cache
|
|
|
|
6 No Kerberos principal and no bind DN and password
|
|
|
|
7 Failed to open keytab
|
|
|
|
8 Failed to create key material
|
|
|
|
9 Setting keytab failed
|
|
|
|
10 Bind password required when using a bind DN
|
|
|
|
11 Failed to add key to keytab
|
|
|
|
12 Failed to close keytab
|
|
|
|
13 Host is already enrolled
|
|
|
|
14 LDAP failure
|
|
|
|
15 Incorrect bulk password
|
|
|
|
16 Host name must be fully\-qualified
|
|
|
|
17 XML\-RPC fault
|
|
|
|
18 Principal not found in host entry
|
|
|
|
19 Unable to generate Kerberos credentials cache
|
|
|
|
20 Unenrollment result not in XML\-RPC response
|