Using the vRealize Orchestrator Plug-In SDK

The Software Development Kit (SDK) for vRealize Orchestrator plug-ins is a set of libraries and Maven archetypes. It is the recommended way of developing plug-ins for vRealize Orchestrator. The Plug-in SDK provides a collection of interfaces for communicating with the vRealize Orchestrator platform and accessing different services.

Where can I access the vRealize Orchestrator Plug-in SDK

Plug-in development is decoupled from the vRealize Orchestrator platform. You must download and install the Plug-in SDK on your machine. See Download and Install the vRealize Orchestrator Plug-in SDK.

Note: The Plug-in SDK comes bundled as a ZIP package. After unzipping the package, you can find additional installation information in the README.md file in the SDK archive.

For vRealize Orchestrator 8.3 and earlier, you can access the SDK through the vRealize Orchestrator Appliance Maven repository.

Can I use Maven packages that are internal to vRealize Orchestrator and are not part of the SDK

Using vRealize Orchestrator libraries that are not part of the SDK is not recommended. Such libraries can change frequently and compatibility with your plug-in cannot be guaranteed.

There are exceptions to this recommendation, such as use cases where your environment includes legacy plug-ins that use non-SDK libraries.

The Plug-in SDK and other internal packages for vRealize Orchestrator are available as a Maven repository as part of the vRealize Orchestrator Appliance. You can access the repository at https://orchestrator_server_DNS_name:443/vco-repo/.

vRealize Orchestrator Plug-in SDK Services


Service	Description
Configuration	Stores data as configuration elements, such as host names, credentials, and others.
SSL	Provides read access to the Trust store of the platform.
Solution authentication	Provides read access to the solution user token.
Scripting object contributor	Makes possible for a plug-in to register scripting objects at runtime.
Cipher	Encrypts and decrypts strings.