cancel
Showing results for 
Search instead for 
Did you mean: 
bbota
Level 7
Report Inappropriate Content
Message 1 of 7

ePO API Scripting Guide

Everyone,

  

One of my customers is trying to automate “exporting” certain tasks from ePO.  After reviewing the attached documentation , they have downloaded the curl https command line module for Windows.  They can make a connection into their existing ePO server and query on the core.help command.  However, when they run the following command below they need some clarification on the command line arguments which are not clear in the guide.”

curl -k -u usernameSmiley Tongueassword https://localhost:8445/policy.export productID

 

  1. 1) What is the “productId” argument referring to specifically? Are there some examples that can be provided?
  2. 2) What is the command line option/argument to export this directly to .xml file.  Are there some examples that can be provided?
  3. 3) Are there additional commands that are no listed in the attached guide that help automate “exporting” the following tasks below that could be provided?

  • Client Tasks
  • Client Tasks Assignments
  • Policy -All
  • Policy Assignments
  • Sitelist
  • Permissions Sets
  • Security Keys
  • System Tree

Lastly, if using curl is not the preferred method to achieve this, can someone suggest how they could accomplished this without having to resort to Python?

Nevertheless, if they go the route of having to use Python, can it support scripting these tasks with your API?

Please let me know. Thank you.

6 Replies

Re: ePO API Scripting Guide

Hi

Taking a look at the help data returned from the API for the command you want to use we get:

policy.export productId [fileName]

Exports policies to an XML file in export folder

Requires view permission for at least one product

Parameters:

productId (param 1) - Product ID as returned by policy.find command

fileName (param 2) - Location within the export folder for the XML file to be

stored, e.g. foo.xml, foo/foo.xml, etc.

The product ID refers to the product ID in ePO, so for example Viruscan 8.8 = VIRUSCAN8800, which matches the Product folders in the software folder on the ePO server in <epoinstallfolder>\DB\Software\Current

so if you wanted to export policies for VSE for example the API call would look like:

curl -k -u usernameSmiley Tongueassword "https://localhost:8445/remote/policy.export?productId=VIRUSCAN8800&fileName=foo.xml"  and you should get a response like:

OK:

Exported to 'D:\reports\foo.xml'.

If you also run

curl -k -u usernameSmiley Tongueassword https://localhost:8445/remote/core.help you will get a full list of API commands available to you.

Regards

Rich

Volunteer Moderator

Certified McAfee Product Specialist - ePO

bbota
Level 7
Report Inappropriate Content
Message 3 of 7

Re: ePO API Scripting Guide

Thank you Richard.

Re: ePO API Scripting Guide

  1. ProductID is the Product code in the database, for example VSE 8.8 is ProductID VIRUSCAN8800. To export the policies you can use this URL: https://eposerver:8443/remote/policy.find?searchText=VIRUSCAN8800
  2. Output to XML, using the example above: https://eposerver:8443/remote/policy.find?searchText=VIRUSCAN8800&Smiley Surprisedutput=xml (add &Smiley Surprisedutput=xml to the end)
  3. Use https://eposerver:8443/remote/core.help to find the commands in YOUR ePO. Since the API commands are controlled by the extensions, everyone’s available commands will differ. You can then use https://eposerver:8443/remote/core.help?command=policy.find (replace policy.find with your favorite) to get the options for the command.

Language preference: Any one you want. I have used C# to interface ( https://community.mcafee.com/docs/DOC-5079 ) and ASP web pages with C# ( https://community.mcafee.com/docs/DOC-6398 ).

Other Notes:

The API Explorer (https://community.mcafee.com/docs/DOC-2931) is old but is a big help with syntax, along with the scripting guide.

https://community.mcafee.com/community/business/epo/epo_web_api


Lastly, we will be talking about the Web API at FOCUS 2015, Session 89: Advanced McAfee ePO Techniques: Making ePO Work for You!


Please mark answered if appropriate!

richg
Level 7
Report Inappropriate Content
Message 5 of 7

Re: ePO API Scripting Guide

I wasn't able to attend FOCUS 15.  Can I get a copy of your presentation, please?

Re: ePO API Scripting Guide

Yes.  All the sessions are posted :  Presentations Login.

Please contact your sales or support manager for the login.

richg
Level 7
Report Inappropriate Content
Message 7 of 7

Re: ePO API Scripting Guide

Thanks, Eric, but that site requires a password I don't have (presumably because I didn't attend the conference).  Is there another way to get the presentation?