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
No problem.
It depends on how which platform you have, the size of your configuration, if you have generally high the CPU usage or not. Most of the heavy lifting is done on the BigIP-Report server.
At my work place the report is used by the organization to troubleshoot stuff and to know status of objects so we run it as often as we possibly can. The whole batch takes ~20 minutes to finish so the Scheduled Task has been set to run every 30 minutes in case of slow network/BigIP-report server.
You can test yourself by running the report repeatedly against a lab/QA server:
cd do { .\bigipreport.ps1 } while { 0 -lt 1 }
Do note, that if you have a virtual lab edition, please make sure that you run it against the management interface and not one of the other types. Otherwise you might hit the throughput limit of 10mbit. 🙂
/Patrik
- VingertNimbostratus
I was facing the same issue as Shannon and Cinon ("There were errors when loading the object json files".) using the BigIPReport v4.7 in a test LTM environment and IIS 10.0. My config had one pool and one virtual server. Started to struggle with this issue not showing the vs and pool details, and then I created a few more pool and virtual servers and run the script again. Reloaded the page and it worked perfectly! Dunno why but the important thing is that works 100%! Thx Dude! Great work! :)
Thank you for the feedback! I believe the issue you faced is a bug that I actually encountered myself today.
It will be fixed in the next version.
And say hi to Riad from me. :)
4.8.0 Beta release
- Many many small fixes, improvements that you likely won't notice. :)
- Bug fix for reports only containing single objects (vs, pool, nodes).
But on to the cool stuff
- The report is now able to poll your F5 devices and thus getting the current state of the pool members.
Please read this first:
https://loadbalancing.se/bigip-report/Realtime_Pool_Member_State
Configuration file update is needed to make this work.
I would very appreciate feedback on the implementation and reports of any issues implementing the polling feature.
- VingertNimbostratus
Thanks for the feedback :)
You know Riad! Small world :) I will say hi to him :)
- Munawar_Khan_34Nimbostratus
Hi,
It is possible to export the report in PDF format?, I Dont want to use chrome print to PDF. is there any way we can do it. Munawar
Thanks for the feedback.
It's currently not possible unless using windows/chrome's PDF printer.
/Patrik
Awkward. Forgot to add the zip file for the 4.8.0 beta release. :)
/Patrik
Found an issue with the Beta. If using SSL to host the report the status VIP's won't work. I will need to re-do the configuration section so I will remove the beta for now.
/Patrik