Add some documentation to the ping plugin. rob
>From c9cc066698f298f3495082d06198e037a28e18e0 Mon Sep 17 00:00:00 2001 From: Rob Crittenden <rcrit...@redhat.com> Date: Thu, 12 Jan 2012 18:16:01 -0500 Subject: [PATCH] Document the ping plugin.
https://fedorahosted.org/freeipa/ticket/1903 --- 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 93c6495..0da07e0 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): -- 1.7.6
_______________________________________________ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel
