topic Automation / API - Register and de-register devices to log-collector group in General Topics

Automation / API - Register and de-register devices to log-collector group

Findus — Wed, 31 Jul 2024 14:56:51 GMT

I am looking for a way to automatically register and de-register a newly created firewall to a specific log-collector group. I had hoped to achieve this with https://github.com/PaloAltoNetworks/pan-os-python but I struggle translating the xml path to work with the op() method.

While running "set log-collector-group collector-group logfwd-setting devices <device-sn> collectors <collector-sn>" I get the following path:

But how do I translate that to something that works with the op() method?

Are there other approaches / solutions that allow automatic registering and de-registering of firewalls to a log collector group?

Re: Automation / API - Register and de-register devices to log-collector group

TomYoung — Wed, 31 Jul 2024 16:58:39 GMT

Hi @Findus ,

Your research is excellent, as is your use of the "debug cli on" command. Your GitHub link has a link to documentation. If you follow it and click on API Reference > Useful Methods, you will see the list of methods. https://pandevice.readthedocs.io/en/latest/useful-methods.html#configuration-methods

You would not use the op() method as that is for executing an operational command (think Operational mode > as opposed to Configration mode #). I have not used the Python PAN-OS SDK. So, I am not sure which method to use or if the log collector is supported in the configuration tree for Panorama in the same documentation page.

With regard to other approaches, there are LOTS of options. A couple that come to mind are (1) curl command or (2) Python requests module. You would need to be familiar with request types and configuration actions which are passed in the URL. https://docs.paloaltonetworks.com/pan-os/9-1/pan-os-panorama-api/pan-os-xml-api-request-types/pan-os-xml-api-request-types-and-actions

A great tool for testing the API is Postman, which is free. https://www.postman.com/. I use it all the time.

Thanks,

Tom

Re: Automation / API - Register and de-register devices to log-collector group

Findus — Thu, 01 Aug 2024 10:35:34 GMT

Hello Tom,

thank you for your response! I previously had a look at the documentation but could not find an object that would fit "log-collector-group" in the documentation. At this point I think this simply isn't supported yet. I'll follow your advice and use something else to utilize the xml-api path instead.

In case anyone else stumbles upon this thread, the path is:

https://{{panorama}}/api/?type=config&action=set &xpath=/config/devices/entry[@name='localhost.localdomain']/log-collector-group/entry[@name='{{LC-group-NAME}}']/logfwd-setting/devices&key={{panorama-key}}&element=<entry name="{{newfw}}"><collectors> <entry name="{{existingLC}}"/> </collectors></entry>

To remove a device the path is the same, but replace the action "set" with "delete".