Turbonomic REST API Series Part 1: Introduction to Use Cases

Blog Post created by eva.tuczai on Sep 15, 2014

Turbonomic's solution automates the answers to the question "Where and how exactly can I run my workload to assure performance while simultaneously run the infrastructure as efficiently as possible?"  Did you also know our flexible platform also allows you to easily extract and externalize data, and integrate our analytic engine into other areas of your IT Management whether Incident Management, Orchestration and Provisioning, and more.


Turbonomic's Eva Tuczai and cud (Chris Despopoulos) will be writing a multi-part blog post series to review Data Extraction and Integration Use Cases for the Turbonomic REST API, along with real world examples.


Part 1 is the Introduction to Use Cases.  There are at a high level 2 types of use cases: extract data/results, and interact with the Turbonomic Economic Scheduling Engine to either introduce changes or ask a question to get an answer.  Ok, maybe that is three.  Before we dive into usage, let's briefly explore the 2 more commonly used methods to request data or information from Turbonomic: REST API and SQL Query.  As a comparison, consider this table below of Use Cases and where each of these methodologies are either very well suited ( ++ ), does the job ( + ), or not applicable (NA):


Data Extraction and Integration Use CasesSQL QueryREST APINotes
Monitored / Utilization Values: Historical+++1
Monitored / Utilization Values: Current (last 2 hours)NA++1
Capacity Values: Historical+++1
Capacity Values: Current (last 2 hours)NA++1
Capacity Dashboard ResultsNA++
Running Plans and collecting ResultsNA++
Requesting Placement Results (Deploy and Reservations)NA++
- collect, notify, invoke
Log of Actions executed++2
Inventory of Objects Managed+       ++

Administration and Configuration (create, get, delete)

- users, user groups

- entity groups

- templates

Output formatCSVXML


NA = The data is not available in this format

1 = Values for objects (VM, PM, etc).  Most groups will be summarized.

2 = Other options available


You can see that the REST API has some clear advantages over SQL, but SQL if you are familiar with it affords the most flexibility if you just want to extract historical data.  If you are interested in using SQL, check out this blog post in the KB section (Customer Access Only) that gives you tips on how to remotely connect up to our relational MySQL DB: Remote Connections to the VMTurbo Database  And if you would like us to cover how to use it, let us know.


Tell us other use cases that you can think of that you would like us to cover!  Put your ideas as comments to this article.

Look for our next post where we will give an Overview to the Turbonomic REST API.


Here's to the Desired State!
Eva and Chris


Part 2 published here: VMTurbo REST API Series Part 2: First Things First

Part 3 published here: VMTurbo REST API Series Part 3: Ready, Set, Actions!