PaloAltoNetworks / PaloAltoNetworks/pan-os-python

Pull LLDP Peer data from EthernetInterfaces

Open
#463 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem?

I want to verify physical patching towards firewalls has been carried correctly. To do this, I'd like to get the LLDP frames received on the firewall EthernetInterfaces in a programmatic way

Describe the solution you'd like

EthernetInterface should have a peers (or lldp_peers) property, which should be a list of peers

[{"port-id": "Ethernet1", "system-name": "my-neighbor"}]

(I've only written down 2 fields, but there are more currently exposed by the HTTP API feeding the UI at LLDPRuntime.getLLDPPeers)

Describe alternatives you've considered

Using the API, but I've not managed to get a good reply from the firewalls, so I'm not sure if this is supported (/Network/EthernetInterfaces is returning 0 results for me, while access via pan-os-python does return the interfaces)

Additional context

I am currently unable to confirm (programmatically) whether the patching carried out is correct or not.

If this is currently possible to achieve via the API, I'd also be happy to do that until implemented in pan-os-python

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 EthernetInterface model and the HTTP API data exposed by LLDPRuntime.getLLDPPeers. Compare that response with the existing pan-os-python interface access and determine how the LLDP peer fields should be exposed through EthernetInterface.peers or EthernetInterface.lldp_peers; done means the requested peer data can be retrieved programmatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.