Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

F5 BIG-IP iControl REST API client

Project Description


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).


Using Pip

$ 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://`




from icontrol.session import iControlRESTSession
icr_session = iControlRESTSession('myuser', 'mypass')


See Documentation.

For Developers:

Filing Issues

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.


See Contributing.


To make a PyPI package:

$ python 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.

Unit Tests

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
  1. 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

Style Checks

We use the hacking module for our style checks (installed as part of step 1 in the Unit Test section).

$ flake8 ./


See Support.


Apache V2.0

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.

Contributor License Agreement

Individuals or business entities who contribute to this project must have completed and submitted the F5 Contributor License Agreement to prior to their code submission being included in this project.

Release History

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
f5-icontrol-rest-1.3.0.tar.gz (11.1 kB) Copy SHA256 Checksum SHA256 Source Jan 13, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting