F5Networks / f5-ansible

Imperative Ansible modules for F5 BIG-IP products
GNU General Public License v3.0
375 stars 229 forks source link

bigip_device_info missing documentation #2389

Closed markgraf closed 9 months ago

markgraf commented 9 months ago

version info

what is missing

The documentation for the bigip_device_info mentions a parameter data_increment, but does not provide sufficient information on how to use it.

The parameter can be set to an arbitrary value to configure the paging of returned values, but there is no information on how to get to the next page.

urohit011 commented 9 months ago

Hi @markgraf, here's an example: Suppose you have created 10 vlans on your bigip box and you gather info with bigip_device_info with data_increment set to 5, the module will query the box for the first 5 vlans and then make a subsequent call to fetch the next 5 vlan and then the next 5, and so on. No matter what value is set for data_increment, the result after bigip_device_info execution will have the list of all the vlans on your box.

markgraf commented 9 months ago

Okay, so I always get everything wether I need it or not. Good to know. I'll have some json_query(...) to do, then.

Thanks!