Plugins
Plugins are modular pieces of code that allow your system to perform specific activities.
Plugins are organized in groups called plugin bundles. When adding or removing plugins from your system, you work with plugin bundles, not individual plugins.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.
Viewing installed plugins
Use the Administration App, REST API, and CLI to view all plugin bundles and individual plugins that have been installed. You can view all individual plugins at the same time or filter the list based on plugin type.
Administration App instructions
1.Click on System Configuration.
2.Click on the Plugins .
The Plugin Bundles tab shows all installed plugin bundles.
3.To view all individual plugins, click on the All Plugins tab.
4.Click on the other tabs to view only certain types of plugins.
Related REST API method(s)
GET /plugins
For information on specific REST API methods, in the Administration App, click on the help icon (). Then:
•To view the administrative REST API methods, click on Admin API.
•To view the API methods used for performing searches, click on Search API.
For general information about the administrative REST API, see REST API reference.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.
Upgrading plugin bundles
To upgrade plugins, you upload a new version of the bundle that contains those plugins.
You can select which version of the plugin bundle is the active one (that is, the one that connectors or stages will use). If you select the new version, all connectors and stages immediately begin using the new versions of the plugins in the bundle.
You can change the active plugin bundle version at any time. For information on doing this, see Setting the active plugin bundle version.
Administration App instructions
To install a plugin:
1.Click on System Configuration.
2.Click on the Plugins .
3.Click on the Upload Plugins button.
4.In the Upload Plugins window, drag and drop the new version of the plugin bundle.
5.In the list of plugin bundles, click on the row for the plugin bundle version that you want.
If the bundle you uploaded isn't listed, click on the Reload button.
6.Click on the Set Active button.
Related CLI command(s)
uploadPlugin
setPluginBundleActive
For information on running CLI commands, see CLI reference.
Related REST API method(s)
POST /plugins/upload
POST /plugins/bundles/{name}/{bundleVersion}/active
For information on specific REST API methods, in the Administration App, click on the help icon (). Then:
•To view the administrative REST API methods, click on Admin API.
•To view the API methods used for performing searches, click on Search API.
For general information about the administrative REST API, see REST API reference.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.
Setting the active plugin bundle version
If you've uploaded multiple versions of a plugin bundle, only one version can be active at a time. The active plugin bundle version is the one that the system uses.
When you change the active version of a plugin bundle, any workflow tasks that contain connectors and stages that use the bundle immediately begin using the new active version.
Administration App instructions
To set the active plugin version:
1.Click on System Configuration.
2.Click on the Plugins .
3.Click on the row for the plugin bundle version that you want.
4.Click on the Set Active button.
Related CLI command(s)
setPluginBundleActive
For information on running CLI commands, see CLI reference.
Related REST API method(s)
POST /plugins/bundles/{name}/{bundleVersion}/active
For information on specific REST API methods, in the Administration App, click on the help icon (). Then:
•To view the administrative REST API methods, click on Admin API.
•To view the API methods used for performing searches, click on Search API.
For general information about the administrative REST API, see REST API reference.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.
Deleting plugin bundles
To delete plugins from your system, you delete plugin bundles from the system. You cannot delete individual plugins.
You cannot delete a plugin bundle, or any of its versions, if any of that bundle's plugins are in use by the system. For example, if the MyCustomPlugins bundle contains a stage plugin that is used by a processing pipeline, you cannot delete MyCustomPlugins.
Administration App instructions
To delete a plugin bundle:
1.Click on System Configuration.
2.Click on the Plugins .
3.Click on the delete icon () for the plugin bundle you want to remove.
Related CLI command(s)
deletePluginBundle
For information on running CLI commands, see CLI reference.
Related REST API method(s)
DELETE /plugins/bundles/{name}/{bundleVersion}
For information on specific REST API methods, in the Administration App, click on the help icon (). Then:
•To view the administrative REST API methods, click on Admin API.
•To view the API methods used for performing searches, click on Search API.
For general information about the administrative REST API, see REST API reference.
Trademarks, Legal disclaimer, Third-party software in this documentation
© 2017 Hitachi Vantara Corporation. All rights reserved.