PaloAltoNetworks / PaloAltoNetworks/pan-os-python
Partial XPath support no longer supported in PAN-OS 11.0
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 400
- Forks
- 199
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
Partial XPath support was dropped in PAN-OS 11.0. The create() function in pan-os-python issues set commands with a partial XPath value for the newly created configuration object. This results in inconsistencies when performing partial commits on Panorama. Changes made by specific administrators are not pushed to the managed firewalls when a partial commit is performed.
Expected behavior
The set commands generated from the create() function should include the object entry on the XPath string.
Example:
<request cmd='set' obj="/config/devices/entry[@name='localhost.localdomain']/device-group/entry[@name='Lab Testing']/address/entry[@name='Address A']" cookie='1357220402109258' client='xmlapi' refresh='no'><ip-netmask>192.168.200.10/32</ip-netmask><description>Address A added by notbob from Postman</description></request>
Current behavior
The set commands generated from the create() function strip out the object entry suffix on the XPath string. A xpath_short() function is called to perform this truncation.
Example:
<request cmd='set' obj="/config/devices/entry[@name='localhost.localdomain']/device-group/entry[@name='Lab Testing']/address" cookie='4859959213841190' client='xmlapi' refresh='no'><entry name="Address B"><ip-netmask>192.168.120.8/32</ip-netmask><description>Address B added by bob from Ansible</description></entry></request>
Possible solution
The create() function must specific the complete XPath with entry suffix in all set commands.
Steps to reproduce
- Create a new address object via the
create()function against Panorama 11.0.3-h3 or later. - Commit and push changes made by the specific administrator,
- The newly created object does not appear on the managed firewall.
Context
This issue impacts all users of the Ansible collection for PAN-OS.
Your Environment
- Version used: Panorama 11.0.3-h3 or later
- Environment name and version (e.g. Chrome 59, node.js 5.4, python 3.7.3): Python 3.10.14
- Operating System and version (desktop or mobile): MacOS 14.5
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 by locating the create() function and the xpath_short() helper, then reproduce creation of an address object against PAN-OS 11.0.3-h3 or later. Trace the generated set commands and verify that the object entry remains in the XPath; done means a partial Panorama commit pushes the new object to the managed firewall.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ansible, python
- Domain
- backend-api-design, networking
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100