4.2

Table Of Contents
Table 2-1. JavaScript Objects in the Orchestrator API
Object Icon in Hierarchical List Description
Type Types
Function set Internal type that contains a set of static
methods
Primitive Primitive types
Object Standard Orchestrator scripting objects
Attribute JavaScript attributes
Method JavaScript methods
Constructor JavaScript constructors
Enumeration JavaScript enumerations
String set String set, default values
Module A collection of actions
Plug-in Image that plug-in defines The APIs that plug-ins expose to
Orchestrator
Writing Scripts
The Orchestrator scripting engine helps you to write scripts. Automatic insertion of functions and automatic
completion of lines of scripting accelerates the scripting process and minimizes the potential for writing errors
in scripts.
Prerequisites
A scripted element is open for editing and its Scripting tab is open.
Procedure
1 Navigate through the hierarchical list of objects on the left of the Scripting tab, or use the API Explorer
search function, to select a type, class, or method to add to the script.
2 Right-click the type, class, or method and select Copy.
If the scripting engine does not allow you to copy the element you selected, this object is not possible in
the context of the script.
3 Right-click in the scripting pad, and paste the element you copied into the appropriate place in the script.
The scripting engine enters the element into the script, complete with its constructor and an instance name.
For example, if you copied the Date object, the scripting engine pastes the following code into the script.
var myDate = new Date();
4 Copy and paste a method to add to the script.
The scripting engine completes the method call, adding the required attributes.
For example, if you copied the cloneVM() method from the com.vmware.library.vc.vm module, the
scripting engine pastes the following code into the script.
System.getModule("com.vmware.library.vc.vm").cloneVM(vm,folder,name,spec)
The scripting engine highlights those parameters that you already defined in the element. Any undefined
parameters remain unhighlighted.
Chapter 2 Scripting
VMware, Inc. 109