From 6da63e3be44033d7d623a574787937ab4ec9ed0a Mon Sep 17 00:00:00 2001 From: Fraser Tweedale Date: Thu, 2 Jul 2020 12:31:13 +1000 Subject: [PATCH] ca plugin: improve doc Update 'ca' plugin doc to mention which permissions are required for the various commands. Also mention that CAs must first be disabled before they can be deleted. Part of: https://fedorahosted.org/freeipa/ticket/5011 Reviewed-By: Rob Crittenden --- ipaserver/plugins/ca.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/ipaserver/plugins/ca.py b/ipaserver/plugins/ca.py index ffae70ae7..8367605ff 100644 --- a/ipaserver/plugins/ca.py +++ b/ipaserver/plugins/ca.py @@ -35,20 +35,22 @@ certificate to be revoked and its private key deleted. """) + _(""" EXAMPLES: """) + _(""" - Create new CA, subordinate to the IPA CA. + Create new CA, subordinate to the IPA CA (requires permission + "System: Add CA"): ipa ca-add puppet --desc "Puppet" \\ --subject "CN=Puppet CA,O=EXAMPLE.COM" """) + _(""" - Disable a CA. + Disable a CA (requires permission "System: Modify CA"): ipa ca-disable puppet """) + _(""" - Re-enable a CA. + Re-enable a CA (requires permission "System: Modify CA"): ipa ca-enable puppet """) + _(""" - Delete a CA. + Delete a CA (requires permission "System: Delete CA"; also requires + CA to be disabled first): ipa ca-del puppet """) @@ -321,7 +323,7 @@ class ca_add(LDAPCreate): @register() class ca_del(LDAPDelete): - __doc__ = _('Delete a CA.') + __doc__ = _('Delete a CA (must be disabled first).') msg_summary = _('Deleted CA "%(value)s"')