4.1

getAllPlugins Operation
The getAllPlugins operation returns the description of all the plug-ins installed in Orchestrator.
Many of the actions that you perform using Orchestrator depend on functions that you enable through plug-
ins. Workflows might depend on the existence of certain custom plug-ins, or on standard plug-ins that the
administrator has disabled. Consequently, you can check that the necessary plug-ins are present before you
run a workflow. Without the necessary plug-ins, some object types used by workflows might be absent.
The getAllPlugins operation lists all the available plug-ins as an array of ModuleInfo objects. The
ModuleInfo objects store the name, version, description, and name for each plug-in. A Web service application
can use these attributes to modify its behavior based on the presence or absence of certain plugged-in modules
or versions.
The getAllPlugins operation is declared as follows.
public ModuleInfo[] getAllPlugins(username, password);
The following table describes the getAllPlugins operation properties.
Type Value Description
String
username
Orchestrator user name.
String
password
Orchestrator password.
Return Value
Returns a list of plug-in descriptions as ModuleInfo objects.
getAllWorkflows Operation
The getAllWorkflows operation finds all available workflows.
The getAllWorkflows operation lists all the workflows available in an Orchestrator server as an array of
Workflow objects. The getAllWorkflows operation is also useful for programs that must list information about
workflows, such as the workflows' names, IDs, and so on. The Workflow objects present all the relevant
information about the workflows.
The getAllWorkflows operation is declared as follows.
public Workflow[] getAllWorkflows(String username, String password);
Type Value Description
String
username
Orchestrator user name.
String
password
Orchestrator password.
Return Value
Returns an array of Workflow objects.
getWorkflowForId Operation
The getWorkflowForId operation retrieves a workflow identified by its unique ID.
If you know the ID of a specific workflow, you can use the getWorkflowForID operation to obtain the workflow
object. Multiple workflows running through different plug-ins might have the same name. The safest way to
obtain workflows is to use the getWorkflowsWithName operation to obtain their ID, rather than by obtaining
them by name.
vCenter Orchestrator Developer's Guide
272 VMware, Inc.