BIG-IP Report
Problem this snippet solves:
Overview
This is a script which will generate a report of the BIG-IP LTM configuration on all your load balancers making it easy to find information and get a comprehensive overview of virtual servers and pools connected to them.
This information is used to relay information to NOC and developers to give them insight in where things are located and to be able to plan patching and deploys. I also use it myself as a quick way get information or gather data used as a foundation for RFC's, ie get a list of all external virtual servers without compression profiles.
The script has been running on 13 pairs of load balancers, indexing over 1200 virtual servers for several years now and the report is widely used across the company and by many companies and governments across the world.
It's easy to setup and use and only requires auditor (read-only) permissions on your devices.
Demo/Preview
Interactive demo
http://loadbalancing.se/bigipreportdemo/
Screen shots
The main report:
The device overview:
Certificate details:
How to use this snippet:
Installation instructions
BigipReport REST
This is the only branch we're updating since middle of 2020 and it supports 12.x and upwards (maybe even 11.6).
- Downloads:
https://loadbalancing.se/downloads/bigipreport-v5.7.13.zip - Documentation, installation instructions and troubleshooting: https://loadbalancing.se/bigipreport-rest/
Docker support
https://loadbalancing.se/2021/01/05/running-bigipreport-on-docker/
Kubernetes support
https://loadbalancing.se/2021/04/16/bigipreport-on-kubernetes/
BIG-IP Report (Legacy)
Older version of the report that only runs on Windows and is depending on a Powershell plugin originally written by Joe Pruitt (F5)
BIG-IP Report (only download this if you have v10 devices):
https://loadbalancing.se/downloads/bigipreport-5.4.0-beta.zip
iControl Snapin
https://loadbalancing.se/downloads/f5-icontrol.zip
Documentation and Installation Instructions
https://loadbalancing.se/bigip-report/
Upgrade instructions
Protect the report using APM and active directory
Written by DevCentral member Shann_P:
https://loadbalancing.se/2018/04/08/protecting-bigip-report-behind-an-apm-by-shannon-poole/
Got issues/problems/feedback?
Still have issues? Drop a comment below. We usually reply quite fast. Any bugs found, issues detected or ideas contributed makes the report better for everyone, so it's always appreciated.
---
Join us on Discord: https://discord.gg/7JJvPMYahA
Code :
BigIP Report
Tested this on version:
12, 13, 14, 15, 16
New version out that fixes syntax iRules syntax highlighting and revamps the direct hash links. There's also a lot of quality work in this one (kudos TimRiker !):
https://loadbalancing.se/downloads/bigipreport-v5.7.0.zipBig thanks to TimRiker for his relentless improvements and patience with unit tests and integration tests. This one was all him. 🙂
Also, I have created new docker builds with vulnerability fixes starting from v5.7.0 (base image has been updated) and updated some node dependencies for security reasons.
Thank you Patrik_Jonsson !
- Mathieu_Cerfon1Altostratus
Hi Patrik,
We recently moved our bigip-report to a doker since our old windows server is going to be end of support.
unfortunately, with the same setup, same users, i always got a 401 F5 Authorization failed.
I've tried a lot of think suggested in the topics and on :
https://loadbalancing.se/bigipreport-rest/#Authentication_failed_see_inner_exception
I also check F5 possible bugs ID but still nothing.
From the docker itself, curl is working perfectly : I can get the token and the list of pools.
Also tried to moved the user from Guest access all partitions to full admin : nothing
Any idea what could cause the issue ?
Best regards,
Hi Mathieu
Since you've tried using curl from within the container I reckon you've ruled out network issues at least.
One thing you could try is to try to re-create the config file (start with a new one, don't re-use the old) if you have not done so already.Windows and linux has different line breaks and I've also had the pleasure of experiencing garbage characters more than once.
Which version of BigIPReport are you using and which version of TMOS are you running?
Kind regards,
PatrikHi Mathieu
Although I was hoping for a fun troubleshooting session over discord I'm glad that it worked out for you!Always fun to hear from users of the project, be it over mail, message or comments. ❤️
Kind regards,
Patrik- Mathieu_Cerfon1Altostratus
Hi Patrik,
Me as well, I'm a bit disapointed that was such a simple human mistakes ! I could do better lol
Anyway thank you for your support 😉
Regards,
New version out with minor patches:
https://loadbalancing.se/downloads/bigipreport-v5.7.12.zipAlso, more importantly:
The docker images now will run as non-root. About time!To update to the new containers, use the v5.7.13 tag when deploying using Kubernetes or Docker-compose.
Kind regards,
PatrikWrote a helm chart for deploying BigIPReport on Kubernetes. Will make it much easier to get started.
Have a look here:
https://github.com/epacke/bigipreport-k8s-exampleDue to a platform corruption during the 2019 migration I have worked with team to move his original legacy codeshare to this new record (same URL).
The legacy codeshare is temporarily available at https://devcentral.f5.com/s/articles/bigip-report-old
The negative repercussions of this change are:
- the nearly 1000 historical comments appear that they must will have to remain on the legacy record.
- the numerous *likes* stayed with the legacy record (smash that like at the top right of this page!! if you like it)
- anyone bookmarking that legacy record will not be notified of changes made here (click that bookmark icon)
The positive repercussions of this are:
- Patrik can now make edits to the entry - making updates more likely and timely. (a deep in the weeds corruption I couldn't ferret out)
- You all only have to deal with one set of comments here - making conversation easier. (another part of the corruption)
- And, looking on the bright side of a negative, I don't have to find out (yet) what happens when the comment counter rolls over to 1000.😩
Thank you for your patience and persistence with Patrik's awesome contribution and thank you for your dedication to our community.
New release v5.5.9. Well done Tim!
I've updated the Kubernetes containers with the new code and also triggered the :latest tag for you Cowboys who likes to use that. :)
Got questions/feedback/an insatiable lust for nerd talk? Join us on Discord:
https://discord.gg/W2y2cFX7
Kind regards,
Patrik