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
- Mike_Perez_6161
Nimbostratus
When I click on the objects that do not work I get the Uncaught ReferenceError:
(index):46 Uncaught ReferenceError: showPools is not defined at HTMLDivElement.onclick ((index):46) onclick @ (index):46 (index):47 Uncaught ReferenceError: showiRules is not defined at HTMLDivElement.onclick ((index):47) onclick @ (index):47 (index):48 Uncaught ReferenceError: showDataGroups is not defined at HTMLDivElement.onclick ((index):48) onclick @ (index):48 (index):45 Uncaught ReferenceError: showVirtualServers is not defined at HTMLDivElement.onclick ((index):45) onclick @ (index):45
- TimRiker
Cirrocumulus
It looks like your page in on
. Can you load/test/
? It looks like the main javascript file never loaded? I'm guessing it's an old one and perhaps you didn't copy over the new resources from the update and you're trying to use an old js/bigipreport.js. If so, that won't work. You need to copy the new files from "/test/js/bigipreport.js
" into your ReportRoot. ie:Move....root
to yourcss/*ReportRoot/css/
to yourimages/*ReportRoot/images/
to yourjs/*ReportRoot/js/
to yourjson/*ReportRoot/json/
This needs to happen with any new release you test. It might be nice if the build script would copy all the resources to avoid this issue. I run this:
xcopy /d /y /q /e 'Move the content of this folder to the configured report root\*' C:\inetpub\wwwroot\\ - TimRiker
Cirrocumulus
New release v5.1.8
- column toggles for other views, ie: iRules, DataGroups, etc.
- copy, print and csv export for other views
- bug fix, pools expand on search hit, expansion is now case-insensitive
- new icons
- main CSV export includes searched rows instead of just on-screen rows
As always, copy over the
files to your ReportRootMove*/* - nadj_354479
Nimbostratus
Hi Patrik,
there is not a script that remonted an alarm when we received this parse of log
/Common/default-eviction-policy (8) (global memory) 5206 Connections killed
??
Regards,
Sorry Nadj, I don't understand what you mean.
/Patrik
- jba3126
Cirrostratus
Hello, I'm testing 5.1.8 and so far things look good!
Few notes: 1. The export feature is working; however it is put things in a format I'm not easily able to parse when I import to Excel. Previously it was ; delimited and only contained the value in the headers, rows, and columns. Any suggestions as I'm a novice at this format and would need to do Notepad++ macro to clean up and remove the extra info. 2. When I copy and cancel I noticed the Copy button is in some type of loop as if it is processing. When I refresh the screen it goes away, so no big deal. If I actually copy the data to my clipboard it works just fine. 3. This is more of an RFE :) - We are using more SNI in our SSL Profiles. The reports are only showing one, which is fine for now. What would be helpful is if it was the parent SNI profile with an indicator it was an SNI parent or list all of the profiles attached to a Virtual.
I will share more, but as I said all is looking good!
/jeff
- TimRiker
Cirrocumulus
The new CSV export buttons are trying to export what is shown in the current search and visible rows. The old export includes more fields and should also be working. Does that work for you? I think the old export button only shows up if you have it enabled in the config xml. The new buttons show up all the time.
We might want to make that configureable. :)
After 5.1.8 I did some more work on cleaning up the csv exports, removing html markup. I also changed the old csv export to use commas instead of semicolons. Perhaps I'll make another release with those changes.
We are moving some hosts to SNI as well. I have not looked at how they show up. I'll look into this.
I'm considering adding more lookups. For example, on the iRule details view, to generate a list of all the virtual hosts that use that iRule. Thoughts?
- jba3126
Cirrostratus
Tim, I missed the enable export in my configuration. I guess when I saw the big shiny export button I never thought twice about it :) That sounds really good and I look forward to testing. Things in my Dev setup seem to be working. Haven't really run into any issues so far. SNI threw me for a loop when we started doing our TLS migration. Once I sat down and look into it made better since and kind of like it though it feels like peeling an onion with the layering/associations. I really like the idea with the iRule as I just had to hunt down close to 514 VIPS with a particular iRule. 99.8% were identical in naming convention, but we had a few that bit me with a different name. Luckily we were under a change window and I was able to fix my script, but it would have been nice to know going in. We are looking at broader usage of certain iRules so this would be helpful. The most helpful feature I can think of (aside from SSL/TLS/Cipher stats) would be unused objects. We are trying diligently to clean our estate and I seem to remember Enterprise Manager having a report with this feature, but can't recall off the top of my head if it truly gave objects (Pools, iRules, Profiles, etc).
Thanks again for the work on this brilliant tool!
Cheers!
/jeff
- TimRiker
Cirrocumulus
Releasing 5.1.9 with the following:
- CSV header cleanup and previous report converted to commas
- SNI support. Both client and server SSL profiles display multiple entries
- datagroups.json forced to array
- paste support in search field, ie: update search results on mouse paste
- removed a left over debug line
- searches correctly expand pools if the pool field is the sort field
- load balancer added to some details views
Just merged the code and released 5.1.9 as a beta. Thank you for all your work Tim!
/Patrik
Help guide the future of your DevCentral Community!
What tools do you use to collaborate? (1min - anonymous)