vSphere Integration: Orchestrator Package Details

Table of Contents


The Uptime Orchestrator package allows administrators to integrate Uptime's infrastructure management and monitoring capabilities with Orchestrator's versatile scripting engine.

Integration provides benefits to both solutions: Uptime administrators can create Action Profiles that react to critical events by automatically initiating and providing parameters for Orchestrator workflows; Orchestrator administrators can retrieve values from and act on a Monitoring Station's monitored elements.

How to Trigger Orchestrator Events from Uptime

Configuring Uptime to communicate with VMware Orchestrator

Configuring Uptime to work with Orchestrator is as easy as going to the Config page in the Uptime interface and entering the Orchestrator login info.

  1. Login to the Uptime Monitoring Station interface as a user that has Administrator permissions (must be able to see the Config tab)
  2. Click on the Config tab at the top and click on the "VMware vCenter Orchestrator" link on the left
  3. Click on the "Edit Configuration" button on the top right (screenshot)

  4. Enter all of the appropriate settings for Uptime to connect to Orchestrator
    • Orchestrator Enabled - Check on to use Orchestrator features in Uptime (action profiles)
    • Orchestrator Server - Hostname of system where Orchestrator server is installed
    • Orchestrator Port - Port to connect to Orchestrator (default 8281)
    • SSL - If SSL is enabled on Orchestrator
    • Username - User name to login to Orchestrator
    • Password - Password to login to Orchestrator

  5. Click on the "Test Configuration" button to test if Uptime can properly communicate with Orchestrator
  6. Congratulations! You should now have successfully integrated Uptime with VMware Orchestrator!

    Uptime Workflow Elements

    The following workflows elements are available through the Uptime Orchestrator package, and can be used in Uptime workflows, or in other workflows that include actions on the Uptime Monitoring Station:

    Workflow Element Notes
    Add element to service group Adds an element (found on host > ESX server > node) to an Uptime Service Group by hostname or IP address.
    Add element to view Moves an element to a view, both of which are referenced by their Uptime name. Element IDs are resolved from the names.
    Add ESX host  
    Add agent system  
    Add node  
    Create infrastructure group  
    Create view  
    Destroy element  
    Destroy infrastructure group  
    Destroy view  
    Get service monitor data Both the service monitor metric's name and the host's display name are required.
    Get service monitor status The host's display name is required.
    Get application status The Uptime Application's name must be specified.
    Move element into infrastructure group Moves an element to a group, both of which are referenced by their Uptime name. Element and group IDs are resolved from their names.
    Remove element from service group  
    Remove element from view  
    Trigger external event To trigger the external check, all parameters normally used with extevent.pl must be provided.

    Orchestrator Setup

    Installing the uptime workflow package in Orchestrator

    Installing the uptime workflow package is as simple as downloading it and importing it into Orchestrator.

    uptime produces a package with the namespace: com.uptimesoftware.uptime

    The package file is available here

    1. Login to Orchestrator using the VMware Orchestrator Client
    2. Select the "Packages" section on the left and click on the drop down arrow and select "Import Package..." option (see screenshot below)

    3. Locate the downloaded uptime package file and click Open

    4. Confirm the signature and click on the Import button

      You should now see the uptime workflow package in Orchestrator:

    Configuring Orchestrator to communicate with Uptime

    Now that the uptime workflow package is in Orchestrator, we just need to point it to the Uptime monitoring station.

    1. Click on the Configurations section on the left
    2. Right-click on the "Uptime Configuration" option on the left and click on "Edit"

    3. Enter the Uptime "admin" user name and password and the Uptime monitoring station URL. The URL must be in the following format:
    4. Click on the Save and Close button on the bottom right

Copyright © 2021 IDERA, Inc.   Legal   Privacy Statement