Beyond the Admin App: FileWave Extensibility with the RESTful API

Transcription

1 Beyond the Admin App: FileWave Extensibility with the RESTful API FileWave s RESTful API enables two-way communication between FileWave s database and external databases. Using this API, administrators can more fully leverage FileWave s rich endpoint data to create custom dashboards, or to integrate with other management tools. We'll also take a look at the power of the FileWave Admin command line, and even give a sneak peek of some upcoming features Jonathan Kane Systems Engineer Jonathan.Kane@filewave.com Ashlee Jamison Account Executive Ashlee.Jamison@filewave.com Dave Herder Systems Engineer Manager dave.herder@filewave.com

2 What is FileWave? Since 1992, FileWave has provided an industry-leading cross-platform client management solution with an easy-to-use console. A robust, scalable unified endpoint management solution Perfect for the cycle of imaging, deploying, managing, and maintaining your technological assets Plan & Architect Maintain Image & Deploy Manage

3 FileWave Components FileWave Server FileWave Admin FileWave Client Booster Imaging Virtual Server Engage

4 Supported Clients Desktop/Laptop Clients OS X 10.8*, x86 64 (binaries are 64 bit only) * Legacy Client Windows, 7, 8, 8.1*, 10, and Windows Server 2008 R2, 2012*, and 2012 R2 *Server 2012 and Windows 8/8.1 - Legacy 11.2.x) Mobile Clients ios 8, 9, 10, 11 Android 4.1, 4.2, 4.3 (Jelly Bean), 4.4 (KitKat), (Lollipop), (Marshmallow), (Nougat) Chrome OS Support Inventory, Location Tracking, Engage

5 Server Host Requirements For all, 4GB + RAM, and 100GB+ HDD space, dedicated network interface, fixed IP address, and FQDN Mac OS X (server not required) or higher Windows Win Server 2016 R2 / 2012 R2 or higher Linux CentOS 5.11, 6.8, 7.3 (binaries are 64-bit only) Univention Corporate Server Virtual Appliance (vsphere/hyper-v)

6 Understanding Filesets Every item distributed to a FileWave client is contained within a Fileset. These are the Fileset types for computers

7 TCP/IP Ports used with all Components FILEWAVE USES A PROPRIETARY TCP/IP PROTOCOL AND HTTPS FOR CONNECTIONS BETWEEN ALL COMPONENTS Google Cloud Apple Push ,80 443: fwks.filewave.com / 80 : Apple & Microsoft SERVER BOOSTER (SSL, DEFAULT) (HTTPS / Profiles & MDM) (HTTPS / Inventory) (SSL) CLIENTS (Admin) (Inventory) (Dashboard) > < ENGAGE 443 KIOSK IVS 69, 80, , ADMINS (CLIENT MONITOR)

8 MDM for ios Ports and MDM enrolled macos devices MDM PORT 443 fwks.filewave.com PORT 2195 PORT (SSL) PORTS PORT 443 APPLE PUSH Network /8 PORT 5223 Mobile PORT 443 ADMINS PORT 443 itunes STORE Network /8

9 What is the RESTful API?

10 What can we do with the FileWave RESTful API? Get data from FileWave via Inventory Queries and License Management Reports Create Inventory Queries and License Management Reports Delete Inventory Queries and License Management Reports Push inventory data into FileWave via PATCH method (out of scope today) Nothing that we will do today is directly supported by the FileWave Support Team outside of the API itself...that is, your code is your code, and you will be on your own for that, but we are trying to give you a bit of a head start Note, at this time, there is no exposure of FileWave functionality in the API to perform actions on endpoints

11 Why do I care about the API? You may be saying to yourself...i can get data from FileWave while in the FileWave Admin. Why in the world would I care about doing it programmatically? Sometimes, we need that data but outside of FileWave: We can use the API to give The Boss access to data without risk of more access to the Admin We can use the API to gather Information for a web portal/status board i.e. in a call center Programmatic creation/deletion of queries if you have a need for that workflow Pull data from FileWave to inject into another IT system (Help Desk, etc) There is no right answer here...the API isn t going to be of use to everyone, but we ll give you a sample of it today

12 OK, we can use the API, but how? Before we get started, you definitely want a copy of the FileWave RESTful API Technical Guide, which you can find here: Let s start simply with the use of the command line on the FileWave server (assuming macos or Linux) Let s get a list of inventory queries from our server: curl -s -k -H "Authorization: base64encodedserverkey" python -mjson.tool Curl gives us command line capability to read a web page (the RESTful API is after all, just a web service). -s makes the command NOT show download information -k tells curl to not worry about the ssl cert (can be dropped if valid CA cert is in place) H tells curl to send the extra header information with the request...in this case, our authorization The pipe symbol is used to pass the info to a JSON formatting tool that makes the output easier to read for us mere humans

13 The RESTful API and FileWave

14 Getting Started First off, you will need to grab your inventory key- located in the FileWave Preferences Can also generate it via command line as well - psql -c "SELECT value FROM inventory_preferences WHERE key='shared_key';" -U django -t - A mdm -h localhost -p 9432 Note: Generating a new key each time, will revoke the key, so don t change it. One key right now, but keep your eyes open for future changes Key needs to be converted for now to Base is one of the easiest..s

15 Testing it out There are several ways to test things out a curl command, or an IDE such as PAW - paw.cloud Either way, your Authorization key will be something like : authorization: e2uzmdq0zdk0ltcyzahweuhge81hnzu2ltyymjbmodfhmzhkzx0= BTW, I ve reset my inventory key, so key in screenshots won t work for you! This can be put into a curl command such as : curl -s -k -H "Authorization: e2uzmdq0zdk0ltcyzahweuhge81hnzu2ltyymjbmodfhmzhkzx0=" myserver.filewave.net:20443/inv/api/v1/query/ python -mjson.tool This spits out a bit of information for example

16 favorite = will query show up in Admin, group = which group of queries, id = primary key of the query, name = display name of the query, and version = version number of the query

17 Query API Command We can dig further into an actual query with the command curl -s -k -H "Authorization: e2uzmdq0zdk0ltcyzahweuhge81hnzu2ltyymjbmodfhmzhkzx0=" myserver.filewave.net:20443/inv/api/v1/query/15 python -mjson.tool This will show us the make up of the query- We get the conditions of the query, ie. the items were are looking for We also get the fields, etc that are being returned.

18

19 Requesting Results from a Query curl -s -k -H "Authorization: e2uzmdq0zdk0ltcyzahweuhge81hnzu2ltyymjbmodfhmzhkzx0=" myserver.filewave.net:20443/inv/api/v1/query_result/15 python -mjson.tool

20 Results from query_result API Call

21 Other Options for Queries Client Details curl -s -k -H "Authorization: e2uzmdq0zdk0ltcyzahweuhge81hnzu2ltyymjbmodfhmzhkzx0=" myserver.filewave.net:20443/inv/api/v1/client/details/ b116807b04956e572a4c025fd487eff2baa81bf9/desktopclient python -mjson.tool Add Queries, Delete Queries, and List Components curl -s -k -H "Authorization: e2uzmdq0zdk0ltcyzahweuhge81hnzu2ltyymjbmodfhmzhkzx0 --header "Content- Type: application/json" -X POST of new query.json> myserver.filewave.net:20443/inv/api/v1/query/ python -mjson.tool curl -s -k -H "Authorization: e2uzmdq0zdk0ltcyzahweuhge81hnzu2ltyymjbmodfhmzhkzx0" -X DELETE myserver.filewave.net:20443/inv/api/v1/query/<id#> python -mjson.tool curl -s -k -H "Authorization: e2uzmdq0zdk0ltcyzahweuhge81hnzu2ltyymjbmodfhmzhkzx0=" myserver.filewave.net:20443/inv/api/v1/component python -mjson.tool

22 FileWave Admin Command Line

23 fwcld command Client Status sudo /usr/local/sbin/filewave.app/contents/macos/fwcld -s ************************** **FileWave Client Status** ************************** User ID: Current Model Number: 626 Filesets in Inventory: 1. OSX App - EngageX, ID 244 (version 3) - Installing via Mac App Store (can take some time) 2. ShowKiosk, ID 348 (version 2) - Active 3. OSX App - Evernote, ID 364 (version 2) - Installing via Mac App Store (can take some time) 4. RingCentral for Mac.app, ID 1978 (version 3) - Active 5. FileWave_macOS_Client_12.7.0_314acde, ID (version 1) - Active 6. Enroll Macs into MDM, ID (version 2) - Active 7. FileWave_macOS_Client_12.8.0_06d3d77 3, ID (version 1) - Active Worklist:

24 Filewave Admin Command Line Applications/FileWave/FileWave Admin.app/Contents/MacOS/FileWave\ Admin -h

25

26

27

28 Handy Articles involving RestFUL API How to programmatically write the client device details (macos) to a JSON formatted file using the FileWave REST API (by Dave Herder) How+to+programmatically+write+the+client+device+details+ %28macOS%29+to+a+JSON+formatted+file+using+the+FileWave+REST+API Using the RESTful API to limit, sort, and offset values returned display/kb/using+the+restful+api+to+limit,+sort,+and+offset+values+returned All Customers - Check out - Lots and Lots of video and training New updated knowledgebase and manual at Updated Support at

29 Practical Example +

30 1) Write the client deviceid to file

31 2) Write the client Device Details to file using a GET call

32 3) Parse the device_details.json with some python

33 4) Use Slack webhooks to build a message to post

34 what s the code look like?

35 Upcoming Features and Sneak Peek of the New WebUI

36 Coming Soon (unless released during MacAdmins) Improved encryption across all components Key Escrow Storage for Filevault 2 Personal Recovery Keys Inventory Queries now respect the permissions of underlying permissions of Client, Filesets, etc. Many additional permissions added for FileWave administrators Support for latest Apple ios and Mac releases General Fixes Groundwork laid for new WebUI

37 Login Screen

38 Client Listing

39 Client Details

40 Fileset Listing

41 Client Location

42

43 Questions???