Forum Discussion

rafaelbn_176840's avatar
rafaelbn_176840
Icon for Altocumulus rankAltocumulus
Feb 27, 2018

LTM Project Documentation an qKViews

Hello Devs! How is everybody doing?

 

This is kind of an off-topic question. I'm new to the F5 world and I'm finishing some real world projects. And as part of the project I have to deliver the documentation. I know that there are tons of ways of doing that and since I'm new to F5 world, I was wandering how you guys do that.

 

Besides topology, some selfs, floats, vlans and interface tables I wanted to give a high level overview of each app/VS and it's main infos. And I came up with this:

 

 

What do you guys think? It's (at least for me) very handy to have this overview. I can see the name of the objects, their IPs, ports and etc. The problem with this method is that it's very time consuming (at least for me). I have to look in lots of places. If your F5 have 50 apps you're going to have "fun times" doing this!

 

I'm interested in seeing how you guys do your documentation. Anything goes! Feel free to copy my method if you don't have one and liked mine.

 

One thing I was thinking is that the qkview actually do something very similar (under config explorer). I wish some blessed soul at F5 could code the magic "document this qkview" to export something like these tables I did.

 

Looking forward to your answers!

 

Thanks!

 

application delivery
BIG-IP
LTM
  • amintej's avatar
    amintej
    Icon for Cirrus rankCirrus
    Feb 27, 2018

    I think Python SDK is a good tool for generating a similar report.You can acces to the resources of the collections and print the information you want, IP, port, pool. Example for collecting VS information:

    !/usr/bin/python
import f5.bigip

from prettytable import PrettyTable 

mgmt = ManagementRoot(host, user, passwd)

vipas_collection = mgmt.tm.ltm.virtuals.get_collection()
tvipas = PrettyTable(["VS Name","IP","Pool"])

for virtual in vipas_collection:
    if hasattr (virtual, 'pool'):
        tvipas.add_row ([virtual.name,virtual.destination,virtual.pool])
    else :
        tvipas.add_row ([virtual.name,virtual.destination,'N/A'])
tvipas.align = "l"
print tvipas