summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins
diff options
context:
space:
mode:
authorPetr Viktorin <pviktori@redhat.com>2014-06-09 20:10:19 +0200
committerMartin Kosek <mkosek@redhat.com>2014-06-10 13:19:32 +0200
commite3b20b9d03f08b889474ef94aef11b31723fdf53 (patch)
tree20c9d187043c8f03eff55e86e1e563ee903d72f3 /ipalib/plugins
parentb0a61ab9530d96a56ff0b10e66a742c18ca90c4a (diff)
downloadfreeipa-e3b20b9d03f08b889474ef94aef11b31723fdf53.tar.gz
freeipa-e3b20b9d03f08b889474ef94aef11b31723fdf53.tar.xz
freeipa-e3b20b9d03f08b889474ef94aef11b31723fdf53.zip
Split long docstrings that were recently modified
When the strings are changed again, translators will only need to re-translate the modified parts. See: https://fedorahosted.org/freeipa/ticket/3587 Reviewed-By: Martin Kosek <mkosek@redhat.com>
Diffstat (limited to 'ipalib/plugins')
-rw-r--r--ipalib/plugins/automember.py50
-rw-r--r--ipalib/plugins/otptoken.py14
-rw-r--r--ipalib/plugins/radiusproxy.py16
-rw-r--r--ipalib/plugins/sudorule.py24
4 files changed, 52 insertions, 52 deletions
diff --git a/ipalib/plugins/automember.py b/ipalib/plugins/automember.py
index 143c6a80c..ddcd5210c 100644
--- a/ipalib/plugins/automember.py
+++ b/ipalib/plugins/automember.py
@@ -29,48 +29,48 @@ from ipapython.dn import DN
__doc__ = _("""
Auto Membership Rule.
-
+""") + _("""
Bring clarity to the membership of hosts and users by configuring inclusive
or exclusive regex patterns, you can automatically assign a new entries into
a group or hostgroup based upon attribute information.
-
+""") + _("""
A rule is directly associated with a group by name, so you cannot create
a rule without an accompanying group or hostgroup.
-
+""") + _("""
A condition is a regular expression used by 389-ds to match a new incoming
entry with an automember rule. If it matches an inclusive rule then the
entry is added to the appropriate group or hostgroup.
-
+""") + _("""
A default group or hostgroup could be specified for entries that do not
match any rule. In case of user entries this group will be a fallback group
because all users are by default members of group specified in IPA config.
-
+""") + _("""
The automember-rebuild command can be used to retroactively run automember rules
against existing entries, thus rebuilding their membership.
-
+""") + _("""
EXAMPLES:
-
+""") + _("""
Add the initial group or hostgroup:
ipa hostgroup-add --desc="Web Servers" webservers
ipa group-add --desc="Developers" devel
-
+""") + _("""
Add the initial rule:
ipa automember-add --type=hostgroup webservers
ipa automember-add --type=group devel
-
+""") + _("""
Add a condition to the rule:
ipa automember-add-condition --key=fqdn --type=hostgroup --inclusive-regex=^web[1-9]+\.example\.com webservers
ipa automember-add-condition --key=manager --type=group --inclusive-regex=^uid=mscott devel
-
+""") + _("""
Add an exclusive condition to the rule to prevent auto assignment:
ipa automember-add-condition --key=fqdn --type=hostgroup --exclusive-regex=^web5\.example\.com webservers
-
+""") + _("""
Add a host:
ipa host-add web1.example.com
-
+""") + _("""
Add a user:
ipa user-add --first=Tim --last=User --password tuser1 --manager=mscott
-
+""") + _("""
Verify automembership:
ipa hostgroup-show webservers
Host-group: webservers
@@ -82,45 +82,45 @@ EXAMPLES:
Description: Developers
GID: 1004200000
Member users: tuser
-
+""") + _("""
Remove a condition from the rule:
ipa automember-remove-condition --key=fqdn --type=hostgroup --inclusive-regex=^web[1-9]+\.example\.com webservers
-
+""") + _("""
Modify the automember rule:
ipa automember-mod
-
+""") + _("""
Set the default (fallback) target group:
ipa automember-default-group-set --default-group=webservers --type=hostgroup
ipa automember-default-group-set --default-group=ipausers --type=group
-
+""") + _("""
Remove the default (fallback) target group:
ipa automember-default-group-remove --type=hostgroup
ipa automember-default-group-remove --type=group
-
+""") + _("""
Show the default (fallback) target group:
ipa automember-default-group-show --type=hostgroup
ipa automember-default-group-show --type=group
-
+""") + _("""
Find all of the automember rules:
ipa automember-find
-
+""") + _("""
Display a automember rule:
ipa automember-show --type=hostgroup webservers
ipa automember-show --type=group devel
-
+""") + _("""
Delete an automember rule:
ipa automember-del --type=hostgroup webservers
ipa automember-del --type=group devel
-
+""") + _("""
Rebuild membership for all users:
ipa automember-rebuild --type=group
-
+""") + _("""
Rebuild membership for all hosts:
ipa automember-rebuild --type=hostgroup
-
+""") + _("""
Rebuild membership for specified users:
ipa automember-rebuild --users=tuser1 --users=tuser2
-
+""") + _("""
Rebuild membership for specified hosts:
ipa automember-rebuild --hosts=web1.example.com --hosts=web2.example.com
""")
diff --git a/ipalib/plugins/otptoken.py b/ipalib/plugins/otptoken.py
index b264287c3..17644e0f1 100644
--- a/ipalib/plugins/otptoken.py
+++ b/ipalib/plugins/otptoken.py
@@ -30,23 +30,23 @@ import qrcode
__doc__ = _("""
OTP Tokens
-
+""") + _("""
Manage OTP tokens.
-
+""") + _("""
IPA supports the use of OTP tokens for multi-factor authentication. This
code enables the management of OTP tokens.
-
+""") + _("""
EXAMPLES:
-
+""") + _("""
Add a new token:
ipa otptoken-add --type=totp --owner=jdoe --desc="My soft token"
-
+""") + _("""
Examine the token:
ipa otptoken-show a93db710-a31a-4639-8647-f15b2c70b78a
-
+""") + _("""
Change the vendor:
ipa otptoken-mod a93db710-a31a-4639-8647-f15b2c70b78a --vendor="Red Hat"
-
+""") + _("""
Delete a token:
ipa otptoken-del a93db710-a31a-4639-8647-f15b2c70b78a
""")
diff --git a/ipalib/plugins/radiusproxy.py b/ipalib/plugins/radiusproxy.py
index 4d143c4bf..5d8f3a727 100644
--- a/ipalib/plugins/radiusproxy.py
+++ b/ipalib/plugins/radiusproxy.py
@@ -26,27 +26,27 @@ import re
__doc__ = _("""
RADIUS Proxy Servers
-
+""") + _("""
Manage RADIUS Proxy Servers.
-
+""") + _("""
IPA supports the use of an external RADIUS proxy server for krb5 OTP
authentications. This permits a great deal of flexibility when
integrating with third-party authentication services.
-
+""") + _("""
EXAMPLES:
-
+""") + _("""
Add a new server:
ipa radiusproxy-add MyRADIUS --server=radius.example.com:1812
-
+""") + _("""
Find all servers whose entries include the string "example.com":
ipa radiusproxy-find example.com
-
+""") + _("""
Examine the configuration:
ipa radiusproxy-show MyRADIUS
-
+""") + _("""
Change the secret:
ipa radiusproxy-mod MyRADIUS --secret
-
+""") + _("""
Delete a configuration:
ipa radiusproxy-del MyRADIUS
""")
diff --git a/ipalib/plugins/sudorule.py b/ipalib/plugins/sudorule.py
index 5520a37ee..09b9a97e5 100644
--- a/ipalib/plugins/sudorule.py
+++ b/ipalib/plugins/sudorule.py
@@ -25,12 +25,12 @@ from ipalib import _, ngettext
__doc__ = _("""
Sudo Rules
-
+""") + _("""
Sudo (su "do") allows a system administrator to delegate authority to
give certain users (or groups of users) the ability to run some (or all)
commands as root or another user while providing an audit trail of the
commands and their arguments.
-
+""") + _("""
FreeIPA provides a means to configure the various aspects of Sudo:
Users: The user(s)/group(s) allowed to invoke Sudo.
Hosts: The host(s)/hostgroup(s) which the user is allowed to to invoke Sudo.
@@ -39,37 +39,37 @@ FreeIPA provides a means to configure the various aspects of Sudo:
RunAsUser: The user(s) or group(s) of users whose rights Sudo will be invoked with.
RunAsGroup: The group(s) whose gid rights Sudo will be invoked with.
Options: The various Sudoers Options that can modify Sudo's behavior.
-
+""") + _("""
An order can be added to a sudorule to control the order in which they
are evaluated (if the client supports it). This order is an integer and
must be unique.
-
+""") + _("""
FreeIPA provides a designated binddn to use with Sudo located at:
uid=sudo,cn=sysaccounts,cn=etc,dc=example,dc=com
-
+""") + _("""
To enable the binddn run the following command to set the password:
LDAPTLS_CACERT=/etc/ipa/ca.crt /usr/bin/ldappasswd -S -W \
-h ipa.example.com -ZZ -D "cn=Directory Manager" \
uid=sudo,cn=sysaccounts,cn=etc,dc=example,dc=com
-
+""") + _("""
EXAMPLES:
-
+""") + _("""
Create a new rule:
ipa sudorule-add readfiles
-
+""") + _("""
Add sudo command object and add it as allowed command in the rule:
ipa sudocmd-add /usr/bin/less
ipa sudorule-add-allow-command readfiles --sudocmds /usr/bin/less
-
+""") + _("""
Add a host to the rule:
ipa sudorule-add-host readfiles --hosts server.example.com
-
+""") + _("""
Add a user to the rule:
ipa sudorule-add-user readfiles --users jsmith
-
+""") + _("""
Add a special Sudo rule for default Sudo server configuration:
ipa sudorule-add defaults
-
+""") + _("""
Set a default Sudo option:
ipa sudorule-add-option defaults --sudooption '!authenticate'
""")