BIG-IP Report

Problem this snippet solves:

Overview

This is a script which will generate a report of the BIG-IP 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 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 auditor (read-only) permissions on your devices.

Demo/Preview

Interactive demo

http://loadbalancing.se/bigipreportdemo/

Screen shots

The main report:

The device overview:

Certificate details:

How to use this snippet:

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).

Updated Oct 16, 2024
Version 11.0
application delivery
devops
iControl
LTM
microsoft powershell with icontrol
  • Patrik_Jonsson's avatar
    Patrik_Jonsson
    Icon for MVP rankMVP
    Jun 03, 2021

    Hi Ben

    Apologies, been out enjoying the sun in the afternoon.

    Thanks for reporting, will fix the script that creates deploy and get back to you.

     

    /Patrik

  • BenT's avatar
    BenT
    Icon for Altocumulus rankAltocumulus
    Jun 03, 2021

    I've tried a few times over the last few hours, the zip sizes are identical and the modules folder isn't in the zip.

  • BenT's avatar
    BenT
    Icon for Altocumulus rankAltocumulus
    Jun 04, 2021

    That got it. Thanks!

    Have you looked at port-lists and/or policies? For port-lists, the VIPs aren't contained in the virtual, but are in a traffic-matching-criteria object instead. I don't know how difficult it would be to add the logic to show the VIPs for those in bigipreport or any associated policies.

    Here is an example config for the port-lists. 

    net port-list /Common/web_443-8443-8080_ports {
    description web_443-8443-8080_ports
    ports {
        443 { }
        8080 { }
        8443 { }
    }
}ltm pool /Common/pool_vip_portlist_example {
    load-balancing-mode least-connections-node
    members {
        /Common/172.1.2.5:0 {
            address 172.1.2.5
        }
        /Common/172.1.2.6:0 {
            address 172.1.2.6
        }
    }
    monitor /Common/https_basic_443
}
ltm traffic-matching-criteria /Common/vip_portlist_example_VS_TMC_OBJ {
    destination-address-inline 1.2.3.4
    destination-port-list /Common/web_443-8443-8080_ports
    protocol tcp
    source-address-inline 0.0.0.0
}
ltm virtual /Common/vip_portlist_example {
    ip-protocol tcp
    pool /Common/pool_vip_portlist_example
    profiles {
        /Common/fastL4 { }
    }
    serverssl-use-sni disabled
    source-address-translation {
        type automap
    }
    traffic-matching-criteria /Common/vip_portlist_example_VS_TMC_OBJ
    translate-address enabled
    translate-port enabled
    vlans {
        /Common/proxy-vlan
    }
    vlans-enabled
}
  • Patrik_Jonsson's avatar
    Patrik_Jonsson
    Icon for MVP rankMVP
    Jun 04, 2021

    Hi Ben

    Glad it helped. I added a feature request for you on Github. You can go here:

     

    https://github.com/net-utilities/BigIPReport/issues/69

     

    and then watch it for updates.

     

    I'm afraid I can't give any timelines since both me and Tim does this on our spare time. I normally try to squash bugs pretty fast but features happens when time permits. :)

     

    /Patrik

  • Patrik_Jonsson's avatar
    Patrik_Jonsson
    Icon for MVP rankMVP
    Jul 19, 2021

    Dear all

    I got an email from Docker-hub today that they will discontinue the automatic builds due to too many people abusing the service.

    I'm not yet sure how this will affect the service. Since we don't build the application that often it might work if the manual build is still free.

     

    Either way, I have applied for the bigipreport project to be approved as an Open Source account. If manual builds won't work and the application is denied we'll have to take it from there.

     

    This is only relevant for those running the report using Docker and I will update here once I know more.

     

    Kind regards,

    Patrik

  • richi3161's avatar
    richi3161
    Icon for Nimbostratus rankNimbostratus
    Jul 22, 2021

    Hello,

     

    I have tried today the Version 5.5.9, but I am not able to run script - there is an issue with device certifcate check:

     

    PS C:\bigipreport-v5.5.9> .\bigipreport-v5.5.9.ps1

    2021-07-22 11:34:47 Starting: PSCommandPath=C:\bigipreport-v5.5.9\bigipreport-v5.5.9.ps1 ConfigurationFile=C:\bigipreport-v5.5.9/bigipreportconfig.xml CurrentJob= Location= PSScriptRoot=C:\bigipreport-v5.5.9

    2021-07-22 11:34:47 Successfully loaded config file: C:\bigipreport-v5.5.9/bigipreportconfig.xml

    2021-07-22 11:34:47 Insecure SkipCertificateCheck enabled, consider using valid certificates and DNS names

    ParentContainsErrorRecordException: C:\bigipreport-v5.5.9\bigipreport-v5.5.9.ps1:654

    Line |

     654 |     $PSDefaultParameterValues.Add("Invoke-RestMethod:SkipCertific …

       |     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

       | Exception calling "Add" with "2" argument(s): "The key 'Invoke-RestMethod:SkipCertificateCheck' has

       | already been added to the dictionary."

     

    PS C:\bigipreport-v5.5.9>

     

  • Patrik_Jonsson's avatar
    Patrik_Jonsson
    Icon for MVP rankMVP
    Jul 23, 2021

    I believe the actual reason behind the error was that the script was executed twice in the same PSSession.

     

    Kind regards,

    Patrik