5.5.1
Table Of Contents
- Developing a Web Services Client for VMware vCenter Orchestrator
- Contents
- Developing Web Services Client for VMware vCenter Orchestrator
- Developing a Web Services Client
- Using the vCenter Orchestrator REST API
- Authenticating Against Orchestrator and Third-Party Systems
- Accessing the Reference Documentation for the Orchestrator REST API
- Using the Java REST SDK
- Operations with Workflows
- Working with Tasks
- Finding Objects in the Orchestrator Inventory
- Importing and Exporting Orchestrator Objects
- Deleting Orchestrator Objects
- Setting Permissions on Orchestrator Objects
- REST API Permissions
- Retrieve the Permissions of a Workflow
- Delete the Permissions of a Workflow
- Set the Permissions for a Workflow
- Retrieve the Permissions of an Action
- Delete the Permissions of an Action
- Set the Permissions for an Action
- Retrieve the Permissions of a Package
- Delete the Permissions of a Package
- Set the Permissions for a Package
- Retrieve the Permissions of a Resource
- Delete the Permissions of a Resource
- Set the Permissions for a Resource
- Retrieve the Permissions of a Configuration Element
- Delete the Permissions of a Configuration Element
- Set the Permissions for a Configuration Element
- Performing Operations with Plug-Ins
- Performing Server Configuration Operations
- Performing Tagging Operations
- Writing a Client Application for the Orchestrator SOAP Service
- Process for Creating an Orchestrator Web Service Client Application
- Web Service Endpoint
- Generating the Orchestrator Web Service Stubs
- Accessing the Server from Web Service Clients
- Create a Web Service Client
- Connect to the Orchestrator Web Service
- Find Objects in the Orchestrator Server
- Find Objects by Using the find Operation
- Find Objects by Using the findForId Operation
- Find Objects by Using the findRelation Operation
- Find Workflows in the Orchestrator Server
- Find Workflows by Using the getAllWorkflows Operation
- Retrieve the ID of a Workflow
- Find Workflows by Using the getWorkflowsWithName Operation
- Find Workflows by Using the getWorkflowForID Operation
- Run Workflows from a Web Service Client
- Interact with a Workflow While it Runs
- Obtain Workflow Results
- Time Zones and Running Workflows Through Web Services
- Web Service Application Examples
- Web Service API Object Reference
- Web Service API Operation Reference
- answerWorkflowInput Operation
- cancelWorkflow Operation
- echo Operation
- echoWorkflow Operation
- executeWorkflow Operation
- find Operation
- findForId Operation
- findRelation Operation
- getAllPlugins Operation
- getAllWorkflows Operation
- getWorkflowForId Operation
- getWorkflowInputForId Operation
- getWorkflowInputForWorkflowTokenId Operation
- getWorkflowsWithName Operation
- getWorkflowTokenBusinessState Operation
- getWorkflowTokenForId Operation
- getWorkflowTokenResult Operation
- getWorkflowTokenStatus Operation
- hasChildrenInRelation Operation
- hasRights Operation
- sendCustomEvent Operation
- simpleExecuteWorkflow Operation
- Index
The executeWorkflow operation is declared as follows.
public WorkflowToken executeWorkflow(String workflowId, String username, String password,
WorkflowTokenAttribute[] attributes);
Type Value Description
String
workflowId
The identifier of the workflow to run
String
username
Orchestrator user name
String
password
Orchestrator password
Array of WorkflowTokenAttribute
instances
workflowInputs
Array of input parameters required to
run the workflow
Return Value
Returns a WorkflowToken object. Returns an exception if you pass it an invalid parameter.
find Operation
The find operation finds elements that correspond to a particular query.
The find operation obtains objects of any type by searching for a particular name. The query results are
provided in the form of a QueryResult object, which contains an array of FinderResult objects with a total
counter. The query itself is passed to find as the second parameter, as the following operation declaration
shows.
public QueryResult find(String type, String query, String username, String password);
The plug-in that contains the objects that you are looking for parses the query. The plug-in defines the query
language that the find operation uses. Consequently, the syntax of the query parameter differs according to
the implementation of the plug-in. Most of the officially supported Orchestrator plug-ins do not store any
objects in the inventory, so they do not expose anything that can be searched for.
The following table describes the find operation query parameter syntax and behavior for each of the
supported Orchestrator plug-ins.
Table 5‑1. Query Syntax of the Orchestrator Plug-Ins
Orchestrator Plug-In Query Parameter Syntax Query Behavior
Database, for example Lifecycle
Manager
String Searches for object names in SQL
database tables. Orchestrator sets the
search string in a SQL WHERE keyword
search. It searches the primary keys,
then the object IDs in the database.
Enumeration Not applicable Stores nothing in the inventory. You
can find enumerations on each data
type that contains enumeration types.
Jakarta common set Not applicable Stores nothing in the inventory.
JDBC Not applicable Stores nothing in the inventory.
Library Not applicable Stores nothing in the inventory.
Mail Not applicable Stores nothing in the inventory.
SSH If you have configured Orchestrator
to use SSH connections, you can
make queries SSH commands.
Stores nothing in the inventory.
Developing a Web Services Client for VMware vCenter Orchestrator
82 VMware, Inc.