Admin requests

Exporting diagnostics

If you are experiencing problems with Turbonomic, your support representative might request that you export diagnostic data. You can export the data and then send it to the support representative as requested.

Example: POST https://10.10.10.10/api/v3/admin/exports

Response: true if successful, false if an error occurs while Turbonomic creates the export. The export file is saved in the /tmp directory on your instance with a file name that begins with bkp-.

Getting health check results

Get health check results regularly to see whether issues exist that are related to the monitoring and analysis of your environment.

Example: GET https://10.10.10.10/api/v3/admin/health

Response: HealthCategoryResponseDTO with the health check results.

[
  {
    "healthCategory": "TARGET",
    "categoryDisplayName": "Targets",
    "categoryHealthState": "CRITICAL",
    "responseItems": [
      {
        "subcategory": "VALIDATION",
        "healthState": "MAJOR",
        "numberOfItems": 2,
        "recommendations": []
      },
      {
        "subcategory": "DISCOVERY",
        "healthState": "CRITICAL",
        "numberOfItems": 6,
        "recommendations": [
          {
            "errorType": "INTERNAL_PROBE_ERROR",
            "description": "{Description}"
          }
        ]
      },
      {
        "subcategory": "DISCOVERY",
        "healthState": "NORMAL",
        "numberOfItems": 23,
        "recommendations": []
      }
    ]
  },
  {
    "healthCategory": "ACTION",
    "categoryDisplayName": "Actions",
    "categoryHealthState": "NORMAL",
    "responseItems": [
      {
        "subcategory": "ANALYSIS",
        "healthState": "NORMAL",
        "numberOfItems": 0,
        "recommendations": []
      }
    ]
  },
  {
    "healthCategory": "COMPONENT",
    "categoryDisplayName": "Components",
    "categoryHealthState": "NORMAL",
    "responseItems": [
      {
        "subcategory": "CONTAINER PODS",
        "healthState": "NORMAL",
        "numberOfItems": 45,
        "recommendations": [
          {
            "errorType": "INFO",
            "description": "Pods that are in a running state."
          }
        ]
      }
    ]
  }
]

The response includes the following health check categories (healthCategory):

  • TARGET – see whether issues exist with the targets you added, such as validation or discovery failures.

  • ACTION – see whether issues exist with analyzing your environment, such as analysis timeouts.

  • COMPONENT – see whether issues exist with Turbonomic components, such as container pods that are not running.

Ideally, each healthCategory shows "categoryHealthState": "NORMAL". If you see a different value, review the issues and recommendations in the responseItems key.

Use the following parameters to filter the results:

  • category

    Get results for a specific healthCategory.

  • health_state

    Get results with a specific categoryHealthState. For example, choose CRITICAL to see issues that require immediate attention.

Getting and setting a proxy

Gets the current state of the proxy and proxy details (if enabled).

Example: GET https://10.10.10.10/api/v3/admin/httpproxy

Response: A HttpProxyDTO describing details of the proxy. If no proxy is configured, this request returns "isProxyEnabled": false.


{
  "isProxyEnabled":true,
  "proxyHost":"10.10.111.1",
  "userName":"UserName",
  "password":"PW"
}

To set the proxy, pass an HttpProxyDTO, making sure to include "isProxyEnabled": true if you want to activate the proxy immediately.

Example: POST https://10.10.10.10/api/v3/admin/httpproxy

Example httpProxyDTO:


{
  "isProxyEnabled":true,
  "proxyHost":"10.10.111.1",
  "portNumber":"33128",
  "userName":"ProxyUser",
  "password":"Password"
}

Response: true if successful, false if an error occurs while Turbonomic is setting the proxy.

Getting and setting logging levels by component

You can set the level of logging for different components of the Turbonomic platform. The default logging level for all components is INFO. Setting more verbose logging levels can greatly increase the disk space that is required to store the log files. You normally change these settings only while you're working with a Turbonomic support representative.

The available logging levels are (in order of least to most verbose): INFO, WARN, DEBUG, and TRACE.

Example: GET https://10.10.10.10/api/v3/admin/logginglevels

Response: A LoggingApiDTO with details about your current logging level settings:


	{
  "componentLoggingLevel":{
    "Extension":"INFO",
    "Analysis":"INFO",
    "Discovery":"INFO",
    "API":"INFO",
    "Presentation":"INFO",
    "Abstraction":"INFO",
    "Monitoring":"INFO"
  }
}

To set the logging level for a specific component, pass a partial LoggingApiDTO containing the component and logging level.

Example: POST https://10.10.10.10/api/v3/admin/logginglevels

Example LoggingApiDTO:


	{
  "componentLoggingLevel":{
    "Extension":"WARN"
  }
}

Response: A successful response returns your input in the response body.

Getting the current version

Gets the version of each Turbonomic package that your instance is running. Set the check_for_updates parameter to true to also check for updates that might be available.

This request takes the following parameters:

check_for_updates

Check for available updates before returning version information. Default: false.

Example: GET https://10.10.10.10/api/v3/admin/versions?check_for_updates=true

Response: A ProductVersionDTO describing details about the current version and available updates. If you are running the latest version of Turbonomic, the updates value reads "No Updates Available\n"


{
	"versionInfo": "Turbonomic Operations Manager 6.1.7 (Build 20180813223950000)\nvmt-platform-6.1.7-20180813223950000.i586
	...,
	"updates": "Available Packages\nvmt-bundle.i586  6.2.0-20180817180112000 vmturbo\nvmt-config.x86_64
	...,
	"marketVersion": 2
}

Loading external configuration files

To help with diagnosis of some issues, a support representative might want you to load configuration files into your Turbonomic appliance. Use this request only when you are working with a support representative, who can guide you through the process. The support representative specifies what kind of configuration file you are loading, and the contents of that file, by specifying the required parameters.

Example: POST https://10.10.10.10/api/v3/admin/configfiles?config_type=TOPOLOGY&topology=abc

Response: true if successful, false if an error occurs while you are uploading the configuration.