F5 Networks Python SDK
F5 Networks BIG-IP python SDK. This project implements an SDK for the iControl REST interface for the BigIP. Users of this library can create, edit, update, and delete configuration objects on a BigIP device.
Python API for configuring objects on a BIG-IP device and gathering information from the device via the REST API.
$> pip install f5-sdk
from f5.bigip import BigIP bigip = BigIP("bigip.example.com", "admin", "somepassword") device_name = bigip.devicename()
Documentation is hosted on Read the Docs
See the Issues section of Contributing.
Python Package: To build a python package that can be installed using pip. The output is in ‘dist’.
$ make source
Debian Package On a debian system you can build debian packages if you have installed python-all, fakeroot, and python-stdeb
$ sudo apt-get install python-all fakeroot python-stdeb $ make debs
On a system that has docker installed, you can use the docker_debs target. This will launch a trusty container to build a debian package.
$ make docker_debs
RedHat/Centos 7 Package On a RedHat/Centos 7 system you can build RPMS if you have installed make and rpm-build rpms.
$ sudo yum install make rpm-build $ make rpms
On a system that has docker installed, you can use the docker_rpms target. This will launch a centos7 container to build the f5-bigip-common package
$ make docker_rpms
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 device for testing. Information on how to run our set of tests is included below.
We use pytest for our unit tests.
If you haven’t already, install the required test packages and the requirements.txt in your virtual environment.
$ pip install hacking pytest pytest-cov $ pip install -r requirements.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).
Copyright 2014-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.