Install Plugins SDK

The ActiveGate Plugins SDK provides you with all the resources and means necessary to develop your own ActiveGate plugins. To get started with the ActiveGate Plugin SDK, follow the steps below.

Download

Sign in to DESK and go to Settings > Monitored technologies > Add new technology monitoring > Add ActiveGate plugin > Download Plugin SDK

Extract the downloaded ZIP file. It contains docs, examples, and the whl file that's required for installation (for example, plugin_sdk-1.156.0.20181003.61122-py3-none-any.whl).

Installation

You need the following to install the SDK:

• ActiveGate plugin module installed and running on the Environment ActiveGate you'll use to run your plugins. ActiveGate version 1.175+ has the plugin module installed by default.
• Python 3.6.6 with PIP installed.

To install your downloaded SDK use:

pip3 install plugin_sdk-version.whl

For example:

pip3 install plugin_sdk-1.156.0.20181003.61122-py3-none-any.whl

Deployment

Once you've written your plugin, you can use the SDK to build it and upload it to the server. If you want to simply validate your plugin.json file type:

plugin_sdk build_plugin --no_upload

If you want to upload your plugin to the server, type:

plugin_sdk upload_plugin -t yourtoken

For your plugin development, you can also use the ActiveGate plugin simulator.

Troubleshooting

If after deploying your ActiveGate plugin the results are different from your expectations, check troubleshooting to find out what went wrong.

Configuration

Following successful deployment, you should see your plugin ready for configuration.

Development

The ActiveGate plugins how-to topics will guide you through the key concepts of ActiveGate plugin development with examples and working code snippets to facilitate your own plugin development.