From ed21787190382707f9d80559967f71637c8bf408 Mon Sep 17 00:00:00 2001 From: Rob Crittenden Date: Tue, 26 Jan 2021 16:27:57 -0500 Subject: [PATCH] Add exit status to the ipactl man page The existing return codes were undocumented but basically followed the LSB. Document those along with the new options for status. https://pagure.io/freeipa/issue/8550 Signed-off-by: Rob Crittenden Reviewed-By: Florence Blanc-Renaud --- install/tools/man/ipactl.8 | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/install/tools/man/ipactl.8 b/install/tools/man/ipactl.8 index d7aaaf8ed..8fdc09632 100644 --- a/install/tools/man/ipactl.8 +++ b/install/tools/man/ipactl.8 @@ -52,3 +52,30 @@ If any service start fails, do not rollback the services, continue with the oper .TP \fB\-f\fR, \fB\-\-force\fR Force IPA to start. Combine options --skip-version-check and --ignore-service-failures +.SH "EXIT STATUS" + +All actions except status: + +0 success + +1 a generic error occurred + +2 unknown or invalid argument(s) + +4 user has insufficient privilege + +6 IPA server is not configured + +For the status action: + +0 service is running + +3 service is not running + +4 service status is unknown (or unconfigured) + +If not executed as root then the status action will return 4 for +insufficient privileges. + +Some services are socket activated and may show as STOPPED by the status +action. These services include ipa-ods-exporter and ipa-otpd.