VMware Onyx Readme

Welcome to the VMware Onyx. This Readme contains these topics:

About Onyx

Onyx is a standalone application that serves as a proxy between the vSphere Client and the vCenter Server. It monitors the network communication between them and translates it into code. You can modify and save this code as a reusable function ot script. The generated scripts can run in the VMware vSphere PowerCLI console. Onyx cannot generate script for API methods used by vSphere Client that are not avilable in the public API.

Requirements

To use Onyx, you need to have installed the following software:
  • Microsoft .NET Framework 3.5 SP1

The minimum hardware requirements are:

  • 256MB RAM (Recommended: 512MB or more)
  • 400MHz CPU (Recommended: 1GHz or greater)

Supported Platforms

Onyx works on the 32-bit versions of the following platforms:
  • Windows XP
  • Windows Vista
  • Windows 7
  • Windows Server 2003
  • Windows Server 2008

Obtaining the Software

Onyx is distributed as a zipped application. You can download the latest version of Onyx from here. To read the license agreement, open the  License.txt  file in the Onyx installation folder.

Installing and Uninstalling Onyx

Extract the Onyx files to a folder of your choice and run the application from there. To uninstall Onyx, delete the folder where you extracted the application files.

Getting Started with Onyx

To start using Onyx

  • Run Onyx.exe in the folder where you extracted the Onyx files.
  • On the Onyx menu bar, click Connect to open the Start a new connection dialog box.
  • In the Start a new connection dialog box, type the IP of the vCenter Server you want to connect and click Start.
  • Run vSphere Client or vSphere PowerCLI and connect to the vCenter Server on which Onyx is running. You can see the IP and the listening port of the connected vCenter Server on the Onyx titlebar.
    • For vSphere Client, in the IP Address field, type: http:// <server_IP> : <port_number>
    • For vSphere PowerCLI, in the PowerCLI console, run: Connect-VIServer <server_IP> -Protocol http -Port <port_number> -User <username> -Pass <password>
  • Click Start to start generating PowerCLI .NET scripts.
  • Click Save to save the generated script.

Using the Generated Code

PowerCLI .NET Interpreter

To run the generated PowerShell scripts, use vSphere PowerCLI.

C# 2.0 Interpreter

To integrate the generated code in your .NET application you need to setup a development environment. For more information about setting up the environment, see the vSphere SDK for .NET Developer's Guide.

vCO JavaScript Interpreter

To use the generated JavaScript in a vCO workflow

  1. Create a new module in the Actions tab named "com.vmware.onyx".
  2. Right-click on the new module and add the action  array.action  that is located in  "<Onyx directory>\Extensions\Onyx.Interpreters.VcoJavaScript".
  3. Copy the generated script into a scripting task and modify it to suit your needs.

Additional Resources


Copyright © 2010 VMware, Inc. All rights not expressly granted herein are reserved.

Last updated: 19-Aug-2010 6:05 pm  |  VMware Onyx