topic Re: API & Custom reports in Automation/API Discussions

API & Custom reports

adeboss — Thu, 01 Sep 2011 10:03:58 GMT

Hi,

I want to change my custom reports time frame just before executing them, using the XML API.

Here is how I proceed:

Modify the <start-time> and <end-time> using a "action=edit" API request
Pull the results out my report with a "type=report&reporttype=custom" API request

The first step works fine, I see the time frame modification in the web interface and the config logs.

But when I pull the results, the new time frame is not taken into account. It seems that the "running config" time frame is used, instead of the one in the "candidate config".

How can I manage to make it work without doing a commit ?

Regards,

Adrien

Re: API & Custom reports

mbenoit — Thu, 01 Sep 2011 16:02:29 GMT

Hi Adrien,

Unfortunately the system requires that you commit the custom report changes prior to being able to invoke them using the API, unlike the 'run now' function in the gui.

Regards,

Marc

Re: API & Custom reports

adeboss — Fri, 02 Sep 2011 08:45:23 GMT

Hi Marc,

Ok, too bad the API doesn't mimic the GUI behavior.

Any chances the commit requirement will be lifted in a next version ? Or that the "starttime" and "endtime" parameters are going to be supported when requesting custom reports through the API ?

On another note, it seems you have edited some lines out of your post, about committing through the API being possible since v4.0.2.

I didn't try it out nor found any documentation about it. Is it ready for "prime-time" ?

Regards,

Adrien

Re: API & Custom reports

mbenoit — Fri, 02 Sep 2011 15:51:51 GMT

Hi Adrien,

Yes... I ammended my post because the commit API feature is officially in version 4.1 which is in beta testing currently. Have you checked out the updated Perl Package for interacting with the XML API? There are many useful libs to simplify scripting efforts...

Current version is located here:

https://live.paloaltonetworks.com/docs/DOC-1910

I will take a look to see if <period> will be supported with custom reports....

Regards,

Marc