Getting Started¶

About¶

vmt-connect is a connection wrapper for working with the Turbonomic API. It provides not only connection handling, but also many convenience methods for handling common tasks within Turbonomic.

Installation¶

pip install vmtconnect

Requirements¶

In order to use vmt-connect you will need to be running a supported version of Python, and install the Requests module.

Python:
- CPython >= 3.6
Requests >= 2.21.0
Turbonomic
- Classic >= 5.9
- XL >= 7.21

Importing¶

In the most basic case, you need to import the package.

import vmtconnect

However, you may find it more useful to alias the import

import vmtconnect as vc

Source Code¶

vmt-connect is an official Turbonomic Open Source project. The source code continues to be hosted on GitHub.

Individual release archives may be found here.

Contributors¶

Creator and Principal Author:

R.A. Stern

Contributors:

Austin Portal
Chris Sawtelle
Ray Mileo
Ryan Geyer

Turbonomic REST API Guides¶

The following published user guides are available to aid in developing against the Turbonomic REST API. Additional resources are available on the Turbonomic Documentation website.

XL 8.1.0

XL 8.0.1

XL 7.22.2

Unofficial User Guide for 6.0.

6.0

5.9

License¶

vmt-connect is distributed under the Apache 2.0 software license, which may also be obtained from the Apache Software Foundation, https://www.apache.org/licenses/LICENSE-2.0.txt