summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/krbtpolicy.py
diff options
context:
space:
mode:
authorRob Crittenden <rcritten@redhat.com>2010-06-02 14:08:50 -0400
committerRob Crittenden <rcritten@redhat.com>2010-06-22 13:58:04 -0400
commit901ccc1393a7e494f7b1b64eaeb2f7809056aafa (patch)
treeb9523a814ed72e08ac286134bb45cf07e6e053f4 /ipalib/plugins/krbtpolicy.py
parent8c6c93125f344ca117cc24b2e96c55b1d9ae31bd (diff)
downloadfreeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.tar.gz
freeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.tar.xz
freeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.zip
First pass at per-command documentation
Diffstat (limited to 'ipalib/plugins/krbtpolicy.py')
-rw-r--r--ipalib/plugins/krbtpolicy.py19
1 files changed, 17 insertions, 2 deletions
diff --git a/ipalib/plugins/krbtpolicy.py b/ipalib/plugins/krbtpolicy.py
index 3f9eeee68..2c797fd13 100644
--- a/ipalib/plugins/krbtpolicy.py
+++ b/ipalib/plugins/krbtpolicy.py
@@ -18,6 +18,21 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
Kerberos ticket policy
+
+There is a single kerberos ticket policy. This policy defines the
+maximum ticket lifetime (maximum life of a ticket) and maximum renewal
+age, the period during which the ticket is renewable.
+
+EXAMPLES:
+
+ Display the current policy:
+ ipa krbtpolicy-show
+
+ Reset the policy to the default:
+ ipa krbtpolicy-reset
+
+ Modify the policy to 8 hours max life, 1-day max renewal:
+ ipa krbtpolicy-mod --maxlife=28800 --maxrenew=86400
"""
from ipalib import api
@@ -51,12 +66,12 @@ class krbtpolicy(LDAPObject):
Int('krbmaxticketlife?',
cli_name='maxlife',
label=_('Max life'),
- doc=_('Maximum ticket life'),
+ doc=_('Maximum ticket life (seconds)'),
),
Int('krbmaxrenewableage?',
cli_name='maxrenew',
label=_('Max renew'),
- doc=_('Maximum renewable age'),
+ doc=_('Maximum renewable age (seconds)'),
),
)