{ "info": { "author": "Gregory CUGAT", "author_email": "gregory.cugat@efficientip.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "[![License](https://img.shields.io/badge/License-BSD%202--Clause-blue.svg)](https://opensource.org/licenses/BSD-2-Clause)\n\n[![Python 3](https://pyup.io/repos/github/gregocgt/SOLIDserverRest/python-3-shield.svg)](https://pyup.io/repos/github/gregocgt/SOLIDserverRest/)\n[![Updates](https://pyup.io/repos/github/gregocgt/SOLIDserverRest/shield.svg)](https://pyup.io/repos/github/gregocgt/SOLIDserverRest/)\n[![pipeline status](https://gitlab.com/efficientip/solidserverrest/badges/master/pipeline.svg)](https://gitlab.com/efficientip/solidserverrest/commits/master)\n[![coverage report](https://gitlab.com/efficientip/solidserverrest/badges/master/coverage.svg)](https://codecov.io/gl/efficientip/solidserverrest)\n[![Documentation Status](https://readthedocs.org/projects/solidserverrest/badge/?version=latest)](https://solidserverrest.readthedocs.io/en/latest/?badge=latest)\n\n# SOLIDserverRest\n\nThis 'SOLIDserverRest' allows to easily interact with [SOLIDserver](https://www.efficientip.com/products/solidserver/)'s REST API.\nIt allows managing all IPAM objects through CRUD operations.\n\n* ***Free software***: BSD2 License\n\nThis 'SOLIDserverRest' is compatible with [SOLIDserver](https://www.efficientip.com/products/solidserver/) version 6.0.1P3 and higher.\n\n# Install\nInstall 'SOLIDserverRest' using pip in your virtualenv:\n\n```\n\tpip install SOLIDserverRest\n```\n\n# Usage\n## Using the SOLIDserverRest object\n\n### 1. Declare endpoint API point\nSet the API endpoint you want to talk with through API. Could use an IP address\n(v4 or v6) or a host name\n* host = IP address of the SOLIDserver server\n```\ncon = SOLIDserverRest(\"fqdn_host.org\")\n```\n\n### 2. Specify connection method\nYou can use native connection mode using SOLIDserver default method which provide \nauthentication through headers in the requests with information\nencoded in base64\n\n* user = user who want to use\n* password = password of the user\n\n```python\n\tcon.use_native_ssd(user=\"apiuser\", password=\"apipwd\")\n```\n\nYou can also use the basic authentication method for connecting the SOLIDserver.\n\n* user = user who want to use\n* password = password of the user\n\n```python\n\tcon.use_basicauth_ssd(user=\"apiuser\", password=\"apipwd\")\n```\n\n### 3. Request to SOLIDserver API\n\nYou need parameters:\n* method = choose your method in the list below\n* parameters = Python dico with parameters you want to use\n\nSSL certificate chain is validated by default, to disable it, use the set_ssl_verify method\n\n```python\n con.set_ssl_verify(False) # True by default\n\trest_answer = con.query(\"method\", \"parameters\")\n```\n\n### 4. Analyze answer\n\n* rest_answer => object name\n* rest_answer.status_code => current http answer code set in the object\n* rest_answer.content => Answer core from SOLIDserver API set in the object\n\nExample:\n```python\n\tprint(rest_answer)\n\tprint(rest_answer.status_code)\n\tprint(rest_answer.content)\n```\n\n# Methods that could be used\nMethods are organized to match the ontology used in SOLIDServer, you will find:\n* Sites - address spaces\n* Subnets (v4 and v6)\n* Pools (v4 and v6)\n* Addresses (v4 and v6)\n* Aliases (v4 and v6)\n\nMore information about supported methods in the [specific document](docs/METHODS.md)\n\n## Supported SOLIDserver modules in methods are:\n* ip (IPAM - IP Address Management)\n* app (Application and GSLB management) - starting with release 7.1 of SOLIDserver\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/efficientip/solidserverrest", "keywords": "", "license": "BSD 2", "maintainer": "", "maintainer_email": "", "name": "SOLIDserverRest", "package_url": "https://pypi.org/project/SOLIDserverRest/", "platform": "", "project_url": "https://pypi.org/project/SOLIDserverRest/", "project_urls": { "Homepage": "https://gitlab.com/efficientip/solidserverrest" }, "release_url": "https://pypi.org/project/SOLIDserverRest/1.7.2/", "requires_dist": null, "requires_python": ">=2.7", "summary": "The SOLIDserverRest is a library to drive EfficientIP API", "version": "1.7.2" }, "last_serial": 5741445, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "a878487f6167ee6ebcf8f81d6a33afab", "sha256": "c83b2a01ba6ddfeec31da496e5f956508cb0bf98cfeebad0994c61f55fb744c6" }, "downloads": -1, "filename": "SOLIDserverRest-1.0.tar.gz", "has_sig": false, "md5_digest": "a878487f6167ee6ebcf8f81d6a33afab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8039, "upload_time": "2019-02-20T16:23:02", "url": "https://files.pythonhosted.org/packages/e9/03/480826b368b1c152a78f305c8f62461ffe1faf4d00b00242d1df3509bc01/SOLIDserverRest-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "0d06c6f6bbe6d100f6600a330fdb2d0e", "sha256": "4e40f7d6a0cf409d9a7dd0e1150569e93477fc1438d93f4a0200ba09eb964956" }, "downloads": -1, "filename": "SOLIDserverRest-1.1.tar.gz", "has_sig": false, "md5_digest": "0d06c6f6bbe6d100f6600a330fdb2d0e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8159, "upload_time": "2019-02-21T08:55:11", "url": "https://files.pythonhosted.org/packages/6d/38/ae84d7b320f4d647eb91a18dd31f86c8dc3fdc4bba2569887f49b7fc9f62/SOLIDserverRest-1.1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "11395a845bdcd4aaad8b5e81c943ebb5", "sha256": "57ed8f525a979b102ce1a818d720305863fb6e4bc3b539b1eac78ee0afcb3baa" }, "downloads": -1, "filename": "SOLIDserverRest-1.2.tar.gz", "has_sig": false, "md5_digest": "11395a845bdcd4aaad8b5e81c943ebb5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7937, "upload_time": "2019-02-21T14:58:30", "url": "https://files.pythonhosted.org/packages/84/68/448ae7b20c5391f0742c61d639ef4a9aac9b537fe731b97007fccb7798c2/SOLIDserverRest-1.2.tar.gz" } ], "1.3": [ { "comment_text": "", "digests": { "md5": "642e23001eb1c0a45de8d0e321afccc5", "sha256": "0d6aa1d35b31bdbcab8d58c6e1aa141c9b6b164b410c2c87afab220ee3f00658" }, "downloads": -1, "filename": "SOLIDserverRest-1.3.tar.gz", "has_sig": false, "md5_digest": "642e23001eb1c0a45de8d0e321afccc5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18357, "upload_time": "2019-02-22T14:27:17", "url": "https://files.pythonhosted.org/packages/9f/71/9a33d0bf99bd560807f84fa1b89b63219d9715138d32c485189c41aa3e3c/SOLIDserverRest-1.3.tar.gz" } ], "1.4": [ { "comment_text": "", "digests": { "md5": "5b5cf4c27fad1b25d2e6bca027795b1b", "sha256": "539a58c7559dd80ddc31b1544cb80b91db03ce9a0dcf71cb7b17b668b80bd47a" }, "downloads": -1, "filename": "SOLIDserverRest-1.4.tar.gz", "has_sig": false, "md5_digest": "5b5cf4c27fad1b25d2e6bca027795b1b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 18561, "upload_time": "2019-02-22T14:36:27", "url": "https://files.pythonhosted.org/packages/4b/2e/9337908161cea9bc336c2c52f90389a7bb99cba1968829a9359973f42b20/SOLIDserverRest-1.4.tar.gz" } ], "1.5": [ { "comment_text": "", "digests": { "md5": "d43016cff9cf0aa93707bff5a2a25bd4", "sha256": "3c3a200ed5043ea643ef891dc9facaea95c3986c20228ca7927ff2b8381a7dc1" }, "downloads": -1, "filename": "SOLIDserverRest-1.5.tar.gz", "has_sig": false, "md5_digest": "d43016cff9cf0aa93707bff5a2a25bd4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 18543, "upload_time": "2019-02-22T15:00:29", "url": "https://files.pythonhosted.org/packages/e2/d7/e19daceee125c00662833e3f064133100ac1bdc2b5217fd4cc713a36dce2/SOLIDserverRest-1.5.tar.gz" } ], "1.5.1": [ { "comment_text": "", "digests": { "md5": "7ea3df6622444c13fb9080499adbf769", "sha256": "66dcfac09287db4d6116ae3ccbaa921477dd7d445e7aa9ce40025f0adf71aed0" }, "downloads": -1, "filename": "SOLIDserverRest-1.5.1.tar.gz", "has_sig": false, "md5_digest": "7ea3df6622444c13fb9080499adbf769", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 5160, "upload_time": "2019-02-26T12:17:08", "url": "https://files.pythonhosted.org/packages/3b/07/a881117781949509c2bb66231013690702ef491322f37e8277ce532ad9ed/SOLIDserverRest-1.5.1.tar.gz" } ], "1.6.1": [ { "comment_text": "", "digests": { "md5": "864a9d77a228187c618b04bd1c7322f1", "sha256": "e4a51164f07ae629de536f83da7d44d41f44c2a70da37f258f1f12238f65b7af" }, "downloads": -1, "filename": "SOLIDserverRest-1.6.1.tar.gz", "has_sig": false, "md5_digest": "864a9d77a228187c618b04bd1c7322f1", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 5282, "upload_time": "2019-05-21T09:00:33", "url": "https://files.pythonhosted.org/packages/fa/88/8254cd6c5f1d73aa9615c1b2ae000e1bdcaa497db544efcb89e4e72439b4/SOLIDserverRest-1.6.1.tar.gz" } ], "1.6.2": [ { "comment_text": "", "digests": { "md5": "c7967f6259ae61dd23ffa40451304294", "sha256": "fb5ff6b0ba8044b031268da9b803b5e6757637741daab4d33272fcef13c53fad" }, "downloads": -1, "filename": "SOLIDserverRest-1.6.2-py3-none-any.whl", "has_sig": false, "md5_digest": "c7967f6259ae61dd23ffa40451304294", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 8665, "upload_time": "2019-07-26T12:10:15", "url": "https://files.pythonhosted.org/packages/fd/21/628372a1cdbd082f4593dffb5268a73e32582797b46a63d24842d35a0453/SOLIDserverRest-1.6.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "75f371e1d8c213e50e4b49734b892cec", "sha256": "73e3bf99eab3eeb101663ccc11a71745dbc85056cf0db27cc075301f6f59b7b4" }, "downloads": -1, "filename": "SOLIDserverRest-1.6.2.tar.gz", "has_sig": false, "md5_digest": "75f371e1d8c213e50e4b49734b892cec", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 6499, "upload_time": "2019-07-26T12:10:19", "url": "https://files.pythonhosted.org/packages/94/c1/1a4d4cd7d8c078c5277117dd6592062dcdb934c03ee168235c210ceb9d18/SOLIDserverRest-1.6.2.tar.gz" } ], "1.7.1": [ { "comment_text": "", "digests": { "md5": "046c0928bccf77b4d7706283fc7afb54", "sha256": "c72c66df07921460264662231dfe79500f7e060f59fde8313de5ff22a4b2ffc0" }, "downloads": -1, "filename": "SOLIDserverRest-1.7.1-py3-none-any.whl", "has_sig": false, "md5_digest": "046c0928bccf77b4d7706283fc7afb54", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 8647, "upload_time": "2019-07-26T12:10:16", "url": "https://files.pythonhosted.org/packages/08/b7/d1b504d29f0db76d0b705188b0023e0f19f97df87aceb77d796c17862413/SOLIDserverRest-1.7.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "891cf585506ecfefe75a5abbcdd82962", "sha256": "12ca8ca97a48ec8c6c362d39d9b270099c1d9b780ee99d2b7e8a7723374f9372" }, "downloads": -1, "filename": "SOLIDserverRest-1.7.1.tar.gz", "has_sig": false, "md5_digest": "891cf585506ecfefe75a5abbcdd82962", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 6486, "upload_time": "2019-07-26T12:10:20", "url": "https://files.pythonhosted.org/packages/af/db/200be1ae49a92b1a368fe833080ae55a10dadf026545d73804d304135740/SOLIDserverRest-1.7.1.tar.gz" } ], "1.7.2": [ { "comment_text": "", "digests": { "md5": "1178f70388f2b66608c10e3851fd8aee", "sha256": "c4b43dbdf4ecc43d5dae8a03f1f1e0127b57fb1ed66cacf70f7dbbdb54887c54" }, "downloads": -1, "filename": "SOLIDserverRest-1.7.2-py3-none-any.whl", "has_sig": false, "md5_digest": "1178f70388f2b66608c10e3851fd8aee", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 9002, "upload_time": "2019-08-28T09:01:25", "url": "https://files.pythonhosted.org/packages/3f/c6/55b8205f60a7736a4b1e1891a2437c7a4a33e585537e08ee24022518c87c/SOLIDserverRest-1.7.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5be0334a96fef8cb72d017844bd28906", "sha256": "ef1b9d17da804e6852c880362756021be4440145f06100a78effb177b01a3783" }, "downloads": -1, "filename": "SOLIDserverRest-1.7.2.tar.gz", "has_sig": false, "md5_digest": "5be0334a96fef8cb72d017844bd28906", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 7395, "upload_time": "2019-08-28T09:01:29", "url": "https://files.pythonhosted.org/packages/5f/f5/d303b0773ec74c9bb77fe5f515a7ecb5ad7f52982e6290397da2a89bd28b/SOLIDserverRest-1.7.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1178f70388f2b66608c10e3851fd8aee", "sha256": "c4b43dbdf4ecc43d5dae8a03f1f1e0127b57fb1ed66cacf70f7dbbdb54887c54" }, "downloads": -1, "filename": "SOLIDserverRest-1.7.2-py3-none-any.whl", "has_sig": false, "md5_digest": "1178f70388f2b66608c10e3851fd8aee", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 9002, "upload_time": "2019-08-28T09:01:25", "url": "https://files.pythonhosted.org/packages/3f/c6/55b8205f60a7736a4b1e1891a2437c7a4a33e585537e08ee24022518c87c/SOLIDserverRest-1.7.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5be0334a96fef8cb72d017844bd28906", "sha256": "ef1b9d17da804e6852c880362756021be4440145f06100a78effb177b01a3783" }, "downloads": -1, "filename": "SOLIDserverRest-1.7.2.tar.gz", "has_sig": false, "md5_digest": "5be0334a96fef8cb72d017844bd28906", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 7395, "upload_time": "2019-08-28T09:01:29", "url": "https://files.pythonhosted.org/packages/5f/f5/d303b0773ec74c9bb77fe5f515a7ecb5ad7f52982e6290397da2a89bd28b/SOLIDserverRest-1.7.2.tar.gz" } ] }