PaloAltoNetworks / PaloAltoNetworks/pan-os-python

document how to use delete_similar

Open
#498 2 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://pan-os-python.readthedocs.io/en/latest/howto.html#optimize-with-bulk-operations

Describe the problem

doc mentions delete_similar as an alternative to delete to perform bulk delete, but it's not clear how this feature should be used.

if calling fw.remove(obj) on an AddressObject, next call to obj.delete_similar() fails with an exception

No PanDevice set for object tree

Suggested fix

can the documentation include an example of usage of delete_similar ?

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 at the linked howto.html section, “Optimize with bulk operations,” and review the existing delete_similar documentation and related usage. Add an example showing the correct usage after fw.remove(obj), including enough context to avoid the reported exception, and confirm the example clearly explains the expected bulk-delete behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.