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
- silverem_84897Nimbostratus
Thx, correct, json was missing.
- danielpennaCirrus
Hey Patrick, Upgraded to 4.3.0 last week and the iRule to Virtual Server feature is awesome!
My team is looking at using your script as a baseline to find owners in the organization and we will be using the description field of a virtual server to establish an internal owner to an application. In the short term we will be modifying your PS script to include the description field of a Virtual Server but wondering if this can be a feature request for any future versions ?
- Tom_KNimbostratus
Patrik - your demo is awesome, I am not a powershell user so still trying to understand logistically and architecturally where the pieces go. I have powershell on a Windows 10 laptop and am planning to run the web server on a Redhat apache web server and the instructions say to copy the content of the BigipReport package to /var/www/html/ which are files Bigipreport-4.3.8.ps1 and bigipreportconfig.xml - so Bigipreport-4.3.8.ps1 gets put wherever I also put bigipreportconfig.xml? Thanks, Tom
Hi Tom
Did you follow the instructions on loadbalancing.se?
Both of these needs to be executed with Powershell:
-
bigipreport-4.3.8.ps1 - This is the actual script
-
bigipreportconfig.xml - Configuration for the script
Then, there's a folder which is named "Move the content of this folder to the configured report root". This folder contains styles and javascripts needed by the report and needs to reside on your web server.
So in your case, if you want to automate things you'd have to install Samba on your Redhat server and share your report root on the linux server.
Alternately, if you don't want to automate things you can just configure the script and copy the html file manually.
/Patrik
-
New version (4.4.0):
- Adding support for orphaned pools in the json objects.
- Fixing a bug with empty irules preventing virtual server details to the shown.
/Patrik
- nrgpill_325111Nimbostratus
Tried version 4.4, running into this:
Exception calling "get_list" with "0" argument(s): "There is an error in XML document (14, 29)." At C:\Users\lhong\Downloads\Bigipreport-4.4.0\Bigipreport-4.4.0.ps1:688 char:2 + [array]$AvailableModules = $() + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : NotSpecified: (:) [], MethodInvocationException + FullyQualifiedErrorId : InvalidOperationException
Exception calling "get_level" with "1" argument(s): "Could not find element by name: modules" At C:\Users\lhong\Downloads\Bigipreport-4.4.0\Bigipreport-4.4.0.ps1:689 char:2 + [array]$ModuleLevel = $($AvailableModules) + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : NotSpecified: (:) [], MethodInvocationException + FullyQualifiedErrorId : SoapHeaderException
Hi!
Thank you for reporting, I will check it out!
/Patrik
Ok, I checked those lines in the script. A few questions:
- What version are you running?
- Do you have ASM installed?
- Do you have the latest version of the iControl powershell snapin?
- Which version of Powershell are you running?
/Patrik
- nrgpill_325111Nimbostratus
Thanks for looking into this Patrik, really appreciate the quick help!
What version are you running?
BIG-IP 11.4.1 Build 637.0 Hotfix HF3
Do you have ASM installed? Do you have the latest version of the iControl powershell snapin?
version 11.00.0002
Which version of Powershell are you running?
PSVersion 4.0 WSManStackVersion 3.0 SerializationVersion 1.1.0.1 CLRVersion 4.0.30319.42000 BuildVersion 6.3.9600.17400 PSCompatibleVersions {1.0, 2.0, 3.0, 4.0} PSRemotingProtocolVersion 2.2
Doh, 11.4.1 is quite old. I don't have a device that runs it. Since the ASM functions in the script seem to be a hit or miss for some users I am considering removing them until I start writing a REST based version of the report.
Did you try older versions of the script by any chance? 4.3.0 might do the trick for you.
/Patrik