Home

TbUtil 3.4 - Wiki Home Page

Date: mar. 23 janv. 2024 16:45:53 CET

⚠️ ⚠️ TbUtil is NOT supported and comes with no SLA. It's to be used "as-is" as no new features or bug corrections are planned since December 2023. If you need new features or bug corrections, please contact your IBM representative. ⚠️ ⚠️

Popular pages: Commands | Hot/Warm | Installation | IWO | Plugins | REST API | Scripting | SSO/SAML | TAR | Yaml Maker

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 a variety of other access methods). The utility provides a number of low and high level function abstractions. Help on the available sub-commands is available by running tbutil with no 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.

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 keep the writing of 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 and SSO/SAML
• TbUtil sub commands
• TbUtil pre-packaged Pods
  • Pod installation instructions
  • yamlmaker tool
  • Internals of the TbUtil Pods
  • Ready to use flavours
    • Adoption Review - aka "Health Check" - automated documentation creator (for Turbonomic field staff use).
    • Hot-Warm backup.
    • Report Mailer - extract PDFs and CSVs from Grafana reports, and mail at configured times.
  • Foundational PODs for building use cases on.
    • Base Pod (TbUtil with no additional features or plugins).
    • Action Script foundation.
    • ChromeDP - take UI screen shots from the command shell.
    • Full Pod (all TbUtil binaries in one place).
• TbUtil scripting
  • A brief introduction
  • TbScript's Otto JavaScript interpreter
  • TbScript's embedded JS Underscore library v1.4.4
  • ECMA Script 6 features supported in TbScript
  • Add-in functions for TbScript
  • Scripting Example: Running Plans using TbScript
  • 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
    • ArangoDB plugin
    • ChromeDP Plugin
    • EXCEL plugin
    • Image plugin for TbUtil
    • Kubernetes Plugin
    • 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.