PaloAltoNetworks / PaloAltoNetworks/pan-os-python
Commit Lock / Configuration Lock not documented
Nobody has claimed this yet.
- 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/search.html?q=lock&check_keywords=yes&area=default#
Describe the problem
The pan-os-python code includes Configuration Lock and Commit Lock features, however I cannot find any documentation on them. I am not sure if this is just documentation not being up to date, or there is some other reason (i.e. features not working across different PAN-OS versions or something like that)?
Suggested fix
Add documentation regarding the Configuration Lock and Commit Lock features.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with panos/base.py around line 4367 and the linked documentation search page to understand where Configuration Lock and Commit Lock are exposed. Documentation is complete when both features, including any PAN-OS version or usage limitations found during review, are described in the project docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100