{ "info": { "author": "Rob McBroom", "author_email": "pypi@skurfer.com", "bugtrack_url": null, "classifiers": [], "description": "====================\nXymon Python Library\n====================\n\nThis library allows basic communication with a Xymon server directly from a Python script. It works with Python 2.6, 2.7, and 3. It can be used on a system with no Xymon client installed.\n\nSome basic examples are shown here. See ``help(Xymon)`` for details.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n $ pip install Xymon\n\nGetting Started\n---------------\n\nGet an instance of the ``Xymon`` class to talk to the server.\n\n.. code-block:: pycon\n\n >>> from xymon import Xymon\n >>> server = Xymon('xymon.domain.tld', 1984)\n\nThe server name and port number are optional. The server name will default to the ``$XYMSRV`` environment variable if your script is being run by a Xymon client, or ``localhost`` if the variable isn't set. The port defaults to ``1984``.\n\nReporting\n---------\n\nReport a status to the server:\n\n.. code-block:: pycon\n\n >>> server.report('webserver01', 'https', 'yellow', 'slow HTTP response')\n\nQuerying\n--------\n\nGetting status data:\n\n.. code-block:: pycon\n\n >>> server.appfeed(host='ldap.*', test='ldaps')\n {'ldap01':\n {'ldaps':\n {'status': 'green',\n 'changed': 1396294952,\n 'time': 1396462829,\n 'url': 'https://xymon.domain.tld/xymon-cgi/svcstatus.sh?HOST=ldap01&SERVICE=ldaps',\n 'summary': 'green Wed Apr 2 14:19:56 2014 ldaps ok '}\n },\n 'ldap02':\n {'ldaps':\n {'status': 'green',\n 'changed': 1396294952,\n 'time': 1396462829,\n 'url': 'https://xymon.domain.tld/xymon-cgi/svcstatus.sh?HOST=ldap02&SERVICE=ldaps',\n 'summary': 'green Wed Apr 2 14:19:56 2014 ldaps ok '}\n }\n }\n\nThis communicates with the server using its ``appfeed.cgi`` interface. If called with no arguments, ``appfeed()`` will return data for all tests on all hosts. Results can be limited by host, test, page, and color.\n\nNote that ``host`` can be a pattern as described in `Xymon's documentation`_.\n\nTo just get the status of a single service on a single host as a string, use ``status()``:\n\n.. code-block:: pycon\n\n >>> server.status('ldap01', 'ldaps')\n 'green'\n\nIf you want data for more than one host/test, it's probably more efficient to get all the data using ``appfeed()`` and pull out what you want.\n\n.. _Xymon's Documentation: http://www.xymon.com/xymon/help/manpages/man1/appfeed.cgi.1.html\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/skurfer/python-xymon", "keywords": "", "license": "Don\u2019t Be a Dick", "maintainer": "", "maintainer_email": "", "name": "Xymon", "package_url": "https://pypi.org/project/Xymon/", "platform": "", "project_url": "https://pypi.org/project/Xymon/", "project_urls": { "Homepage": "https://github.com/skurfer/python-xymon" }, "release_url": "https://pypi.org/project/Xymon/2.0.0/", "requires_dist": null, "requires_python": "", "summary": "Update and query statuses on a Xymon server", "version": "2.0.0" }, "last_serial": 4237659, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "85904bc1741b50e2728b6a7f849b1d0f", "sha256": "7ebe92f1e2fc5520335056e6e93eb61fbb3498ffd8e7f5983d889155a3015c83" }, "downloads": -1, "filename": "Xymon-1.0.0.tar.gz", "has_sig": false, "md5_digest": "85904bc1741b50e2728b6a7f849b1d0f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4794, "upload_time": "2014-04-02T20:15:06", "url": "https://files.pythonhosted.org/packages/64/df/d1e69202a513468ee6eb2341a4af95d01c5b8239b0711c000d369cfa5815/Xymon-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "70248baa2b99f08ea60490d621ee558d", "sha256": "2ec986402ed2c69127c2a50ef6bc10aa6f4535f51cca8497258d4ec411117fbd" }, "downloads": -1, "filename": "Xymon-1.1.0.tar.gz", "has_sig": false, "md5_digest": "70248baa2b99f08ea60490d621ee558d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4917, "upload_time": "2014-05-28T18:41:18", "url": "https://files.pythonhosted.org/packages/2d/d9/dbbeb081fbc9c698885ba139bea898e01cd9df7fb5737b3f8bdfd7899580/Xymon-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "579a9e1a9becc18bec263ce98fde8527", "sha256": "b7a7cf5363088d757e8a8dc393730376111ce6f3dacc80a0acbc45ff2ef1ddb3" }, "downloads": -1, "filename": "Xymon-1.2.0.tar.gz", "has_sig": false, "md5_digest": "579a9e1a9becc18bec263ce98fde8527", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4944, "upload_time": "2018-07-18T11:40:42", "url": "https://files.pythonhosted.org/packages/c3/7f/5abe7ec4ea3ae167a1f53af2fd68e6f41bc4aca09fb6488c229f039e2902/Xymon-1.2.0.tar.gz" } ], "2.0.0": [ { "comment_text": "", "digests": { "md5": "fb0abf9b0c19cf5d78922a9c3462570e", "sha256": "d1af55240f3f2f2c7ca3c79b21b467e8795ea9b715ca84dc4cb6375136b382fe" }, "downloads": -1, "filename": "Xymon-2.0.0.tar.gz", "has_sig": false, "md5_digest": "fb0abf9b0c19cf5d78922a9c3462570e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4925, "upload_time": "2018-09-04T13:24:25", "url": "https://files.pythonhosted.org/packages/ab/04/4d6712dff912d3b32c1f939c7499a47743e2502835401d68f7db4b6d461c/Xymon-2.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fb0abf9b0c19cf5d78922a9c3462570e", "sha256": "d1af55240f3f2f2c7ca3c79b21b467e8795ea9b715ca84dc4cb6375136b382fe" }, "downloads": -1, "filename": "Xymon-2.0.0.tar.gz", "has_sig": false, "md5_digest": "fb0abf9b0c19cf5d78922a9c3462570e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4925, "upload_time": "2018-09-04T13:24:25", "url": "https://files.pythonhosted.org/packages/ab/04/4d6712dff912d3b32c1f939c7499a47743e2502835401d68f7db4b6d461c/Xymon-2.0.0.tar.gz" } ] }