BigIP Report Old
Problem this snippet solves:
This codeshare has been deprecated due to a hosting platform corruption. I have moved code and conversation to a new record (on the same original URL) https://devcentral.f5.com/s/articles/bigip-report
can be Overview
This is a script which will generate a report of the BigIP 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 our 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 guest permissions on your devices.
Demo/Preview
Please note that it takes time to make these so sometimes they're a bit outdated and they only cover one HA pair. However, they still serve the purpose of showing what you can expect from the report.
Interactive demo
http://loadbalancing.se/bigipreportdemo/
Screen shots
The main report:
The device overview:
Certificate details:
How to use this snippet:
This codeshare has been deprecated due to a hosting platform corruption. I have moved code and conversation to a new record (on the same original URL) https://devcentral.f5.com/s/articles/bigip-report
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).
Download: https://loadbalancing.se/downloads/bigipreport-v5.5.4.zip
Documentation, installation instructions and troubleshooting: https://loadbalancing.se/bigipreport-rest/
Docker support
This will be the recommended way of running bigipreport in the near future. It's still undergoing testing but it's looking really good so far.
https://loadbalancing.se/2021/01/05/running-bigipreport-on-docker/
BigipReport (Legacy)
Older version of the report that only runs on Windows and is depending on a Powershell plugin originally written by Joe Pruitt (F5).
BigipReport (Stable):
https://loadbalancing.se/downloads/bigipreport-5.3.1.zip
BigipReport (BETA): 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.
---
Also trying out a Discord channel now. You're welcome to hang out with us there:
Code :
85931,86647,90730
Tested this on version:
13.0
Hi!
Releasing a new version now, but I have not had time to test it as much as I would have liked to. Thus the "-beta" in the name. :)
The significant changes apart from smaller bug fixes:
- Adding data group list parsing and writing the output to json files* Fixed so you can hide the compression columns
- Showing data group list content now works
- Made data group lists clickable when looking at irules definitions.
- Added pre-checks for the static files
New options in the settings file, so either update that one fully, or replace the irule settings section with the new content.
I would also like to know if any of you have been encountering issues when extracting virtual server information? I had some issues when running the script on W2012 in regards to getting NAT rules from VIP's.
Left to do for the next version:
- Clearing search filters
If I have time:
- Realtime pool status polling
- Hiding partition information in more places
- Persistence profiles used
- Pool load balancing method
Please let me know if you run into any issues with the new version!
/Patrik
Nice Work Patrik! Now we can see the Data group list content :-)
What doesn't seem to work is to hide the compression column. I set it to false but it still shows up.
/Riad
Hi!
Thanks. I ran it myself now and it seems to work fine. Have you done a "fresh" install?
/Patrik
4.2.7 Released
Small fix in the data group list parser where it will now ignore data group lists or commands that resides in comments.
/Patrik
My mistake Patrik, it now works hiding the Compression column. :-)
Have you thought of making it possible to search inside a Datagroup or irule? I mean that when you in the search field type anything that it will also match the content of the Datagroup lists and rules? Would it be possible?
/Riad
Hi!
Thanks for getting back regarding the compression column and for your feedback.
Yes, but I have not been able to come up with a good way to do it yet. If one day I finally take the step to fully generate the report using javascript it would not be a problem. But right now this would mean that I would have to add the content of the data group lists and irules in the html DOM, and that would make the report several times bigger than it is today.
Given how heavy it is to load already I don't consider that an option. There could be a way to search them in a separate lightbox, but until I can come up with a clever way to do it will have to be added to the RFE list. :)
/Patrik
- JackRodriguezNimbostratus
Hi Patrik,
Just started using the reporting tool on version 4.2.1. Very pleased with the output. Winning big marks with management. Thanks so much. Not sure if this feature request has been discussed or road-mapped already but it would be awesome if we could see the Priority Group settings in the Pool details. Has that been discussed already? I apologize if that is the case.
thanks again.
Hi Jack!
Thanks, it's nice to hear that! :) I don't think it has been mentioned before. Adding it to the feature request list. Not sure when it will be done though as the list is long. :)
/Patrik
Hi again
I am learning Git, so I needed something to experiment with. Consider your wish granted. :)
4.2.8 Released
Now showing priority groups in the pool details.
Planned features
- Clearing search filters
- Realtime pool status polling
- Pool load balancing method
- Persistence profiles used
- Using anchor links to make it easier to share information
- Adding searching in data group lists and irules
- Pool parsing support of policies and data group lists
Possible updates that might come as a separate module
- License expiration
- SSL certificate expiration warnings
- iHealth analysis
/Patrik
- JackRodriguezNimbostratus
Patrik,
Just loaded 4.2.8 and the Priority Groups are now showing up. Thanks for the quick response on the feature request. I will continue to check back for feature enhancements from time to time.
thanks again.