# ufiber-client
This is a quick dirty project built to provide a quick dirty client for Ubiquiti UFiber OLTs, using firmware version 3.x
There is also a CLI attempt, but I couldn't find any ready to use packages to build a decent CLI.
More info about what am I doing this is on the following entries:
- <https://arturobaldo.com.ar/ufiber-olt-api/>
- <https://arturobaldo.com.ar/digging-into-ubiquitis-ufiber-olt/>
## olt.py
This is the core of the project. It uses the OLTCLient class to provide a middleware between you and the HTTP interface of the olt.
Initialize a new OLTClient instance with:
`client = olt.OLTClient(host, username, password)`
The initialization will handle the login for you, altough you can call the `login()` method manually.
If the OLT is network reacheable, and you have provided the right credentials, and the OLT WEB GUI is alive and well, you should be ready to start.
You can also connect using `cli.py`:
```Console
$ /cli.py
UFiber Client for fw version 3.1.3
UFiber> help
Documented commands (type help <topic>):
========================================
connect help onu quit show
UFiber> connect 10.20.0.101
Username:admin
Password:
Logging to 10.20.0.101 ...
Connection OK
UFiber>
```
Raw data
{
"_id": null,
"home_page": "",
"name": "ufiber-client3",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "ubiquiti,ufiber,gpon,netowrk,automation,networking",
"author": "",
"author_email": "Arturo Baldo <baldoarturo@mail.com>",
"download_url": "https://files.pythonhosted.org/packages/ea/e4/c5886d92978826069d1094aa23762c97360aa9524cdb49042493d51fc5f9/ufiber_client3-1.0.1.tar.gz",
"platform": null,
"description": "# ufiber-client\n\nThis is a quick dirty project built to provide a quick dirty client for Ubiquiti UFiber OLTs, using firmware version 3.x\n\nThere is also a CLI attempt, but I couldn't find any ready to use packages to build a decent CLI.\n\nMore info about what am I doing this is on the following entries:\n\n- <https://arturobaldo.com.ar/ufiber-olt-api/>\n- <https://arturobaldo.com.ar/digging-into-ubiquitis-ufiber-olt/>\n\n## olt.py\n\nThis is the core of the project. It uses the OLTCLient class to provide a middleware between you and the HTTP interface of the olt.\n\nInitialize a new OLTClient instance with:\n\n`client = olt.OLTClient(host, username, password)`\n\nThe initialization will handle the login for you, altough you can call the `login()` method manually.\n\nIf the OLT is network reacheable, and you have provided the right credentials, and the OLT WEB GUI is alive and well, you should be ready to start.\n\nYou can also connect using `cli.py`:\n\n```Console\n$ /cli.py\nUFiber Client for fw version 3.1.3\nUFiber> help\n\nDocumented commands (type help <topic>):\n========================================\nconnect help onu quit show\n\nUFiber> connect 10.20.0.101\nUsername:admin\nPassword:\nLogging to 10.20.0.101 ...\nConnection OK\nUFiber>\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Ubiquiti UFiber Client for firmware version 3",
"version": "1.0.1",
"split_keywords": [
"ubiquiti",
"ufiber",
"gpon",
"netowrk",
"automation",
"networking"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "5d9f5759f89fe83fbcc5ea34dec9511f",
"sha256": "b86b9f831fdc1677bdee4f5ea863322ee03fcba126173cca3f7e186139bf5e9b"
},
"downloads": -1,
"filename": "ufiber_client3-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d9f5759f89fe83fbcc5ea34dec9511f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4505,
"upload_time": "2022-12-16T17:57:16",
"upload_time_iso_8601": "2022-12-16T17:57:16.688046Z",
"url": "https://files.pythonhosted.org/packages/9a/c9/dd2309ab253cd6689696e378af0b8b852e0c6c0da2a4819b2e1755cd8ce7/ufiber_client3-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "a0477cce8254c14fd3af3bb4c746a931",
"sha256": "7fa921040d2953ac5e85c72edc1389acd84e6e59351d66998eaf18c2f7e24ce6"
},
"downloads": -1,
"filename": "ufiber_client3-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a0477cce8254c14fd3af3bb4c746a931",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4367,
"upload_time": "2022-12-16T17:57:18",
"upload_time_iso_8601": "2022-12-16T17:57:18.231308Z",
"url": "https://files.pythonhosted.org/packages/ea/e4/c5886d92978826069d1094aa23762c97360aa9524cdb49042493d51fc5f9/ufiber_client3-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-16 17:57:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "ufiber-client3"
}
JSON