Skip to main content

Simple python package to manipulate F5 running configuration better and faster

Project description

image


What is it?

I call it DIY F5 Security Administrators's Swiss Army knife. This is a simple python API built for F5 security administrators.

I implemented the Python package in order to better understand and help manage my employer F5 infrastructure. Which has a whopping 32 nodes in total, and over half million running configuration lines when combined together as of this writing.

Release Notes

Check out Releases document for complete information.


How Does It Work?

The package provides a direct hook to the F5 TMOS command line interface from your local workstation, by establishing a TTY connection via SSH as the privileged user. Once hooked, the security admin will be able to manipulate F5 running configuration by using the standard TMOS commands.

Furthermore, the security admin can go to the next level of the playing field, by custom buildout the automation procedures in the full-stack capable, object-oriented Python programming language from there.

Running Requirement?

As of November 11 2019, you'll need Python 3 environment to run the package.

The package is originally developed in Python 2.7 environment of my Macbooks Pro. Since Python 2 is depreciated end of 2019, the package is converted into Python 3 from version 1.1.16 onward. Note I have no plan to backward supporting 2.7.

Checking your Python version with the command below:

$ python -V

Working Examples?

Please refer to the utility examples documents for the working examples.

API Documents

Please refer to API, for complete information on how to use this API.

Unit Testing

Unit tests are written to ensure the quality of the code. It provides the assurance and sustainability of the project. Use the following command to run the tests:

$ cd f5-admin/
$ python -m unittest discover tests/

Installations

There are several ways you can install the Python package in your favorite system.

Install from Python Package Repository

$ pip install f5-admin

Build the Python Package from Source

Once you download and unzip the source code, find and run the rebuild.sh script under the source root directory:

$ python setup.py sdist bdist_wheel

Install from Build Package

After the successful build, you'll also have the .gz package under 'dist' sub-folder. You have the option to distribute it to other systems. And you can then install the software by using the Python standard package management tool pip.

For example:

$ sudo pip install dist/f5_admin-1.1.2.tar.gz
Password:
...
Successfully installed f5-admin-1.1.2

Verify the Installation

Once installed, you'll be able to list it under your Python environment:

$ pip list | grep f5
f5-admin                               1.2.0

To Do

Refer to TODO document for complete list of expectations / project roadmap.

Who is this guy?

Sam (Yang) Li serves as the IT Security Architect in the infrastructure team. He is an information security veteran with 20 years hand-on experiences in the fields. You can connect him in LinkedIn.

License

Project details


Download files

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

Source Distribution

f5_admin-1.2.4.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

f5_admin-1.2.4-py3-none-any.whl (78.1 kB view details)

Uploaded Python 3

File details

Details for the file f5_admin-1.2.4.tar.gz.

File metadata

  • Download URL: f5_admin-1.2.4.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for f5_admin-1.2.4.tar.gz
Algorithm Hash digest
SHA256 7fea221557aa9b178b30d44749c39fd0601e4ab8aa8494d5baa981cc27f17471
MD5 ee2cf76a5764387cb35190cad3d58107
BLAKE2b-256 9df040bd1e2ab45b2306e37b863dc4c5ba61fc8cbd976f84511304ce97cbae88

See more details on using hashes here.

File details

Details for the file f5_admin-1.2.4-py3-none-any.whl.

File metadata

  • Download URL: f5_admin-1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 78.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for f5_admin-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b2e6ca267f4556ff68fc55d3e05d63e42e1fdc896e3947558f08b140b02fa68b
MD5 e842b40ab4ff1edb0c7e3ede4907a682
BLAKE2b-256 7f46521222ad9159187cb5d30932d5a546efc25d7d7912fd2c34b406e77f3cde

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page