PaloAltoNetworks / PaloAltoNetworks/pan-os-python

network module docs for network.Dhcp doesn't contain info about defining/reading DHCP leases

Open
#494 1 comment 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/module-network.html#panos.network.Dhcp

Describe the problem

In the Palo Alto Firewall Web UI, if you go into the Network -> DHCP tab, you can see a list of interfaces along with IP ranges and Reserved addresses. However in the documentation, there is a single parameter, name.

Is the documentation correct? Is there currently no way to get information on DHCP leases using panos? I created a firewall instance and retrieved info on dhcp, which correctly shows the Layer3Subinterface names but nothing else:

dhcp_list = network.Dhcp().refreshall(fw)
for d in dhcp_list:
    print(d.about())

Which returns the following

{'name': 'ae1.10'}
{'name': 'ae1.20'}
{'name': 'ae1.60'}
{'name': 'ae1.100'}
{'name': 'ae1.102'}

So only name parameter is implemented so far for network.Dhcp?

Suggested fix

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 the linked module-network documentation and the network.Dhcp entry point, including its refreshall() and about() behavior. Determine whether DHCP lease, range, and reservation data is supported or exposed only as the interface name. Done means the documentation accurately lists the supported fields and explains any current limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.