summaryrefslogtreecommitdiffstats
path: root/install/tools
diff options
context:
space:
mode:
authorTomas Babej <tbabej@redhat.com>2013-06-10 14:43:24 +0200
committerMartin Kosek <mkosek@redhat.com>2013-07-17 13:49:59 +0200
commitc81849712f8888e6f12b7c2b7ebfcf5d2294addd (patch)
tree62a6975af7ea67686cc36c274da2431d8b720148 /install/tools
parent2a9be928556e58a69b7ce7a3b7f0aebd8f4c23bc (diff)
downloadfreeipa-c81849712f8888e6f12b7c2b7ebfcf5d2294addd.tar.gz
freeipa-c81849712f8888e6f12b7c2b7ebfcf5d2294addd.tar.xz
freeipa-c81849712f8888e6f12b7c2b7ebfcf5d2294addd.zip
Provide ipa-advise tool
Provides a pluggable framework for generating configuration scriptlets and instructions for various machine setups and use cases. Creates a new ipa-advise command, available to root user on the IPA server. Also provides an example configuration plugin, config-fedora-authconfig. https://fedorahosted.org/freeipa/ticket/3670
Diffstat (limited to 'install/tools')
-rw-r--r--install/tools/Makefile.am1
-rwxr-xr-xinstall/tools/ipa-advise23
-rw-r--r--install/tools/man/Makefile.am1
-rw-r--r--install/tools/man/ipa-advise.144
4 files changed, 69 insertions, 0 deletions
diff --git a/install/tools/Makefile.am b/install/tools/Makefile.am
index 659ce0a87..2cf66c6df 100644
--- a/install/tools/Makefile.am
+++ b/install/tools/Makefile.am
@@ -23,6 +23,7 @@ sbin_SCRIPTS = \
ipa-upgradeconfig \
ipa-backup \
ipa-restore \
+ ipa-advise \
$(NULL)
EXTRA_DIST = \
diff --git a/install/tools/ipa-advise b/install/tools/ipa-advise
new file mode 100755
index 000000000..4ec3c48c7
--- /dev/null
+++ b/install/tools/ipa-advise
@@ -0,0 +1,23 @@
+#! /usr/bin/python -E
+# Authors: Tomas Babej <tbabej@redhat.com>
+#
+# Copyright (C) 2013 Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+from ipaserver.advise.base import IpaAdvise
+
+IpaAdvise.run_cli()
diff --git a/install/tools/man/Makefile.am b/install/tools/man/Makefile.am
index b16d2b5c7..33e8a9e4b 100644
--- a/install/tools/man/Makefile.am
+++ b/install/tools/man/Makefile.am
@@ -21,6 +21,7 @@ man1_MANS = \
ipa-managed-entries.1 \
ipa-backup.1 \
ipa-restore.1 \
+ ipa-advise.1 \
$(NULL)
man8_MANS = \
diff --git a/install/tools/man/ipa-advise.1 b/install/tools/man/ipa-advise.1
new file mode 100644
index 000000000..4c494aab9
--- /dev/null
+++ b/install/tools/man/ipa-advise.1
@@ -0,0 +1,44 @@
+.\" A man page for ipa-advise
+.\" Copyright (C) 2013 Red Hat, Inc.
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" 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 General Public License
+.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
+.\"
+.\" Author: Tomas Babej <tbabej@redhat.com>
+.\"
+.TH "ipa-advise" "1" "Jun 10 2013" "FreeIPA" "FreeIPA Manual Pages"
+.SH "NAME"
+ipa\-advise \- Provide configurations advice for various use cases.
+.SH "SYNOPSIS"
+ipa\-advise ADVICE
+.SH "DESCRIPTION"
+Provides customized advice for various IPA configuration issues.
+.TP
+For the list of possible ADVICEs available, run the ipa\-advise with no arguments.
+.SH "OPTIONS"
+.TP
+\fB\-\-v\fR, \fB\-\-verbose\fR
+Print debugging information
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Alias for \-\-verbose
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Output only errors
+.TP
+\fB\-\-log\-file\fR=\fIFILE\fR
+Log to the given file
+.SH "EXIT STATUS"
+0 if the command was successful
+
+1 if an error occurred \ No newline at end of file