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
974 Comments
- TimRiker
Cirrocumulus
 
This is true. If a datagroup is external, the contents do not load over the iControl SOAP interface that BigIPReport uses. If someone can find a way to load external datagroup contents over iControl SOAP, it would be great to add that support. We might want to make it optional though because some external datagroups are very large and all of them would get added to the
file. I'll add a request in the github issue trackerjson/datagroups.json 
Mike_Perez_6161Nimbostratus
Patrik/Tim,
Trying to run PS queries to find out of how many client or server SSL profiles contain a particular cert. Going through a large SSL cert cleanup effort and need some more data. Can you help with the script to output that data?
In the GUI you can click on the TAB "Instances" to view which Profile contains that cert. Is it possible to include that into the bigipreport?
Thanks, Mike
- TimRiker
Mike,
We don't currently export ssl profiles. The certificates are exported in
, andcertificates.json
includes the referenced SSL client and server profiles, but currently there is nothing exported that links them together.virtualservers.jsonI've been using
on the command line to so some SSL investigation work myself. I downloadjq
withvirtualservers.json
orwget
and then run things like:curljq '.[] | select(.sslprofileclient[] | index("TLS1")) | {loadbalancer,name,sslprofileclient,ip}' virtualservers.jsonto show virtual servers using a given ssl client profile.
How would you show this in the UI? Perhaps a certificate details page for each entry in the certificates table? That could export policies that use the cert provided we can figure out how to lookup that information.
For these types of queries you can also look at this article:
https://loadbalancing.se/2016/10/07/synergy-effect-of-running-bigipreport/
/Patrik
LucernPatrik,
First off thanks a bunch of putting this together. I got it setup at my company and have found it SUPER useful! Every day people would come ask "Hey! What's the status of this pool??" since setting this up they just check the report page and I never hear from them! Scored big points with my boss too! :)
Anyway, I have a feature request which I'm hoping is doable.
When creating a VIP or a Pool there's the Description field which I see is referenced in the report. Would it be possible to make that field searchable in the report? The names we use for nodes/pools/vips aren't exactly user friendly so if we could enter "Company A" into the description field then the non-tech people that are using this could easily find things they're looking for.
Just an idea, not a big deal if it's not possible..
Thanks again!
Let's give a hand to Tim too who has helped a lot this year.
Yes, it is possible. I think this was even added a few releases back. Have you checked out the beta?
/Patrik
- TimRiker
Lucern,
Description field is exported and searchable for virtualservers in the latest beta:
Description field is exported for pools in
, but not currently included as a field in the pool table view, so currently not searchable. It would be easy enough to add to the pool table view. I opened an enhancement request for this:pools.jsonhttps://github.com/epacke/BigIPReport/issues/124
You can search it with
or using powershell in the link Patrik posted earlier:jqhttps://loadbalancing.se/2016/10/07/synergy-effect-of-running-bigipreport/
- Lucern
Ohhhh! I'll have to check it out! Thanks guys!!
- Lucern
I upgraded and it looks great! One issue though is that now my polling is disabled for some reason, was fine before. Everything in your troubleshooting checks out so I'm not sure what's going on.
Also, we create VIPs with iApps (currently) in the iApp Properties it has a field for a Description it would be great if that could be referenced/searched as well.
Thanks!
- TimRiker
Are you delivering the pages and the health checks the same? ie: both http or both https? Mixing them may not work. Pages over http with health check over https might work. Pages over https with healthcheck over http is unlikely to work. Not sure what happens if you're using a file: url for development.
