HQU Sane Direct

Plugin: SaneDirect (the sane redirector)
Version: 0.4
Works With: HQ 3.2.2 or greater
File: hqu_sanedirect-0.4.tgz

Description

This plugin allows you to easily deep-link into HQ. It provides well-known URLs that external applications can use to be redirected deeply within HQ. In addition, SaneDirect is a useful plugin for getting resource IDs, based on their names.

Use the specified URL, and HQ will respond with an HTTP redirect to the target page.

Installation

Installation of an HQU plugin involves moving the plugin directory into HQ's deployment.

tar -xzvf hqu_sanedirect-0.4.tgz
mv sanedirect /my/hq-engine/server/default/deploy/hq.ear/hq.war/hqu

Usage

HQ's resource hierarchy involves 'Platforms', 'Servers', and 'Services'. You can navigate to a platform by specifying it's name (or id). To navigate to a server, you will also need to specify the platform which hosts it. A service needs the same information for the platform, but also the server.

If you know the ID of the resource you are looking for (from EAM_PLATFORM, SERVER, SERVICE), or the resource (EAM_RESOURCE), you can avoid knowing any hierarchical information. Simply specify platformId, serverId, serviceId, or resourceId

Sounds confusing, but the examples splain all.

Navigate to a Platform (by name)

http://localhost:7080/hqu/sanedirect/sane/redirect.hqu?platform=Travistation.local

Navigate to a Server (by name)

http://localhost:7080/hqu/sanedirect/sane/redirect.hqu?platform=Travistation.local\
                                                       &server=My Postgres 8.1

Navigate to a Service (by name)

http://localhost:7080/hqu/sanedirect/sane/redirect.hqu?platform=Travistation.local\
                                                       &server=My Postgres 8.1\
                                                       &service=EAM_RES_GRP_RES_MAP table

Navigate to a Server (by ID)

http://localhost:7080/hqu/sanedirect/sane/redirect.hqu?resourceId=10334

Navigate to a Server's Alert page

http://localhost:7080/hqu/sanedirect/sane/redirect.hqu?resourceId=10334&context=alert

Get ID information about a resource

http://localhost:7080/hqu/sanedirect/sane/getInfo.hqu?platform=Travistation.local

results in:

<resources>
  <resource name="Travistation.local" id="10521" prototypeId="10019" prototypeName="MacOSX"/>
</resources>

Get a Metric chart for a resource

http://localhost:7080/hqu/sanedirect/sane/redirect.hqu?resourceId=10740&chart=Free Memory