F5 BIG-IP iControl REST API client
This generic python library allows programs and other modules to interact with the BIG-IP® iControl® REST API.
If you want to use python to automate BIG-IP® devices via the REST API, use the F5 SDK (F5Networks/f5-common-python).
$ pip install f5-icontrol-rest
Installing directly from GitHub
NOTE: The example below installs the package at release v0.1.0. Omitting the version number will install the package from the current state of the default branch.
$ pip install git+ssh://email@example.com/F5Networksfirstname.lastname@example.org`
from icontrol.session import iControlRESTSession icr_session = iControlRESTSession('myuser', 'mypass') icr_session.get( 'https://bigip.example.com/mgmt/tm/ltm/nat', name='mynat', partition='Common')
If you find an issue we would love to hear about it. Please let us know by filing an issue in this repository and tell us as much as you can about what you found and how you found it.
To make a PyPI package:
$ python setup.py sdist
Before you open a pull request, your code must have passing pytest unit tests. In addition, you should include a set of functional tests written to use a real BIG-IP® for testing. Information on how to run our set of tests is included below.
We use pytest for our unit tests.
1. If you haven’t already, install the required test packages listed in requirements.test.txt in your virtual environment.
$ pip install -r requirements.test.txt
- Run the tests and produce a coverage report. The --cov-report=html will create a htmlcov/ directory that you can view in your browser to see the missing lines of code.
$ py.test --cov ./icontrol --cov-report=html $ open htmlcov/index.html
We use the hacking module for our style checks (installed as part of step 1 in the Unit Test section).
$ flake8 ./
Copyright 2015-2016 F5 Networks Inc.
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.