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
You created a connection to the Orchestrator Web service, verified the connection, and established what
technologies plug in to the Orchestrator server.
What to do next
Find objects in the Orchestrator server through the Web service connection.
Find Objects in the Orchestrator Server
To perform any useful task with a workflow, you must find the objects on which the workflow will run. The
Orchestrator Web service API provides functions for finding objects of all types in the VMware
Infrastructure inventory.
Workflows typically run on objects in the vCenter Server. Workflows can also run on objects from outside
the vCenter Server by accessing them through plug-ins.
The operations that the Web service API defines for finding objects are as follows.
n
find
n
findForId
n
findRelation
n
hasChildrenInRelation
All of the operations that find objects return FinderResult objects, either individually, as an array, or
embedded in a QueryResult object.
Find Objects by Using the find Operation
You can use the find operation to find objects of any type that match a particular search criterion, that you
set in the query parameter.
The vso.xml file of the plug-in through which you access the object defines the syntax of the query
parameter.
Prerequisites
You must have created a connection to the Orchestrator Web services endpoint in your Web service client
application class.
Procedure
1 Create a QueryResult object by calling the find operation on an object.
The following code example shows how an application can call the find operation to find out how
many virtual machines are accessible by a particular user through the vCenter Server plug-in.
QueryResult queryResult = vsoWebControl.find("VC:VirtualMachine", null,
<username>, <password>);
if (queryResult != null) {
System.out.println("Found " + queryResult.getTotalCount() +
" objs.");
FinderResult[] elts = queryResult.getElements();
finderResult = elts[0];
displayFinderResult(finderResult);
Developing a Web Services Client for VMware vCenter Orchestrator
58 VMware, Inc.