Home

TbUtil 2.1c - Wiki Home Page

Date: Thu 11 Aug 11:54:43 BST 2022

Welcome to the TbUtil documentation wiki!

"tbutil" is a swiss-army-knife command line utility for accessing a running Turbonomic instance using the REST API (and other access methods). The utility provides a number of low and high level function abstractions, the full list of which can be displayed by running "tbutil" with no command line arguments.

64-bit executable binaries are available for the Linux, MAC (aka "Darwin") and Windows operating systems.

The tool is written in the Golang and JavaScript languages and makes extensive use of the Turbnomic GoLang API client library (turbo-api-client-lib).

TButil includes an embedded JavaScript engine that can be used to format the output of queries or drive the API directly. A slightly extended instance of the pure-go "OTTO" JavaScript engine is used for this purpose. Note: "OTTO" is not "NODEJS", and attention has been paid to keeping scripts as simple as possible (there is no need to wrestle with the complexities of asynchronous I/O or promises).

Documentation

• Introduction to TbUtil
  • Command line conventions
  • Usage examples
  • Environment variables used by TbUtil
  • Files used by TbUtil
  • Change Log
• Download, Installing and Configuring TbUtil
  • Quick install instructions - when not using a pre-packaged Pod.
  • Installing for IWO
  • Pre-packaged Pod installation
• TbUtil Credential handling.
• TbUtil sub commands
• TbUtil pre-packaged Pods
  • Pod installation instructions
  • yamlmaker tool
  • Internals of the TbUtil Pods
  • Pod Flavours
    • Base Pod (TbUtil with no additional features or plugins).
    • Action Script foundation.
    • Adoption Review - aka "Health Check" - automated documentation creator (for Turbonomic field staff use).
    • ChromeDP - take UI screen shots from the command shell.
    • Flexera Integration.
    • Hot-Warm backup.
    • Report Mailer - extract PDFs and CSVs from Grafana reports, and mail at configured times.
    • Full Pod (many feature pods combined into one).
• TbUtil scripting
  • A brief introduction
  • TbScript's Otto JavaScript interpreter
  • ECMA Script 6 features supported in TbScript
  • JavaScript Add-in functions for TbScript
  • Scripting Example: Running Plans using TbScript
  • Turbonomic REST API documentation for TbUtil
  • REST API error handling
  • Plug-Ins that provide access to third party APIs or file types for TbUtil scripts.
    • Introduction to creating new TbUtil Plugins
    • API V1 plugin
    • ArangoDB plugin
    • ChromeDP Plugin
    • EXCEL plugin
    • Image plugin for TbUtil
    • Kafka plugin
    • MongoDB plugin for TbUtil
    • MySQL Plugin
    • PDF Plugin
    • SMTP Plugin
    • SqLite3 Plugin
    • SYS Plugin
    • vCenter plugin
    • XML Plugin
• Tutorials
  • Configuration export and import

License

TBUtil is built in the GO language from opensource components. Tbutil and the majority of its componets are licensed with the Apache License V2.0 (Jan 2004), but some use different licenses.

The component license files and source code (where the license mandates that it is provided) can be browsed here.