Transcription
Traverse DevelopersGuideVersion R95January 25, 2021
Copyright AgreementThe purchase and use of all Software and Services is subject to the Agreement as defined in Kaseya’s“Click-Accept” EULATOS as updated from time to time by Kaseya athttp://www.kaseya.com/legal.aspx. If Customer does not agree with the Agreement, please do notinstall, use or purchase any Software and Services from Kaseya as continued use of the Software orServices indicates Customer’s acceptance of the Agreement.” 2019 Kaseya. All rights reserved. www.kaseya.com
ContentsPreface . 7BVE FlexAPI Protocol Reference . 9Traverse Perl API . 43External Data Feed (EDF) Reference . 53Web Services API . 59Traverse REST API . 67Traverse CLI (Command Line Interface) . 71External Authentication . 85Plugin Monitors . 89Troubleshooting . 98Plugin Actions . 99Index . 107i
Preface1
PrefaceContentsPreface . 7BVE FlexAPI Protocol Reference . 9Overview . 9Connecting to the Server . 9Disconnecting from the Server . 9Command/Reply Formatting Rules. 10Client Commands . 11action.x . 12action.create . 12action.delete . 12action.list . 12action.update . 12action.report . 13adminClass.x . 13adminClass.create . 13adminClass.delete. 13adminClass.list . 13adminClass.update . 14adminGroup.x. 14container.x . 14container.create . 14container.delete. 16container.list . 16container.members . 17container.status . 18container.update . 18department.x . 19department.create . 19department.delete . 20department.list . 20department.resume . 20department.suspend . 20department.update . 20device.x . 21device.create . 21device.delete. 21device.export . 22device.list . 22device.move. 23i
Prefacedevice.rescan . 23device.resume . 23device.status . 23device.suspend . 23device.update . 23dependency.x . 25dependency.create. 25dependency.delete . 25dependency.list . 25dge.x . 25dge.create . 25dge.delete . 26dge.list . 26dge.update . 26dgeX.x . 26dgeX.create . 26dgeX.delete . 26dgeX.update. 27dgeX.list . 27discovery.x . 27discovery.create . 27discovery.update. 27discovery.list . 27discovery.delete . 27discovery.cancel . 27event.list . 27hotspot.x . 28hotspot.create . 28hotspot.list . 28hotspot.update . 28hotspot.delete. 28location.x . 29location.create . 29location.delete . 29location.list . 29location.update. 29map.x . 31map.create . 31map.update . 31map.list . 31map.delete . 31result.list . 31sla.x . 31sla.create. 31sla.update . 32ii
Prefacesla.delete . 32sla.list . 32sla.status. 32test.x . 32test.create . 32test.delete . 35test.list . 36test.resume . 36test.status . 36test.suppress . 36test.suspend . 37test.update . 37user.x . 37user.create . 37user.delete . 38user.list . 38user.represent . 38user.update . 38userClass.x . 39userClass.create . 39userClass.delete. 39userClass.list . 39userClass.update . 39Further Examples. 39Creating a New Device and Test. 39Creating an Advanced Port Test . 40Creating a New Test Container and Placing It in a New Device Container . 40Traverse Perl API . 43Overview . 43Zyrion::ExternalData - EDF API . 43new . 43[GetErrorMsg]. 44Login . 44Logout . 44[InsertResult] . 44Zyrion::Message - ISM API. 45new . 45[GetErrorMsg]. 45Login . 45Logout . 46[InsertMessage]. 46Zyrion::Provisioning - BVE API . 46new . 47CreateX, ListX, UpdateX, DeleteX, SuspendX, ResumeX, ExportX, MoveX . 47GetContainerMembers . 47iii
PrefaceGetResultCount. 48GetResultRef . 48GetResultSet . 48GetXStatus . 49Login . 49Logout . 49GetErrorMsg . 50Further Examples . 51Finding Tests Without Actions Assigned. 51Creating a Custom SNMP Test . 51External Data Feed (EDF) Reference . 53Overview . 53Connecting To The Server . 53Disconnecting From the Server . 54Command/Reply Formatting and Commands . 54Client Commands . 54Templates for EDF Tests. 56EDF versus Plugin Monitors . 57Examples . 57Web Services API . 59Overview . 59Traverse Web Services API Workflow . 59Time Expressions . 60Object Filter . 61Traverse WSDL Files . 62Sample Code . 62Session Establishment . 62Types . 63Containers, Devices & Tests . 64Events Service . 65Traverse REST API . 67REST API Overview . 67REST Command Format . 67Special Characters in REST Commands . 68REST Commands in Traverse . 68Login . 68WhoAmI . 68Logout . 68Devices.List . 69showPassword:true . 69Traverse CLI (Command Line Interface) . 71Overview . 71Prerequisites . 71General Syntax. 71Configuration File . 72iv
PrefaceSession Management . 73Running A Query . 73Search Filter . 77Batch Processing . 78Field Selection. 80Output Format . 81Future Enhancements . 83External Authentication . 85Overview . 85Authentication Plugin Java Class . 85Architectural Description . 86Authentication Plugin Script . 86Web URL Authentication. 88Plugin Monitors . 89Overview . 89Adding A New Test Type. 89Creating A New Plugin Java Monitor . 91Configuration File Format . 91Writing The Plugin Class . 93Configuring the Plugin Package . 93Provisioning Plugin Tests . 93Creating A New Plugin Script Monitor. 94Configuration File Format . 94Writing The Plugin Script .
Web Services interface for Kaseya Traverse. Audience This guide is intended for administrators and programmers who are familiar with the Traverse software and wish to extend its functionality using the provided APIs and Web Services interface. Upgrading from NetVigil
