PaloAltoNetworks / PaloAltoNetworks/pan-os-python

ApplicationObject's refreshall limits to 50 results

Open
#602 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
400
Forks
199
PR merge metrics
No merged PRs in 30d

Description

Documentation link

https://github.com/PaloAltoNetworks/pan-os-python/blob/develop/examples/bulk_address_objects.py

Describe the problem

The documentation does not mention that the Panorama SDK paginates Application objects with a default limit of 50, and the pan-os-sdk does not automatically handle pagination.

As a result, calling:

objects = ApplicationObject.refreshall(panorama)

returns only 50 application objects, even when more exist.

There is also no documented method in the SDK (such as chunk_size or limit) to override the limit or to auto-paginate, which leads to confusion.

Is it possible to fetch all the objects using pagination or any other approach ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with examples/bulk_address_objects.py, linked in the issue, and review how ApplicationObject.refreshall is presented there. Document the 50-object pagination behavior and the supported way to retrieve additional objects, if one is available in the SDK. The documentation is done when users can understand the limit and how to fetch all results.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.