summaryrefslogtreecommitdiffstats
path: root/install/tools/man/ipa-compliance.1
diff options
context:
space:
mode:
authorRob Crittenden <rcritten@redhat.com>2011-02-01 14:24:46 -0500
committerRob Crittenden <rcritten@redhat.com>2011-02-02 10:00:38 -0500
commit275998f6bde90c253d935c2f2724538b64cbd618 (patch)
treebd2840606a906276d21e646eae47db49f7adb6c2 /install/tools/man/ipa-compliance.1
parentf3d04bfc405753b3c6a11a53ec6b2ccc99e8bf09 (diff)
downloadfreeipa-275998f6bde90c253d935c2f2724538b64cbd618.tar.gz
freeipa-275998f6bde90c253d935c2f2724538b64cbd618.tar.xz
freeipa-275998f6bde90c253d935c2f2724538b64cbd618.zip
Add support for tracking and counting entitlements
Adds a plugin, entitle, to register to the entitlement server, consume entitlements and to count and track them. It is also possible to import an entitlement certificate (if for example the remote entitlement server is unaviailable). This uses the candlepin server from https://fedorahosted.org/candlepin/wiki for entitlements. Add a cron job to validate the entitlement status and syslog the results. tickets 28, 79, 278
Diffstat (limited to 'install/tools/man/ipa-compliance.1')
-rw-r--r--install/tools/man/ipa-compliance.145
1 files changed, 45 insertions, 0 deletions
diff --git a/install/tools/man/ipa-compliance.1 b/install/tools/man/ipa-compliance.1
new file mode 100644
index 000000000..09ce02df8
--- /dev/null
+++ b/install/tools/man/ipa-compliance.1
@@ -0,0 +1,45 @@
+.\" A man page for ipa-compliance
+.\" Copyright (C) 2010 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-compliance" "1" "Dec 14 2010" "freeipa" ""
+.SH "NAME"
+ipa\-compliance \- Check entitlement compliance
+.SH "SYNOPSIS"
+ipa\-compliance [\fIOPTION\fR]
+.SH "DESCRIPTION"
+Verify that the IPA installation is in compliance with the number of client entitlements it has.
+
+Entitlements are managed using the ipa entitle command.
+
+An enrolled host is an machine that has a host keytab in the IPA system.
+
+The entitlements take the form of x509v3 certificates. The certificates are examined and the quantities summed. This is compared to the number of enrolled hosts to determine compliance.
+
+The command logs to syslog and if run from a tty will log to the terminal as well.
+
+The IPA server provides 25 entitlements of its own.
+.SH "OPTIONS"
+.TP
+\fB\-\-\-debug\fR
+Enable debugging output in the command
+.SH "EXIT STATUS"
+0 if the command was successful
+
+1 if an error occurred
+.SH "NOTES"
+Entitlements are not checked if the python\-rhsm package is not installed.