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
Web Service Endpoint
The Web service endpoint is the port upon which you connect a Web service client to the Orchestrator
server.
You connect to the Orchestrator Web service's endpoint at the following URL, in which orchestrator_server is
the IP address or host name of the host on which the Orchestrator server is running.
https://orchestrator_server:8281/vco/vmware-vmo-webcontrol/webservice
By default, the Web service runs over HTTPS on port 8281 of the Orchestrator server. Access to the Web
service API requires a valid user name and password on the Orchestrator server.
Generating the Orchestrator Web Service Stubs
You generate client and server stubs from the Orchestrator WSDL.
Orchestrator publishes the WSDL file at the following location.
https://orchestrator_server:8281/vco/vmware-vmo-webcontrol/webservice?WSDL
You generate the Web service client and server stubs by using a Java or .Net code generator. The
Orchestrator Web service supports all WSDL 1.1 parsers. Generating the Web service provides the following
objects.
NOTE The exact objects that the Orchestrator Web service generates depend on your code generator. The
objects in the following list are those that the Axis 1.4 code generator generates. Other code generators
might generate the objects differently. If the generator that you use generates different objects, use
VSOWebControlService service as the point of access to the other Web service objects.
Table 3‑1. Java classes generated with Axis 1.4
Class Description
VSOWebControl
The Web service defines a WSDL port type named
VSOWebControl, through which you access all the
Orchestrator Web service operations.
WebServiceStub
The Web service defines client and server side stubs that
the application uses to start the Web service.
VSOWebControlProxy
The Web service provides access to the Orchestrator Web
service operations through a proxy.
VSOWebControlService The VSOWebControlService service is a remote procedure
call (RPC) Service implementation. The
VSOWebControlService service is the point of access to
the other Web service objects.
VSOWebControlServiceLocator The VSOWebControlServiceLocator service extends
VSOWebControlService to provide the following
operations.
n
getwebserviceAddress obtains the endpoint URL for
the Web service.
n
getwebservice obtains the client-side stub for the
Web service application and instantiates the
VSOWebControl port type object with the appropriate
endpoint URL.
Chapter 3 Writing a Client Application for the Orchestrator SOAP Service
VMware, Inc. 55