Installation

Requirements

The OpenNMS Velocloud Plugin can be used only with OpenNMS Horizon 31+ or OpenNMS Meridian 2023+.

Deployment via KAR file

The installation of the plugin is simple. Just copy the provided KAR file to your OpenNMS deploy directory. The following example copies the KAR file path/to/opennms-velocloud-plugin.kar to the deploy directory assuming that OpenNMS is installed in /opt/opennms.

$ cp path/to/opennms-velocloud-plugin.kar /opt/opennms/deploy/

After this step you can install the plugin in the OpenNMS Karaf shell:

admin@opennms()> feature:install opennms-plugins-velocloud

echo "opennms-plugins-velocloud wait-for-kar=opennms-plugins-velocloud" | sudo tee ${OPENNMS_HOME}/etc/featuresBoot.d/plugin-velocloud.boot

Deploy from source

After checking out the repository, you can build and install the plugin into your local Maven repository using the following:

$ mvn clean install

To speed up development iterations, use -Dcodegen.skip=true to skip the regeneration of the client model classes.

Now you can add the repository and install the feature in the OpenNMS Karaf shell. Replace <VERSION> with the version you built and want to deploy.

admin@opennms()> feature:repo-add mvn:org.opennms.plugins.velocloud/karaf-features/<VERSION>/xml
admin@opennms()> feature:install opennms-plugins-velocloud

Boot

To ensure that the feature is activated on future service restarts, add the feature to a file in featuresBoot.d:

echo "opennms-plugins-velocloud wait-for-kar=opennms-plugins-velocloud" | sudo tee ${OPENNMS_HOME}/etc/featuresBoot.d/plugin-velocloud.boot