You can do VMware Tanzu Operations Manager operations programmatically and from the command line, rather than from the Tanzu Operations Manager UI.

Tanzu Operations Manager includes three related tools for performing operations programmatically and from the command line, rather than from the UI:

These three tools control the Tanzu Operations Manager VM at different levels of abstraction. For more information about tile development, see the Tanzu Operations Manager Tile Developer Guide.

The Tanzu Operations Manager API

The Tanzu Operations Manager API offers the most granular control of the Tanzu Operations Manager VM, The API enables users to do the following:

  • Automate component-level testing of Tanzu Operations Manager product tiles

  • Manage Tanzu Operations Manager user accounts

  • Develop and debug product tiles

  • Access product property values that are not exposed in a product tile GUI

  • Otherwise control the Tanzu Operations Manager VM directly, programmatically or manually, bypassing the Tanzu Operations Manager UI. For more information about the Tanzu Operations Manager interface, see Using the Tanzu Operations Manager interface

For information about getting started with the Tanzu Operations Manager API, see Access the Tanzu Operations Manager API in Using the Tanzu Operations Manager API.

Your Tanzu Operations Manager serves a local copy of the complete Tanzu Operations Manager API documentation at https://YOUR-OPS-MANAGER-FQDN/docs.

The Tanzu Operations Manager CLI (om)

The Tanzu Operations Manager CLI, om, calls the Tanzu Operations Manager API to do the following:

  • Perform Tanzu Operations Manager operations from the command line or scripts
  • Manage credentials from the command line or scripts
  • Generate configuration files from, and apply saved configurations to, staged product tiles.

For information, including how to install om and a usage example, see Using the Tanzu Operations Manager CLI.

Platform Automation (beta)

Platform Automation tasks call the om CLI to do the following:

  • Serve as building blocks for Continuous Integration (CI) pipelines that automate installation and updating of Tanzu Operations Manager foundations
  • Within pipelines, store and retrieve product configuration values from secrets vaults like CredHub and code repositories like GitHub.

For a complete list of Platform Automation tasks, see Concourse Tasks in the Platform Automation documentation.

Examples of equivalent operations

The following table lists some common operations using the Tanzu Operations Manager UI, Tanzu Operations Manager API, om CLI, and Platform Automation tasks, as examples of how different Tanzu Operations Manager interfaces relate to one another.

For complete lists of operations, consult the references in the previous sections.

UI action API command om Command Platform automation (Beta) task
Manually configure the BOSH Director tile Multiple commands; see Configure the BOSH Director in Using the Tanzu Operations Manager API. om configure-director configure-director
Click IMPORT A PRODUCT POST product file to /available_products om upload-product upload-product
Click the + symbol next to a product listing left of Installation Dashboard POST product name and version to /staged/products om stage-product stage-product
Manually configure a product tile Multiple commands; see Configure a Product in Using the Tanzu Operations Manager API. om configure-product configure-product
Click STEMCELL LIBRARY, then IMPORT STEMCELL POST stemcell file to /stemcells om upload-stemcell upload-stemcell
Click Apply Changes POST specified products (or all) and errand lists to /installations om apply-changes apply-changes
check-circle-line exclamation-circle-line close-line
Scroll to top icon