diff options
| author | Rob Crittenden <rcritten@redhat.com> | 2012-01-12 18:16:01 -0500 |
|---|---|---|
| committer | Rob Crittenden <rcritten@redhat.com> | 2012-01-12 05:46:09 -0500 |
| commit | 64b0855e875bfbaf394ea625fe9f79162e9afd45 (patch) | |
| tree | 1a15ff5f5c1007f42911d5d45acf9bcf7e2627c3 /ipalib/plugins | |
| parent | 485c3bb8973f53def52b0750da029be5b5221608 (diff) | |
| download | freeipa.git-64b0855e875bfbaf394ea625fe9f79162e9afd45.tar.gz freeipa.git-64b0855e875bfbaf394ea625fe9f79162e9afd45.tar.xz freeipa.git-64b0855e875bfbaf394ea625fe9f79162e9afd45.zip | |
Document the ping plugin.
https://fedorahosted.org/freeipa/ticket/1903
Diffstat (limited to 'ipalib/plugins')
| -rw-r--r-- | ipalib/plugins/ping.py | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/ipalib/plugins/ping.py b/ipalib/plugins/ping.py index 93c6495d..0da07e0b 100644 --- a/ipalib/plugins/ping.py +++ b/ipalib/plugins/ping.py @@ -24,7 +24,31 @@ from ipalib import _, ngettext from ipapython.version import VERSION, API_VERSION __doc__ = _(""" -Ping the remote IPA server +Ping the remote IPA server to ensure it is running. + +The ping command sends an echo request to an IPA server. The server +returns its version information. This is used by an IPA client +to confirm that the server is available and accepting requests. + +The server from xmlrpc_uri in /etc/ipa/default.conf is contacted first. +If it does not respond then the client will contact any servers defined +by ldap SRV records in DNS. + +EXAMPLES: + + Ping an IPA server: + ipa ping + ------------------------------------------ + IPA server version 2.1.9. API version 2.20 + ------------------------------------------ + + Ping an IPA server verbosely: + ipa -v ping + ipa: INFO: trying https://ipa.example.com/ipa/xml + ipa: INFO: Forwarding 'ping' to server u'https://ipa.example.com/ipa/xml' + ----------------------------------------------------- + IPA server version 2.1.9. API version 2.20 + ----------------------------------------------------- """) class ping(Command): |