7.1
Table Of Contents
- Developing a Web Services Client for VMware vRealize Orchestrator
- Contents
- Developing a Web Services Client for VMware vRealize Orchestrator
- Updated Information
- Developing a Web Services Client
- Using the vRealize 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
- Index
Performing Server Configuration Operations
The Orchestrator REST API provides Web services that you can use to perform various operations related to
the Orchestrator server conguration.
Retrieve Information About the Orchestrator Server Configuration
You can retrieve information about the Orchestrator server conguration by using the Orchestrator REST
API.
Procedure
1 In a REST client application, add request headers to dene the properties of the server for which you
want to retrieve information.
2 Make a GET request at the URL of the plug-in objects:
GET http://{orchestrator_host}:{port}/vco/api/server-configuration/
If the GET request is successful, you receive the status code 200.
Import Orchestrator Server Configuration
You can import a saved conguration by using the Orchestrator REST API.
Prerequisites
The conguration binary content should be available as multi-part content. For details, see RFC 2387.
Procedure
1 In a REST client application, add a request header with the following values.
n
Name: content-type
n
Value: multipart/form-data
2 Make a POST request at the URL of the server conguration:
POST http://{orchestrator_host}:{port}/vco/api/server-configuration/
If the POST request is successful, you receive the status code 200.
Export Orchestrator Server Configuration
You can export the server conguration by using the Orchestrator REST API.
Prerequisites
The conguration binary content should be available as multi-part content. For details, see RFC 2387.
Procedure
1 In a REST client application, add a request header with the following values.
n
Name: content-type
n
Value: multipart/form-data
2 Add another request header with the following values.
n
Name: accept
n
Value: */*
Developing a Web Services Client for VMware vRealize Orchestrator
48 VMware, Inc.