5.5.2
Table Of Contents
- Installing and Configuring VMware vCenter Orchestrator
- Contents
- Installing and Configuring VMware vCenter Orchestrator
- Introduction to VMware vCenter Orchestrator
- Orchestrator System Requirements
- Hardware Requirements for Orchestrator
- Hardware Requirements for the Orchestrator Appliance
- Operating Systems Supported by Orchestrator
- Supported Directory Services
- Browsers Supported by Orchestrator
- Orchestrator Database Requirements
- Software Included in the Orchestrator Appliance
- Level of Internationalization Support
- Setting Up Orchestrator Components
- Installing and Upgrading Orchestrator
- Download the vCenter Server Installer
- Install Orchestrator Standalone
- Install the Client Integration Plug-In in the vSphere Web Client
- Download and Deploy the Orchestrator Appliance
- Upgrading Orchestrator 4.0.x Running on a 64-Bit Machine
- Upgrading Orchestrator 4.0.x and Migrating the Configuration Data
- Upgrade Orchestrator Standalone
- Updating Orchestrator Appliance 5.5.x
- Upgrading Orchestrator Appliance 5.1.x and Earlier to 5.5.x
- Upgrade an Orchestrator Cluster
- Uninstall Orchestrator
- Configuring the Orchestrator Server
- Start the Orchestrator Configuration Service
- Log In to the Orchestrator Configuration Interface
- Configure the Network Connection
- Orchestrator Network Ports
- Import the vCenter Server SSL Certificate
- Selecting the Authentication Type
- Configuring the Orchestrator Database Connection
- Server Certificate
- Configure the Orchestrator Plug-Ins
- Importing the vCenter Server License
- Selecting the Orchestrator Server Mode
- Start the Orchestrator Server
- Configuring vCenter Orchestrator in the Orchestrator Appliance
- Configuring Orchestrator by Using the Configuration Plug-In and the REST API
- Additional Configuration Options
- Change the Password of the Orchestrator Configuration Interface
- Change the Default Configuration Ports on the Orchestrator Client Side
- Uninstall a Plug-In
- Activate the Service Watchdog Utility
- Export the Orchestrator Configuration
- Import the Orchestrator Configuration
- Configure the Expiration Period of Events and the Maximum Number of Runs
- Import Licenses for a Plug-In
- Orchestrator Log Files
- Configuration Use Cases and Troubleshooting
- Configuring a Cluster of Orchestrator Server Instances
- Registering Orchestrator with vCenter Single Sign-On in the vCenter Server Appliance
- Setting Up Orchestrator to Work with the vSphere Web Client
- Check Whether Orchestrator Is Successfully Registered as an Extension
- Unregister Orchestrator from vCenter Single Sign-On
- Enable Orchestrator for Remote Workflow Execution
- Changing SSL Certificates
- Back Up the Orchestrator Configuration and Elements
- Unwanted Server Restarts
- Orchestrator Server Fails to Start
- Revert to the Default Password for Orchestrator Configuration
- Setting System Properties
- Disable Access to the Orchestrator Client By Nonadministrators
- Disable Access to Workflows from Web Service Clients
- Setting Server File System Access for Workflows and JavaScript
- Set JavaScript Access to Operating System Commands
- Set JavaScript Access to Java Classes
- Set Custom Timeout Property
- Modify the Number of Objects a Plug-In Search Obtains
- Modify the Number of Concurrent and Delayed Workflows
- Where to Go From Here
- Index
Configure LDAP Authentication by Using the REST API
You can configure the LDAP authentication settings by running a Configuration workflow or by using the
REST API.
To set up an LDAP directory service and configure Orchestrator to work with it, you can run a configuration
workflow named after the directory service that you want to set up.
For information about configuring LDAP authentication settings by using the Orchestrator configuration
interface, see “Configuring LDAP Settings,” on page 44.
Procedure
1 Make a GET request at the URL of the Workflow service, for the directory service you want to configure.
Option Description
Configure Active Directory
Configures Active Directory
Configure eDirectory
Configures eDirectory
Configure Embedded LDAP
Configures Embedded LDAP
Configure OpenLDAP
Configures OpenLDAP
Configure Sun One Directory
Configures Sun ONE Directory
For example, to search for the workflow named Configure Active Directory, make the following GET
request:
GET https://{vcoHost}:{port}/vco/api/workflows?conditions=name=Configure Active Directory
2 Retrieve the definition of the workflow by making a GET request at the URL of the definition.
To retrieve the definition of the Configure Active Directory workflow, make the following GET request:
GET https://{vcoHost}:{port}/vco/api/workflows/fde9fale-lbdd-479f-93fi-0426dd2ad06d
3 Make a POST request at the URL that holds the execution objects of the workflow.
For the Configure Active Directory workflow, make the following POST request:
POST https://{vcoHost}:{port}/workflows/fde9fale-lbdd-479f-93fi-0426dd2ad06d/executions
4 Provide values for the input parameters of the workflow in an execution-context element in the request
body.
The following parameters are available for all directory services except Embedded LDAP:
Option Description
port
The port number
primaryHost
The IP address or the DNS name of the host on which your primary LDAP
service runs
secondaryHost
The IP address or the DNS name of the host on which your secondary
LDAP service runs
elementRoot
The root element of the LDAP service
useSSL
Activates encrypted certification for the connection between Orchestrator
and LDAP
userName
The user name of a valid user who has browsing permissions on your
LDAP server
password
The password for the user name
userLookupBase
The LDAP container (the top-level domain name or organizational unit)
where Orchestrator searches for potential users
groupLookupBase
The LDAP container where Orchestrator searches for groups
Chapter 7 Configuring Orchestrator by Using the Configuration Plug-In and the REST API
VMware, Inc. 73