Installing andConfiguring VMwarevRealize OrchestratorvRealize Orchestrator 7.3
Installing and Configuring VMware vRealize Orchestrator
VMware, Inc. 2
You can find the most up-to-date technical documentation on the VMware website at:
https://docs.vmware.com/
If you have comments about this documentation, submit your feedback to
[email protected]
Copyright 20082017 VMware, Inc. All rights reserved. Copyright and trademark information.
VMware, Inc.3401 Hillview Ave.Palo Alto, CA 94304www.vmware.com
https://docs.vmware.com/mailto:[email protected]://pubs.vmware.com/copyright-trademark.html
Contents
Installing and Configuring VMware vRealize Orchestrator 6
1 Introduction to VMware vRealize Orchestrator 7
Key Features of the Orchestrator Platform 7
Orchestrator User Types and Related Responsibilities 9
Orchestrator Architecture 10
Orchestrator Plug-Ins 10
2 Orchestrator System Requirements 12
Hardware Requirements for the Orchestrator Appliance 12
Browsers Supported by Orchestrator 12
Orchestrator Database Requirements 13
Software Included in the Orchestrator Appliance 13
Level of Internationalization Support 13
Orchestrator Network Ports 14
3 Setting Up Orchestrator Components 16
vCenter Server Setup 16
Authentication Methods 16
Setting Up the Orchestrator Database 17
4 Installing Orchestrator 18
Download and Deploy the Orchestrator Appliance 18
Power On the Orchestrator Appliance and Open the Home Page 19
Change the Root Password 20
Enable or Disable SSH Administrator Login on the vRealize Orchestrator Appliance 20
Configure Network Settings for the Orchestrator Appliance 21
5 Initial Configuration 22
Configuring a Standalone Orchestrator Server 22
Configure a Standalone Orchestrator Server with vRealize Automation Authentication 22
Configure a Standalone Orchestrator Server with vSphere Authentication 24
Orchestrator Network Ports 26
Configuring the Orchestrator Database Connection 27
Import the Database SSL Certificate 27
Configure the Database Connection 28
Export the Orchestrator Database 30
Import an Orchestrator Database 30
VMware, Inc. 3
Manage Certificates 31
Manage Orchestrator Certificates 31
Configure the Orchestrator Plug-Ins 33
Manage the Orchestrator Plug-Ins 33
Uninstall a Plug-In 34
Orchestrator Startup Options 35
Orchestrator Availability and Scalability 36
Configuring an Orchestrator Cluster 36
Monitoring an Orchestrator Cluster 39
Role Based Access Management in Control Center 40
Assign User Roles to Users in Control Center 40
Configuring the Customer Experience Improvement Program 41
Categories of Information That VMware Receives 41
Join the Customer Experience Improvement Program 41
6 Using the API services 43
Managing SSL Certificates and Keystores by Using the REST API 43
Delete an SSL Certificate by Using the REST API 43
Import SSL Certificates by Using the REST API 44
Create a Keystore by Using the REST API 45
Delete a Keystore by Using the REST API 46
Add a Key by Using the REST API 46
Automating the Orchestrator Configuration by Using the Control Center REST API 47
7 Additional Configuration Options 48
Reconfiguring Authentication 48
Change the Authentication Provider 48
Change the Authentication Parameters 49
Export the Orchestrator Configuration 50
Import the Orchestrator Configuration 50
Configuring the Workflow Run Properties 51
Orchestrator Log Files 52
Logging Persistence 52
Orchestrator Logs Configuration 53
Inspect the Workflows 54
Filter the Orchestrator Logs 54
Add Network Interface Controllers 55
Configure Static Routes 55
8 Configuration Use Cases and Troubleshooting 57
Register Orchestrator as a vCenter Server Extension 57
Unregister Orchestrator Authentication 58
Installing and Configuring VMware vRealize Orchestrator
VMware, Inc. 4
Changing SSL Certificates 58
Adding a Certificate to the Local Store 59
Change the Certificate of the Orchestrator Appliance Management Site 59
Cancel Running Workflows 60
Enable Orchestrator Server Debugging 60
Back Up the Orchestrator Configuration and Elements 61
Backing Up and Restoring vRealize Orchestrator 63
Back Up vRealize Orchestrator 64
Restore a vRealize Orchestrator Instance 65
Disaster Recovery of Orchestrator by Using Site Recovery Manager 66
Configure Virtual Machines for vSphere Replication 66
Create Protection Groups 67
Create a Recovery Plan 68
Organize Recovery Plans in Folders 68
Edit a Recovery Plan 69
9 Setting System Properties 70
Disable Access to the Orchestrator Client By Nonadministrators 70
Setting Server File System Access for Workflows and Actions 71
Rules in the js-io-rights.conf File Permitting Write Access to the Orchestrator System 71
Set Server File System Access for Workflows and Actions 72
Set Access to Operating System Commands for Workflows and Actions 72
Set JavaScript Access to Java Classes 73
Set Custom Timeout Property 74
10 Where to Go From Here 76
Log In to the Orchestrator Client from the Orchestrator Appliance Web Console 76
Installing and Configuring VMware vRealize Orchestrator
VMware, Inc. 5
Installing and ConfiguringVMware vRealize Orchestrator
Installing and Configuring VMware vRealize Orchestrator provides information and instructions aboutinstalling, upgrading and configuring VMware vRealize Orchestrator.
Intended AudienceThis information is intended for advanced vSphere administrators and experienced system administratorswho are familiar with virtual machine technology and datacenter operations.
VMware, Inc. 6
Introduction toVMware vRealize Orchestrator 1VMware vRealize Orchestrator is a development- and process-automation platform that provides a libraryof extensible workflows to allow you to create and run automated, configurable processes to manageVMware products as well as other third-party technologies.
vRealize Orchestrator automates management and operational tasks of both VMware and third-partyapplications such as service desks, change management systems, and IT asset management systems.
This chapter includes the following topics:n Key Features of the Orchestrator Platform
n Orchestrator User Types and Related Responsibilities
n Orchestrator Architecture
n Orchestrator Plug-Ins
Key Features of the Orchestrator PlatformOrchestrator is composed of three distinct layers: an orchestration platform that provides the commonfeatures required for an orchestration tool, a plug-in architecture to integrate control of subsystems, and alibrary of workflows. Orchestrator is an open platform that can be extended with new plug-ins andlibraries, and can be integrated into larger architectures through a REST API.
The following list presents the key Orchestrator features.
Persistence Production grade databases are used to store relevant information, such asprocesses, workflow states, and configuration information.
Central management Orchestrator provides a central way to manage your processes. Theapplication server-based platform, with full version history, can store scriptsand process-related primitives in the same storage location. . This way, youcan avoid scripts without versioning and proper change control on yourservers.
VMware, Inc. 7
Check-pointing Every step of a workflow is saved in the database, which prevents data-lossif you must restart the server. This feature is especially useful for long-running processes.
Control Center The Control Center interface increases the administrative efficiency ofvRealize Orchestrator instances by providing a centralized administrativeinterface for runtime operations, workflow monitoring, unified log accessand configurations, and correlation between the workflow runs and systemresources. The vRealize Orchestrator logging mechanism is optimized withan additional log file that gathers various performance metrics for vRealizeOrchestrator engine throughput.
Versioning All Orchestrator Platform objects have an associated version history.Version history is useful for basic change management when distributingprocesses to project stages or locations.
Scripting engine The Mozilla Rhino JavaScript engine provides a way to create buildingblocks for Orchestrator Platform. The scripting engine is enhanced withbasic version control, variable type checking, name space management,and exception handling. The engine can be used in the following buildingblocks:
n Actions
n Workflows
n Policies
Workflow engine The workflow engine allows you to automate business processes. It usesthe following objects to create a step-by-step process automation inworkflows:
n Workflows and actions that Orchestrator provides
n Custom building blocks created by the customer
n Objects that plug-ins add to Orchestrator
Users, other workflows, schedules or policies can start workflows.
Policy engine You can use the policy engine to monitor and generate events to react tochanging conditions in the Orchestrator server or plugged-in technology.Policies can aggregate events from the platform or any of the plug-ins,which helps you to handle changing conditions on any of the integratedtechnologies.
Security Orchestrator provides the following advanced security functions:
