# IP Fabric
IPFabric is a Python module for connecting to and communicating against an IP Fabric instance.
***For full documentation please see [IP Fabric Documentation Portal](https://docs.ipfabric.io/main/integrations/python/).***
## IP Fabric
[IP Fabric](https://ipfabric.io) is a vendor-neutral network assurance platform that automates the
holistic discovery, verification, visualization, and documentation of
large-scale enterprise networks, reducing the associated costs and required
resources whilst improving security and efficiency.
It supports your engineering and operations teams, underpinning migration and
transformation projects. IP Fabric will revolutionize how you approach network
visibility and assurance, security assurance, automation, multi-cloud
networking, and trouble resolution.
**Integrations or scripts should not be installed directly on the IP Fabric VM unless directly communicated from the
IP Fabric Support or Solution Architect teams. Any action on the Command-Line Interface (CLI) using the root, osadmin,
or autoboss account may cause irreversible, detrimental changes to the product and can render the system unusable.**
## IP Fabric v7.0 Major Release Notice
**IP Fabric 6.10 will be the last release before 7.0.** Major Releases will have breaking changes that will need to be
tested including in the SDK. Please be prepared for this prior to upgrading your IP Fabric instance to 7.0.
## Bugs
A bug has been identified when ~2,000 requests are being made to the API. The underlining issue seems to be with the
implementation of `http2`. The workaround is to set `http2=False` in the `IPFClient` class. Example error:
`httpx.RemoteProtocolError: <ConnectionTerminated error_code:ErrorCodes.NO_ERROR, last_stream_id:1999, additional_data:None>`
## Upcoming Deprecation Notices
In `ipfabric>=v6.9.0` the following was changed/deprecated:
- `IPFDiagram` will be removed as it is now located in `IPFClient().diagram`, the following will be changed:
- `IPFDiagram().diagram_model()` -> `IPFClient().diagram.model()`
- `IPFDiagram().diagram_json()` -> `IPFClient().diagram.json()`
- `IPFDiagram().diagram_svg()` -> `IPFClient().diagram.svg()`
-`IPFDiagram().diagram_png()` -> `IPFClient().diagram.png()`
- Methods found in `ipfabric.models.Snapshot` class will no longer accept the `IPFClient` argument being passed.
- Example: `ipf.snapshot.lock(ipf)` -> `ipf.snapshot.lock()`
**In `ipfabric>=v7.1.x` Python 3.8 will be removed as a supported version as it is now
[End of Life](https://devguide.python.org/versions/) as of 2024-10-07.**
In `ipfabric>=v7.0.x` (Next Release after 6.10) the following will be changed/deprecated:
- All classes including `IPFClient()` will switch to keyword only arguments to support Pydantic BaseModel.
- `IPFClient('https//url')` -> `IPFClient(base_url='https//url')`
- `IPFClient().intent.intent_by_name()` will be removed and is replaced by `IPFClient().intent.intents_by_name()`
- The following endpoints were moved and the old methods will be removed:
- `Technology.LoadBalancing.virtual_servers_f5_partitions` -> `Technology.LoadBalancing.partitions`
- `Technology.Sdwan.sites` -> `Technology.Sdwan.versa_sites`
- `Technology.Sdwan.links` -> `Technology.Sdwan.versa_links`
## Versioning
Semantic Versioning: `Major.Minor.Patch`
Starting with IP Fabric version 5.0.x the `ipfabric` SDK is recommended to match your IP Fabric major and minor version.
We will try to keep some backwards compatability (SDK version `6.9.x` should work with IP Fabric API `6.8`) however new
features may break some functionality. By ensuring that your `ipfabric` SDK's match your IP Fabric major and minor
version will ensure compatibility and will continue to work.
The Patch version of the SDK is used for bug fixes and new features that are compatible with the major and minor version.
## Defaulted to Streaming Data
See [Notices](NOTICES.md) for full information.
* GET URL is limited to 4096 characters.
* Complex queries and filters could go over this limit; however in testing it was very difficult to reach this.
* CSV Export
* Only supported with a streaming GET request and return a bytes string of data in the Python SDK.
* It will also convert times to human-readable format.
* **`reports` (returning Intent Check data) is not supported with CSV export, however is required when filtering based on Intents (colors).**
```python
from ipfabric import IPFClient
ipf = IPFClient(streaming=True)
dev = ipf.inventory.devices.all()
print(type(dev)) # list
dev_csv = ipf.fetch_all('tables/inventory/devices', export='csv')
print(type(dev_csv)) # bytes
# Timezone can be changed for CSV export; see `ipfabric.tools.shared.TIMEZONES`
dev_csv_tz = ipf.inventory.devices.all(export='csv', csv_tz='UTC')
# If specifying to return reports and CSV request will drop reports input and use GET
dev_csv_reports = ipf.fetch_all('tables/inventory/devices', reports=True, export='csv')
"""CSV export does not return reports, parameter has been excluded."""
print(type(dev_csv_reports)) # bytes
# If URL exceeds 4096 characters the following exception will be raised:
# raise InvalidURL(f"URL exceeds max character limit of 4096: length={len(url)}.")
```
## Installation
```
pip install ipfabric
```
To use `export='df'` on some methods please install `pandas` with `ipfabric`
```
pip install ipfabric[pd]
```
## Introduction
Please take a look at [API Programmability - Part 1: The Basics](https://ipfabric.io/blog/api-programmability-part-1/)
for instructions on creating an API token.
Most of the methods and features can be located in [Examples](examples) to show how to use this package.
Another great introduction to this package can be found at [API Programmability - Part 2: Python](https://ipfabric.io/blog/api-programmability-python/)
## Authentication
### Username/Password
Supply in client:
```python
from ipfabric import IPFClient
ipf = IPFClient('https://demo3.ipfabric.io/', auth=('user', 'pass'))
```
### Token
```python
from ipfabric import IPFClient
ipf = IPFClient('https://demo3.ipfabric.io/', auth='token')
```
### Environment
The easiest way to use this package is with a `.env` file. You can copy the sample and edit it with your environment variables.
```commandline
cp sample.env .env
```
This contains the following variables which can also be set as environment variables instead of a .env file.
```
IPF_URL="https://demo3.ipfabric.io"
IPF_TOKEN=TOKEN
IPF_VERIFY=true
```
Or if using Username/Password:
```
IPF_URL="https://demo3.ipfabric.io"
IPF_USERNAME=USER
IPF_PASSWORD=PASS
```
## Development
### Poetry Installation
IPFabric uses [Poetry](https://pypi.org/project/poetry/) to make setting up a virtual environment with all dependencies
installed quick and easy.
Install poetry globally:
```
pip install poetry
```
To install a virtual environment run the following command in the root of this directory.
```
poetry install
```
To run examples, install extras:
```
poetry install ipfabric -E examples
```
### Test and Build
```
poetry run pytest
poetry build
```
Prior to pushing changes run:
```
poetry run black ipfabric
poetry update
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/ip-fabric/integrations/python-ipfabric",
"name": "ipfabric",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "ipfabric, ip-fabric, community-fabric",
"author": "Justin Jeffery",
"author_email": "justin.jeffery@ipfabric.io",
"download_url": "https://files.pythonhosted.org/packages/3e/42/7bf005a4a83ddfe54a25b6a2b303acf9e5ea140627b41d907898fb5f526b/ipfabric-6.10.7.tar.gz",
"platform": null,
"description": "# IP Fabric \n\nIPFabric is a Python module for connecting to and communicating against an IP Fabric instance.\n\n***For full documentation please see [IP Fabric Documentation Portal](https://docs.ipfabric.io/main/integrations/python/).***\n\n## IP Fabric\n\n[IP Fabric](https://ipfabric.io) is a vendor-neutral network assurance platform that automates the \nholistic discovery, verification, visualization, and documentation of \nlarge-scale enterprise networks, reducing the associated costs and required \nresources whilst improving security and efficiency.\n\nIt supports your engineering and operations teams, underpinning migration and \ntransformation projects. IP Fabric will revolutionize how you approach network \nvisibility and assurance, security assurance, automation, multi-cloud \nnetworking, and trouble resolution.\n\n**Integrations or scripts should not be installed directly on the IP Fabric VM unless directly communicated from the\nIP Fabric Support or Solution Architect teams. Any action on the Command-Line Interface (CLI) using the root, osadmin,\nor autoboss account may cause irreversible, detrimental changes to the product and can render the system unusable.**\n\n## IP Fabric v7.0 Major Release Notice\n\n**IP Fabric 6.10 will be the last release before 7.0.** Major Releases will have breaking changes that will need to be\ntested including in the SDK. Please be prepared for this prior to upgrading your IP Fabric instance to 7.0.\n\n## Bugs\n\nA bug has been identified when ~2,000 requests are being made to the API. The underlining issue seems to be with the\nimplementation of `http2`. The workaround is to set `http2=False` in the `IPFClient` class. Example error:\n\n`httpx.RemoteProtocolError: <ConnectionTerminated error_code:ErrorCodes.NO_ERROR, last_stream_id:1999, additional_data:None>`\n\n## Upcoming Deprecation Notices\n\nIn `ipfabric>=v6.9.0` the following was changed/deprecated:\n\n- `IPFDiagram` will be removed as it is now located in `IPFClient().diagram`, the following will be changed:\n - `IPFDiagram().diagram_model()` -> `IPFClient().diagram.model()` \n - `IPFDiagram().diagram_json()` -> `IPFClient().diagram.json()` \n - `IPFDiagram().diagram_svg()` -> `IPFClient().diagram.svg()` \n -`IPFDiagram().diagram_png()` -> `IPFClient().diagram.png()` \n- Methods found in `ipfabric.models.Snapshot` class will no longer accept the `IPFClient` argument being passed.\n - Example: `ipf.snapshot.lock(ipf)` -> `ipf.snapshot.lock()`\n\n**In `ipfabric>=v7.1.x` Python 3.8 will be removed as a supported version as it is now \n[End of Life](https://devguide.python.org/versions/) as of 2024-10-07.**\n\nIn `ipfabric>=v7.0.x` (Next Release after 6.10) the following will be changed/deprecated:\n\n- All classes including `IPFClient()` will switch to keyword only arguments to support Pydantic BaseModel.\n - `IPFClient('https//url')` -> `IPFClient(base_url='https//url')`\n- `IPFClient().intent.intent_by_name()` will be removed and is replaced by `IPFClient().intent.intents_by_name()`\n- The following endpoints were moved and the old methods will be removed:\n - `Technology.LoadBalancing.virtual_servers_f5_partitions` -> `Technology.LoadBalancing.partitions`\n - `Technology.Sdwan.sites` -> `Technology.Sdwan.versa_sites`\n - `Technology.Sdwan.links` -> `Technology.Sdwan.versa_links`\n\n## Versioning\n\nSemantic Versioning: `Major.Minor.Patch`\n\nStarting with IP Fabric version 5.0.x the `ipfabric` SDK is recommended to match your IP Fabric major and minor version. \nWe will try to keep some backwards compatability (SDK version `6.9.x` should work with IP Fabric API `6.8`) however new \nfeatures may break some functionality. By ensuring that your `ipfabric` SDK's match your IP Fabric major and minor \nversion will ensure compatibility and will continue to work.\n\nThe Patch version of the SDK is used for bug fixes and new features that are compatible with the major and minor version.\n\n## Defaulted to Streaming Data\n\nSee [Notices](NOTICES.md) for full information.\n\n* GET URL is limited to 4096 characters.\n * Complex queries and filters could go over this limit; however in testing it was very difficult to reach this.\n* CSV Export\n * Only supported with a streaming GET request and return a bytes string of data in the Python SDK.\n * It will also convert times to human-readable format.\n * **`reports` (returning Intent Check data) is not supported with CSV export, however is required when filtering based on Intents (colors).**\n\n```python\nfrom ipfabric import IPFClient\nipf = IPFClient(streaming=True)\n\ndev = ipf.inventory.devices.all()\nprint(type(dev)) # list \n\ndev_csv = ipf.fetch_all('tables/inventory/devices', export='csv')\nprint(type(dev_csv)) # bytes \n\n# Timezone can be changed for CSV export; see `ipfabric.tools.shared.TIMEZONES`\ndev_csv_tz = ipf.inventory.devices.all(export='csv', csv_tz='UTC')\n\n# If specifying to return reports and CSV request will drop reports input and use GET\ndev_csv_reports = ipf.fetch_all('tables/inventory/devices', reports=True, export='csv')\n\"\"\"CSV export does not return reports, parameter has been excluded.\"\"\"\nprint(type(dev_csv_reports)) # bytes\n\n# If URL exceeds 4096 characters the following exception will be raised:\n# raise InvalidURL(f\"URL exceeds max character limit of 4096: length={len(url)}.\")\n```\n\n## Installation\n\n```\npip install ipfabric\n```\n\nTo use `export='df'` on some methods please install `pandas` with `ipfabric`\n\n```\npip install ipfabric[pd]\n```\n\n## Introduction\n\nPlease take a look at [API Programmability - Part 1: The Basics](https://ipfabric.io/blog/api-programmability-part-1/)\nfor instructions on creating an API token.\n\nMost of the methods and features can be located in [Examples](examples) to show how to use this package. \nAnother great introduction to this package can be found at [API Programmability - Part 2: Python](https://ipfabric.io/blog/api-programmability-python/)\n\n## Authentication\n\n### Username/Password\n\nSupply in client:\n```python\nfrom ipfabric import IPFClient\nipf = IPFClient('https://demo3.ipfabric.io/', auth=('user', 'pass'))\n```\n\n### Token\n\n```python\nfrom ipfabric import IPFClient\nipf = IPFClient('https://demo3.ipfabric.io/', auth='token')\n```\n\n### Environment \n\nThe easiest way to use this package is with a `.env` file. You can copy the sample and edit it with your environment variables. \n\n```commandline\ncp sample.env .env\n```\n\nThis contains the following variables which can also be set as environment variables instead of a .env file.\n```\nIPF_URL=\"https://demo3.ipfabric.io\"\nIPF_TOKEN=TOKEN\nIPF_VERIFY=true\n```\n\nOr if using Username/Password:\n```\nIPF_URL=\"https://demo3.ipfabric.io\"\nIPF_USERNAME=USER\nIPF_PASSWORD=PASS\n```\n\n## Development\n\n### Poetry Installation\n\nIPFabric uses [Poetry](https://pypi.org/project/poetry/) to make setting up a virtual environment with all dependencies\ninstalled quick and easy.\n\nInstall poetry globally:\n```\npip install poetry\n```\n\nTo install a virtual environment run the following command in the root of this directory.\n\n```\npoetry install\n```\n\nTo run examples, install extras:\n```\npoetry install ipfabric -E examples\n```\n\n### Test and Build\n\n```\npoetry run pytest\npoetry build\n```\n\nPrior to pushing changes run:\n```\npoetry run black ipfabric\npoetry update\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package for interacting with IP Fabric",
"version": "6.10.7",
"project_urls": {
"Changelog": "https://gitlab.com/ip-fabric/integrations/python-ipfabric/-/blob/develop/CHANGELOG.md",
"Homepage": "https://gitlab.com/ip-fabric/integrations/python-ipfabric",
"IP Fabric": "https://ipfabric.io/",
"Repository": "https://gitlab.com/ip-fabric/integrations/python-ipfabric"
},
"split_keywords": [
"ipfabric",
" ip-fabric",
" community-fabric"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "053766db5b94978f10478bd56ab10cb61124e16053f85fedb301f5399cd28917",
"md5": "7e4499807af5546c17439a495866f3f5",
"sha256": "18674f503ad951e32c00abccd578c7f96f595e489d3041165dc6056bae05f1a2"
},
"downloads": -1,
"filename": "ipfabric-6.10.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e4499807af5546c17439a495866f3f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 3849276,
"upload_time": "2024-12-18T12:58:16",
"upload_time_iso_8601": "2024-12-18T12:58:16.328790Z",
"url": "https://files.pythonhosted.org/packages/05/37/66db5b94978f10478bd56ab10cb61124e16053f85fedb301f5399cd28917/ipfabric-6.10.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e427bf005a4a83ddfe54a25b6a2b303acf9e5ea140627b41d907898fb5f526b",
"md5": "091c5a517485a610b4223dc682729170",
"sha256": "c54c4c683f70c4108bc6674afe7ccc42aab776856cc6ce0341e56d2c3100b416"
},
"downloads": -1,
"filename": "ipfabric-6.10.7.tar.gz",
"has_sig": false,
"md5_digest": "091c5a517485a610b4223dc682729170",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 3811842,
"upload_time": "2024-12-18T12:58:20",
"upload_time_iso_8601": "2024-12-18T12:58:20.359207Z",
"url": "https://files.pythonhosted.org/packages/3e/42/7bf005a4a83ddfe54a25b6a2b303acf9e5ea140627b41d907898fb5f526b/ipfabric-6.10.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 12:58:20",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ip-fabric",
"gitlab_project": "integrations",
"lcname": "ipfabric"
}
JSON