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
- nrgpill_325111Nimbostratus
Thanks Patrik
Just tried 4.3.0 -
2017-06-23 09:04:29 Configuring the console window 2017-06-23 09:04:29 Pre-execution checks 2017-06-23 09:04:29 Pre execution checks was successful Add-Type : Cannot add type. The type name 'VirtualServer' already exists. At C:\Users\lhong\Downloads\Bigipreport-4.3.0\Bigipreport-4.3.0.ps1:500 char:1 + Add-Type @' + ~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (VirtualServer:String) [Add-Type], Exception + FullyQualifiedErrorId : TYPE_ALREADY_EXISTS,Microsoft.PowerShell.Commands.AddTypeCommand
Looks like you tried to execute it within the same Powershell session. Restart the shell/ISE and try again?
/Patrik
- nrgpill_325111Nimbostratus
Thanks. I started a new powershell session and got past the error. Now I am seeing "method invocation failed"
Method invocation failed because [iControl.LocalLBVirtualServer] does not contain a method named 'get_source_address_translation_type'. At C:\Users\lhong\downloads\Bigipreport-4.3.0\Bigipreport-4.3.0.ps1:970 char:4 + $virtualserversourceaddresstranlationtypelist = $ ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (:) [], RuntimeException + FullyQualifiedErrorId : MethodNotFound
Too bad. That one should really work on 11.4.1 according to F5 support docs.
Try commenting out line 970 and 971 and re-execute? Comment out by adding a hashtag before the code.
/Patrik
- Brian_325715Nimbostratus
Patrik, What are the chances that BigIP Report could be adapted to process an offline static SCF or UCS?
thanks, -Brian
Cool idea! However, that would require massive amounts of free text parsing and would not be very reliable.
Out of interest, may I ask you what prevents you from running the report as it is?
/Patrik
- Brian_325715Nimbostratus
Working as a consultant in a sensitive environment getting anything "on" the network is nigh impossible, but often the client is perfectly content to hand over a directory of UCS files.
Perhaps another option is to load the UCS into a standalone VE, and run BigIP Report against the VE.
That's possible, but you'd miss out on the status of pool members that way. We are quite picky with how we do things at my company so I designed the script like this:
- The user needed to extract the information only needs guest access (which means that private keys or configuration changes are not an issue)
- The server extracting the information and the server that presents it can be separated. So you can basically run it from your client and write the data to a separate internal server.
In our case we run the script from a production server and the result is written to an internal server which is located in the office. That way no office equipment needs to access the load balancers.
/Patrik
New version: 4.4.1
- Removed the ASM support as it only caused issues. Will add support for version 12.1 and above later.
- Added preferences with possibility to auto expand pool details and links to virtual servers and pools in the LTM interface.
It is recommended, but not necessary to also update the configuration xml file since it contains properties that is not used anymore.
/Patrik
Screenshot of the new version: