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
Just wanted to add for those who want to use sub folders to host the report. I have an updated version of bigipreport but I can't upload it due to a problem with devcentral. Meanwhile, please look here for a manual patch:
https://devcentral.f5.com/questions/issues-with-bigip-report-47511
/Patrik
A patch has now been added with the help of DC's esteemed Jason Rahm. Now sub folders should work properly.
/Patrik
- danielpennaCirrus
Hey Patrick, thanks for the assistance. Getting great feedback from within my organization around the site. We already have an inhouse portal for pools that is more dynamic ( uses the old SOAP interface ) but the search feature on this gets everyone excited.
The only request I have left is back to the first comment I put back in OCT 2015 :). We love iRules internally and most Virtuals have at least 1-2 ( some 4-5 ) on them. I know you have included a section where you can manually add iRules that you want display but is there a future version where the iRules that are attached to the Virtuals can be dispalyed without explicitly defining them. Just a simple feature request and hopefully not read as a demand.
Again, awesome work. This thing rocks :).
Thanks Daniel, your comment is very much appreciated. I will make sure to include that in a future version. Adding virtual details might take a bit of a time since there's so many properties of a virtual server. Stay tuned. :)
/Patrik
I can't update this page anymore due to the ASM giving me issues so I've added the latest version here:
https://loadbalancing.se/2016/07/18/bigipreport-4-2-0/
It now features:
- Virtual server details
- Virtual server details allows for displaying iRules (requested by Daniel Penna)
- Associated address translation (requested by Craig Gauntlett)
- Some smaller bug fixes
Hope to make it more pretty in future versions. Enjoy!
/Patrik
Deleted some stuff from the code share page. Latest version can be found there again.
Fixed in 4.2.1:
Members having status unknown is now not listed as down any more. (requested by Mike)
/Patrik
I've seen some potential issues with 4.2.1 and error reporting. Will try to issue an update soon.
/Patrik
- DebenB_254182Nimbostratus
Thanks Patrik for you continuous support and dedication.. Appreciated....
Trying scheduler to schedule scripts to generate report every morning.. But the problem is that old file is not replaced by new one and error below...If you can guide / help...
Also need you support/guidance how to display persistence and LB method used.. Is new version 4.2 includes that.
Move-Item : Cannot create a file when that file already exists. At C:\inetpub\Bigipreport-4.1.2-beta\TCS F5 Script\Bigipreport-4.1.2-beta.ps1:1119 char:2 + Move-Item -Force $($Global:poolsjsonpath + ".tmp") $Global:poolsjsonpath + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : WriteError: (C:\inetpub\Bigi...json\pools.json:FileInfo) [Move-Item], IOException
Thanks Deben
Hi Paul
CSV being a flat file is not optimal for this kind of "multi-dimensional" output, but if you could provide me with one or two example rows with data, preferrably with at least two pools connected to the VIP and at least two members per pool, I should be able to figure something out.
/Patrik
Hi Deben
Do you have the files on the same server as the report is running on? Have you double checked the web folder permissions? Do you also get these problems if you run the script manually?
I can see also that you're running an old version of the script. A newer version could give you better error handling.
If you're upgrading to version 4.2.0 or higher, don't forget to update your configuration file with the irules section.
/Patrik