VMware vCenter Orchestrator - 5.1 Installation Manual

Installing and Configuring VMware

vCenter Orchestrator

vCenter Orchestrator 5.1

This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see http://www.vmware.com/support/pubs.

EN-000736-01

Installing and Configuring VMware vCenter Orchestrator

You can find the most up-to-date technical documentation on the VMware Web site at:

http://www.vmware.com/support/

The VMware Web site also provides the latest product updates.

If you have comments about this documentation, submit your feedback to:

docfeedback@vmware.com

Copyright © 2008 – 2012 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws. VMware products are covered by one or more patents listed at

http://www.vmware.com/go/patents.

VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.

VMware, Inc.

3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com

2 VMware, Inc.

Installing and Configuring VMware vCenter Orchestrator 7

Updated Information 9

Introduction to VMware vCenter Orchestrator 11

Key Features of the Orchestrator Platform 11

Orchestrator User Types and Related Responsibilities 12

Orchestrator Architecture 13

Orchestrator System Requirements 15

Hardware Requirements for Orchestrator 15

Operating Systems Supported by Orchestrator 15

Supported Directory Services 15

Browsers Supported by Orchestrator 16

Orchestrator Database Requirements 16

Level of Internationalization Support 16

Orchestrator Components Setup 19

Orchestrator Configuration Maximums 19

vCenter Server Setup 19

Authentication Methods 20

Orchestrator Database Setup 20

Installing and Upgrading Orchestrator 23

Download the vCenter Server Installer 24

Install Orchestrator Standalone 24

Install the Orchestrator Client on a 32-Bit Machine 25

Upgrade Orchestrator 4.2.x Standalone 26

Upgrading Orchestrator 4.0.x Running on a 64-Bit Machine 27

Export the Orchestrator Configuration 27

Uninstall Orchestrator 28

Install Orchestrator Standalone 28

Import the Orchestrator Configuration 29

Upgrading Orchestrator 4.0.x and Migrating the Configuration Data 30

Uninstall Orchestrator 30

VMware, Inc.

Configuring the Orchestrator Server 31

Start the Orchestrator Configuration Service 32

Configure the Network Connection 33

Orchestrator Network Ports 33

Installing and Configuring VMware vCenter Orchestrator

Import the vCenter Server SSL Certificate 35

Selecting the Authentication Type 36

Configuring vCenter Single Sign On Settings 36

Configuring LDAP Settings 39

Configuring the Orchestrator Database Connection 45

Configure SQL Server Express to Use with Orchestrator 45

Import the Database SSL Certificate 45

Configure the Database Connection 46

Server Certificate 49

Create a Self-Signed Server Certificate 49

Obtain a Server Certificate Signed by a Certificate Authority 50

Import a Server Certificate 50

Export a Server Certificate 51

Changing a Self-Signed Server Certificate 51

Configure the Default Plug-Ins 52

Define the Default SMTP Connection 53

Configure the SSH Plug-In 53

Configure the vCenter Server 5.1 Plug-In 54

Installing a New Plug-In 55

Importing the vCenter Server License 56

Import the vCenter Server License 56

Add the vCenter Server License Key Manually 57

Access Rights to Orchestrator Server 57

Start the Orchestrator Server 58

Additional Configuration Options 59

Change the Password of the Orchestrator Configuration Interface 59

Change the Default Configuration Ports on the Orchestrator Client Side 60

Uninstall a Plug-In 60

Activate the Service Watchdog Utility 61

Export the Orchestrator Configuration 62

Orchestrator Configuration Files 62

Import the Orchestrator Configuration 63

Configure the Maximum Number of Events and Runs 64

Import the Plug-In Licenses 65

Orchestrator Log Files 65

Logging Persistence 66

Define the Server Log Level 67

Change the Size of Server Logs 68

Export Orchestrator Log Files 68

Loss of Server Logs 69

Filter the Orchestrator Log Files 69

Configuration Use Cases and Troubleshooting 71

Registering Orchestrator with vCenter Single Sign On in the vCenter Server Appliance 71

Setting Up Orchestrator to Work with the vSphere Web Client 72

Check Whether Orchestrator Is Successfully Registered as an Extension 73

Unregister Orchestrator from vCenter Single Sign On 73

4 VMware, Inc.

Enable Orchestrator for Remote Workflow Execution 74

Changing SSL Certificates 75

Generate a New Certificate 75

Install a Certificate from a Certificate Authority 75

Change the Web Views SSL Certificate 76

Change the SSL Certificate of the Orchestrator Configuration Interface 77

Change the SSL Certificate for the Orchestrator Client 77

Back Up the Orchestrator Configuration and Elements 78

Unwanted Server Restarts 80

Orchestrator Server Fails to Start 80

Revert to the Default Password for Orchestrator Configuration 81

Contents

Setting System Properties 83

Disable Access to the Orchestrator Client By Nonadministrators 83

Disable Access to Workflows from Web Service Clients 84

Setting Server File System Access for Workflows and JavaScript 84

Rules in the js-io-rights.conf File Permitting Write Access to the Orchestrator System 85

Set Server File System Access for Workflows and JavaScript 86

Manually Create the js-io-rights.conf File 86

Set JavaScript Access to Operating System Commands 87

Set JavaScript Access to Java Classes 88

Set Custom Timeout Property 89

Modify the Number of Objects a Plug-In Search Obtains 89

Modify the Number of Concurrent and Pending Workflows 90

Where to Go From Here 91

Index 93

VMware, Inc. 5

Installing and Configuring VMware vCenter Orchestrator

6 VMware, Inc.

Installing and Configuring VMware vCenter Orchestrator

Installing and Configuring VMware vCenter Orchestrator provides information and instructions about installing, upgrading and configuring VMware® vCenter Orchestrator.

Intended Audience

This information is intended for advanced vSphere administrators and experienced system administrators who are familiar with virtual machine technology and datacenter operations.

VMware, Inc. 7

Installing and Configuring VMware vCenter Orchestrator

8 VMware, Inc.

Updated Information

Installing and Configuring VMware vCenter Orchestrator is updated with each release of the product or when necessary.

This table provides the update history of Installing and Configuring VMware vCenter Orchestrator.

Revision Description

EN-000736-01 Updated “Setting Up Orchestrator to Work with the vSphere Web Client,” on page 72 with information

about additional verification steps.

EN-000736-00 Initial release.

VMware, Inc. 9

Installing and Configuring VMware vCenter Orchestrator

10 VMware, Inc.

Introduction to VMware vCenter

Orchestrator 1

VMware vCenter Orchestrator is a development- and process-automation platform that provides a library of extensible workflows to allow you to create and run automated, configurable processes to manage the VMware vSphere infrastructure as well as other VMware and third-party technologies.

Orchestrator exposes every operation in the vCenter Server API, allowing you to integrate all of these operations into your automated processes. Orchestrator also allows you to integrate with other management and administration solutions through its open plug-in architecture.

This chapter includes the following topics:

“Key Features of the Orchestrator Platform,” on page 11

“Orchestrator User Types and Related Responsibilities,” on page 12

“Orchestrator Architecture,” on page 13

Key Features of the Orchestrator Platform

Orchestrator is composed of three distinct layers: an orchestration platform that provides the common features required for an orchestration tool, a plug-in architecture to integrate control of subsystems, and a library of workflows. Orchestrator is an open platform that can be extended with new plug-ins and libraries, and can be integrated into larger architectures through a SOAP or REST API.

The following list presents the key Orchestrator features.

Persistence

Central management

Check-pointing

Versioning

VMware, Inc. 11

Production grade external databases are used to store relevant information, such as processes, workflow states, and configuration information.

Orchestrator provides a central way to manage your processes. The application server-based platform, with full version history, allows you to have scripts and process-related primitives in one place. This way, you can avoid scripts without versioning and proper change control spread on your servers.

Every step of a workflow is saved in the database, which allows you to restart the server without losing state and context. This feature is especially useful for long-running processes.

All Orchestrator Platform objects have an associated version history. This feature allows basic change management when distributing processes to different project stages or locations.

Installing and Configuring VMware vCenter Orchestrator

Scripting engine

Workflow engine

Policy engine

Web 2.0 front end

The Mozilla Rhino JavaScript engine provides a way to create new building blocks for Orchestrator Platform. The scripting engine is enhanced with basic version control, variable type checking, name space management and exception handling. It can be used in the following building blocks:

Actions

Workflows

Policies

The workflow engine allows you to capture business processes. It uses the following objects to create a step-by-step process automation in workflows:

Workflows and actions that Orchestrator provides.

Custom building blocks created by the customer

Objects that plug-ins add to Orchestrator

Users, other workflows, a schedule, or a policy can start workflows.

The policy engine allows monitoring and event generation to react to changing conditions in the Orchestrator server or plugged-in technology. Policies can aggregate events from the platform or any of the plug-ins, which allows you to handle changing conditions on any of the integrated technologies.

The Web 2.0 front end allows you to integrate Orchestrator functions into Webbased interfaces, using Web views. For example, you can create Web views that add buttons to start workflows from a page in your company's Intranet. It provides a library of user customizable components to access vCO orchestrated objects and uses Ajax technology to dynamically update content without reloading complete pages.

Security

Orchestrator provides the following advanced security functions:

Public Key Infrastructure (PKI) to sign and encrypt content imported and exported between servers

Digital Rights Management (DRM) to control how exported content might be viewed, edited and redistributed

Secure Sockets Layer (SSL) encrypted communications between the desktop client and the server and HTTPS access to the Web front end.

Advanced access rights management to provide control over access to processes and the objects manipulated by these processes.

Orchestrator User Types and Related Responsibilities

Orchestrator provides different tools and interfaces based on the specific responsibilities of the two global user roles: Administrators and End Users. Orchestrator developers also have administrative rights and are responsible for creating workflows and additional applications.

Users with Full Rights

Administrators

This role has full access to all of the Orchestrator platform capabilities. Basic administrative responsibilities include the following items:

Installing and configuring Orchestrator

Managing access rights for Orchestrator and applications

12 VMware, Inc.

Chapter 1 Introduction to VMware vCenter Orchestrator

Importing and exporting packages

Enabling and disabling Web views

Running workflows and scheduling tasks

Managing version control of imported elements

Creating new workflows and plug-ins

Developers

This user type has full access to all of the Orchestrator platform capabilities. Developers are granted access to the Orchestrator client interface and have the following responsibilities:

Users with Limited Rights

End Users

This role has access to only the Web front end. End users can run and schedule workflows and policies that the administrators or developers make available in a browser by using Web views.

Orchestrator Architecture

Orchestrator contains a workflow library and a workflow engine to allow you to create and run workflows that automate orchestration processes. You run workflows on the objects of different technologies that Orchestrator accesses through a series of plug-ins.

Orchestrator provides a standard set of plug-ins, including a plug-in for vCenter Server, to allow you to orchestrate tasks in the different environments that the plug-ins expose.

Creating applications to extend the Orchestrator platform functionality

Automating processes by customizing existing workflows and creating new workflows and plug-ins

Customizing Web front ends for automated processes, using Web 2.0 tools.

Orchestrator also presents an open architecture to allow you to plug in external third-party applications to the orchestration platform. You can run workflows on the objects of the plugged-in technologies that you define yourself. Orchestrator connects to a directory services server to manage user accounts, and to a database to store information from the workflows that it runs. You can access Orchestrator, the Orchestrator workflows, and the objects it exposes through the Orchestrator client interface, through a Web browser, or through Web services.

VMware, Inc. 13

Orchestrator

database

workflow library

vCenter

Server

XML SSH SQL SMTP

3rd-party

plug-in

workflow engine

browser

access

vCenter

Orchestrator

Client application

vCenter

Server

Directory services

or vCenter

Single Sign On

Web services

REST/SOAP

Installing and Configuring VMware vCenter Orchestrator

Figure 1-1. VMware vCenter Orchestrator Architecture

14 VMware, Inc.

Orchestrator System Requirements 2

Your system must meet the technical requirements that are necessary to install and configure Orchestrator.

For a list of the supported versions of vCenter Server, see VMware Product Interoperability Matrix.

This chapter includes the following topics:

“Hardware Requirements for Orchestrator,” on page 15

“Operating Systems Supported by Orchestrator,” on page 15

“Supported Directory Services,” on page 15

“Browsers Supported by Orchestrator,” on page 16

“Orchestrator Database Requirements,” on page 16

“Level of Internationalization Support,” on page 16

Hardware Requirements for Orchestrator

Verify that your system meets the minimum hardware requirements before you install Orchestrator.

2.0GHz or faster Intel or AMD x86 processor. At least two CPUs are recommended. Processor requirements might differ if your database runs on the same hardware.

4GB RAM. You might need more RAM if your database runs on the same hardware.

2GB disk space. You might need more storage if your database runs on the same hardware.

A free static IP address.

Operating Systems Supported by Orchestrator

You can install the Orchestrator 5.1 server only on 64-bit operating systems.

For a list of the operating systems supported by Orchestrator, see the VMware Compatibility Guide.

Supported Directory Services

Orchestrator requires a working LDAP server.

Orchestrator supports these directory service types.

Windows Server 2003 Active Directory

Windows Server 2008 Active Directory

Novell eDirectory Server 8.8.3

VMware, Inc.

Installing and Configuring VMware vCenter Orchestrator

Sun Java System Directory Server 6.3

IMPORTANT Multiple domains that have a two-way trust, but are not in the same tree, are not supported and do not work with Orchestrator. The only configuration supported for multi-domain Active Directory is domain tree. Forest and external trusts are unsupported.

Browsers Supported by Orchestrator

The Orchestrator configuration interface and Web views require a Web browser.

You must have one of the following browsers to connect to the Orchestrator configuration interface and Web views.

Microsoft Internet Explorer 7 and 8

Mozilla Firefox 3.0 and later

Orchestrator Database Requirements

Orchestrator requires a database. It is recommended that the Orchestrator database is separate from the standard vCenter Server database. For small-scale deployments, you can use the SQL Server Express database that is bundled with vCenter Server.

NOTE To ensure efficient CPU and memory usage, you should consider hosting the Orchestrator database and the Orchestrator server on different machines. Verify that at least 1GB of free disk space is available on each machine.

Orchestrator supports Oracle, SQL Server 2003, SQL Server 2008, SQL Server Express, PostgreSQL, as well as the vCenter Server datasource.

Level of Internationalization Support

Orchestrator is compliant with i18n level 1.

Non-ASCII Character Support in Orchestrator

Although Orchestrator is not localized, it can run on a non-English operating system and handle non-English text.

Table 2-1. Non-ASCII Character Support in Orchestrator GUI

Support for Non-ASCII Characters

Item

Action Yes No No No

Folder Yes Yes - -

Configuration element Yes Yes - No

Package Yes Yes - -

Policy Yes Yes - -

Policy template Yes Yes - -

Resource element Yes Yes - -

Web view Yes Yes - No

Description Field Name Field

Input and Output Parameters Attributes

16 VMware, Inc.

Chapter 2 Orchestrator System Requirements

Table 2-1. Non-ASCII Character Support in Orchestrator GUI (Continued)

Support for Non-ASCII Characters

Input and Output

Item

Workflow Yes Yes No No

Workflow presentation display group and input step

Description Field Name Field

Yes Yes - -

Parameters Attributes

Non-ASCII Character Support for Oracle Databases

To store characters in the correct format in an Oracle database, set the NLS_CHARACTER_SET parameter to

AL32UTF8 before configuring the database connection and building the table structure for Orchestrator. This

setting is crucial for an internationalized environment.

VMware, Inc. 17

Installing and Configuring VMware vCenter Orchestrator

18 VMware, Inc.

Orchestrator Components Setup 3

To enhance the availability and scalability of your Orchestrator setup, install Orchestrator on a computer different from the computer on which vCenter Server runs. With such separation, you can adjust the operating system to meet the specific recommendations for each service.

This chapter includes the following topics:

“Orchestrator Configuration Maximums,” on page 19

“vCenter Server Setup,” on page 19

“Authentication Methods,” on page 20

“Orchestrator Database Setup,” on page 20

Orchestrator Configuration Maximums

When you configure Orchestrator, verify that you stay at or below the supported maximums.

Table 3-1. Orchestrator Configuration Maximums

Item Maximum

Connected vCenter Server systems 20

Connected ESX/ESXi servers 1280

Connected virtual machines spread over vCenter Server systems 35000

Concurrent running workflows 300

vCenter Server Setup

Increasing the number of vCenter Server instances in your Orchestrator setup causes Orchestrator to manage more sessions. Each active session results in activity on the corresponding vCenter Server, and too many active sessions can cause Orchestrator to experience timeouts when more than 10 vCenter Server connections occur.

For a list of the supported versions of vCenter Server, see VMware Product Interoperability Matrix.

NOTE You can run multiple vCenter Server instances on different virtual machines in your Orchestrator setup if your network has sufficient bandwidth and latency. If you are using LAN to improve the communication between Orchestrator and vCenter Server, a 100Mb line is mandatory.

VMware, Inc.

Installing and Configuring VMware vCenter Orchestrator

Authentication Methods

To authenticate and manage user permissions, Orchestrator requires a connection to an LDAP server or a connection to a vCenter Single Sign On server.

Orchestrator supports the following directory service types: Active Directory, eDirectory, and Sun Java System Directory Server.

Connect your system to the LDAP server that is physically closest to your Orchestrator server, and avoid connections to remote LDAP servers. Long response times for LDAP queries can lead to slower performance of the whole system.

To improve the performance of the LDAP queries, keep the user and group lookup base as narrow as possible. Limit the users to targeted groups that need access, rather than to whole organizations with many users who do not need access. Depending on the combination of database and directory service you choose, the resources you need can vary. For recommendations, see the documentation for your LDAP server.

To use the vCenter Single Sign On authentication method, you must first install vCenter Single Sign On. If you install Orchestrator together with vCenter Server, the Orchestrator server is preconfigured to use vCenter Single Sign On as an authentication method. If you install Orchestrator separately from vCenter Server, and you want to use vCenter Single Sign On, you must configure the Orchestrator server to use the vCenter Single Sign On server that you installed and configured.

Orchestrator Database Setup

Orchestrator requires a database to store workflows and actions.

If you install Orchestrator together with vCenter Server, the Orchestrator server is preconfigured to use the vCenter Server datasource and no additional configuration of the database is required. However, if you need to use a separate database, you can configure Orchestrator to use a dedicated database by using the Orchestrator configuration interface.

If you install Orchestrator separately from vCenter Server, you must set up the Orchestrator database. You can configure the Orchestrator server to use either the vCenter Server datasource, or another database, that you have created for the Orchestrator server.

Orchestrator server supports Oracle and Microsoft SQL Server databases. Orchestrator can work with Microsoft SQL Server Express in small-scale environments consisting of up to 5 hosts and 50 virtual machines.

For details about using SQL Server Express with Orchestrator, see “Configure SQL Server Express to Use with

Orchestrator,” on page 45.

The common workflow for setting up the Orchestrator database is the following:

1 Create a new database. For more information about creating a new database, refer to the documentation

of your database provider (Microsoft or Oracle).

2 Enable the database for remote connection. For an example of how to do that, see “Configure SQL Server

Express to Use with Orchestrator,” on page 45.

3 Configure the database connection parameters. For more information, see “Configure the Database

Connection,” on page 46.

The way in which your database is set up can affect Orchestrator performance. Install the database on a machine other than the one on which the Orchestrator server is installed. This approach avoids the JVM and DB server having to share CPU, RAM, and I/O.

Storing your database plug-ins in a database separate from the one that Orchestrator uses results in more modularity when upgrading the system. A dedicated database instance allows you to perform upgrades and maintenance without impacting other products.

20 VMware, Inc.

Chapter 3 Orchestrator Components Setup

The location of the database is important because almost every activity on the Orchestrator server triggers operations on the database. To avoid latency in the database connection, connect to the database server that is geographically closest to your Orchestrator server and that is on the network with the highest bandwidth.

The size of the Orchestrator database varies depending on the setup and how workflow tokens are handled. Allow for approximately 50KB per vCenter Server object and 4KB per workflow run.

CAUTION Verify that at least 1GB of free disk space is available on the machine where the Orchestrator database is installed and on the machine where the Orchestrator server is installed.

Insufficient disk storage space might result in unwanted behavior of the Orchestrator server and client.

VMware, Inc. 21

Installing and Configuring VMware vCenter Orchestrator

22 VMware, Inc.

Installing and Upgrading Orchestrator 4

Orchestrator consists of a server component and a client component. You can install the Orchestrator components on the machine on which vCenter Server is installed or on a separate machine. To improve performance, install the Orchestrator server component on a separate machine.

After you install or upgrade Orchestrator standalone, you must start the Orchestrator Configuration service, and configure Orchestrator by using the Orchestrator configuration interface.

You can install the Orchestrator configuration server on 64-bit Windows machines only. The Orchestrator client can run on both 32-bit and 64-bit Windows machines.

To install Orchestrator, you must be either a local Administrator or a domain user that is a member of the Administrators group.

You can install and upgrade Orchestrator together during the vCenter Server installation or upgrade. When you install vCenter Server 5.1, Orchestrator 5.1 is silently installed on your system as an additional component and requires no further configuration. To use Orchestrator, you must start the Orchestrator Server service and then start the Orchestrator client. Any user from the vCenter Server administrator group that you have provided during the vCenter Server installation, is an Orchestrator administrator. If you need to change the default configuration settings, you must first start the Orchestrator Configuration service, and change the settings by using the Orchestrator configuration interface.

For information about the vCenter Server software and hardware requirements, prerequisites, and installation steps, see vSphere Installation and Setup.

VMware, Inc.

For information about upgrading vCenter Server, see vSphere Upgrade.

After you upgrade vCenter Server and Orchestrator, you must reimport the SSL certificate for the licensed vCenter Server and start the Orchestrator server. For more information about importing the vCenter Server SSL certificate, see “Import the vCenter Server SSL Certificate,” on page 35.

IMPORTANT Each installation of the Orchestrator server has a unique certificate. To run remote workflows from one Orchestrator server over another Orchestrator server, ensure that you either replace the SSL keystore, or maintain separate SSL keypairs and use the trust manager. See “Enable Orchestrator for Remote Workflow

Execution,” on page 74.

This chapter includes the following topics:

“Download the vCenter Server Installer,” on page 24

“Install Orchestrator Standalone,” on page 24

“Install the Orchestrator Client on a 32-Bit Machine,” on page 25

“Upgrade Orchestrator 4.2.x Standalone,” on page 26

“Upgrading Orchestrator 4.0.x Running on a 64-Bit Machine,” on page 27

Installing and Configuring VMware vCenter Orchestrator

“Upgrading Orchestrator 4.0.x and Migrating the Configuration Data,” on page 30

“Uninstall Orchestrator,” on page 30

Download the vCenter Server Installer

You must download the installer for vCenter Server, the vSphere Client, and associated vCenter components and support tools.

Procedure

1 Download the zip file for vCenter Server from the VMware downloads page at

http://www.vmware.com/support/.

2 Extract the files from the zip archive.

Install Orchestrator Standalone

For production environments and to enhance the scalability of your Orchestrator setup, install Orchestrator on a dedicated Windows machine.

You can install the Orchestrator server only on a 64-bit operating system platform.

The Orchestrator client can run on both 32-bit and 64-bit Windows machines.

You can install the Orchestrator client on a 32-bit machine. For more information, see “Install the Orchestrator

Client on a 32-Bit Machine,” on page 25.

NOTE If you try to install Orchestrator 5.1 on a 64-bit machine on which an instance of Orchestrator 4.0.x is running, the 64-bit installer does not detect the earlier version of Orchestrator. As a result, two versions of Orchestrator are installed and coexist.

Prerequisites

Verify that your hardware meets the Orchestrator system requirements. See “Hardware Requirements for

Orchestrator,” on page 15.

Download the vCenter Server 5.1 installer from the VMware Web site.

Procedure

1 Start the Orchestrator installer.

In the software installer directory, browse to the C:\ double-click vCenterOrchestrator.exe.

The file contains installers for the client and the server components.

2 Click Next.

3 Accept the terms in the license agreement and click Next.

4 Either accept the default destination folders or click Change to select another location, and click Next.

install_directory

\vCenter-Server\vCO\ folder and

CAUTION You cannot install Orchestrator in a directory whose name contains non-ASCII characters. If you are operating in a locale that features non-ASCII characters, you must install Orchestrator in the default location.

24 VMware, Inc.

Chapter 4 Installing and Upgrading Orchestrator

5 Select the type of installation and click Next.

Option Description

Client

Server

Client-Server

Installs the Orchestrator client application, which allows you to create and edit workflows.

Installs the Orchestrator server platform.

Installs the Orchestrator client and server.

6 Specify the location for the Orchestrator shortcuts and click Next.

CAUTION The name of the shortcuts directory must contain only ASCII characters.

7 Click Install to complete the installation process.

8 Click Done to close the installer.

What to do next

To start configuring Orchestrator, verify that the VMware vCenter Orchestrator Configuration service is running and log in to the Orchestrator configuration interface at: https://orchestrator_server_DNS_name_or_IP_address:8283 or https://localhost:8283.

Install the Orchestrator Client on a 32-Bit Machine

The Orchestrator client is a desktop application that allows you to import packages, run and schedule workflows, and manage user permissions. If you install vCenter Server, the Orchestrator client is installed silently on your system. You can install the Orchestrator client on a 32-bit machine.

You can use the standalone Orchestrator client installer on a 32-bit machine only.

Prerequisites

Download the Orchestrator client 32-bit installer from the VMware Web site.

Procedure

1 Log in to the 32-bit machine as an administrator.

2 Double-click the vCenter Orchestrator client distribution file and click Next.

The filename is vCenterOrchestratorClient-5. and yyy is the build number.

3 Accept the terms in the license agreement and click Next.

4 Either accept the default destination folders or click Change to select another location, and click Next.

a.b.-yyy

.exe, where a and b are major and minor version,

5 Specify the location for the Orchestrator shortcuts and click Next.

CAUTION The name of the shortcuts directory must contain only ASCII characters.

6 Review the summary and click Next.

7 Click Install to complete the installation process.

8 Click Done to close the installer.

VMware, Inc. 25

Installing and Configuring VMware vCenter Orchestrator

The Orchestrator client component is installed on your system.

What to do next

You can log in to the Orchestrator client interface and perform general administration tasks and create workflows.

Upgrade Orchestrator 4.2.x Standalone

To upgrade Orchestrator 4.2.x on a 64-bit Microsoft Windows machine that is different from the machine on which vCenter Server runs, start the latest version of the Orchestrator standalone installer.

Prerequisites

Create a backup of the Orchestrator database.

Back up your Orchestrator configuration, as well as custom workflows and packages. See “Back Up the

Orchestrator Configuration and Elements,” on page 78.

Download the vCenter Server 5.1 installer from the VMware Web site.

Procedure

1 Stop the Orchestrator server service.

a Select Start > Programs > Administrative Tools > Services.

b In the right pane, right-click VMware vCenter Orchestrator Server and select Stop.

c In the right pane, right-click VMware vCenter Orchestrator Configuration and select Stop.

2 Start the Orchestrator installer.

In the software installer directory, browse to the C:\

install_directory

\vCenter-Server\vCO\ folder and

double-click vCenterOrchestrator.exe.

The file contains installers for the client and the server components.

3 Click Next.

4 Accept the terms in the license agreement and click Next.

5 Select Continue with update to upgrade Orchestrator.

6 When the installer detects the installation directory, click Next.

You cannot change the installation directory when you are upgrading Orchestrator. To change this parameter, you must perform a fresh installation.

7 Select the type of upgrade that matches your existing installation type and click Next.

Option Description

Client

Server

Client-Server

Upgrades the Orchestrator client application, which allows you to create and edit workflows.

Upgrades the Orchestrator server platform.

Upgrades the Orchestrator client and server.

For example, if you installed only the Orchestrator client, select Client and then upgrade your Orchestrator server separately.

IMPORTANT The versions of the Orchestrator client and server must be the same.

26 VMware, Inc.

Chapter 4 Installing and Upgrading Orchestrator

8 Specify the location for the Orchestrator shortcuts and click Next.

CAUTION The name of the shortcuts directory must contain only ASCII characters.

9 Click Install to complete the installation process.

10 Click Done to close the installer.

11 Start the Orchestrator configuration service and log in to the Orchestrator configuration interface.

12 On the Database tab, update the database by clicking Update database.

13 Reimport the SSL certificate for the licensed vCenter Server and start the Orchestrator server.

For more information about importing the vCenter Server SSL certificate, see “Import the vCenter Server

SSL Certificate,” on page 35.

You upgraded to the latest version of Orchestrator. The existing Orchestrator configuration is preserved.

Upgrading Orchestrator 4.0.x Running on a 64-Bit Machine

If vCenter Orchestrator 4.0.x is installed on the same 64-bit machine as vCenter Server 4.0 and the later update releases, you cannot upgrade Orchestrator by upgrading to vCenter Server 5.1. VMware does not support the in-place upgrade of a standalone Orchestrator instance running on a 64-bit machine.

To upgrade to Orchestrator 5.1, you must export the Orchestrator configuration settings, uninstall the existing Orchestrator instance, run the Orchestrator installer, and import the configuration settings.

1 Export the Orchestrator Configuration on page 27

The Orchestrator configuration interface provides a mechanism to export the Orchestrator configuration settings to a local file. This mechanism allows you to take a snapshot of your system configuration at any moment and import this configuration into a new Orchestrator instance.

2 Uninstall Orchestrator on page 28

You can remove the Orchestrator client and server components from your system by using Add or Remove Programs.

3 Install Orchestrator Standalone on page 28

For production environments and to enhance the scalability of your Orchestrator setup, install Orchestrator on a dedicated Windows machine.

4 Import the Orchestrator Configuration on page 29

You can restore the previously exported system configuration when you reinstall Orchestrator or if a system failure occurs.

Export the Orchestrator Configuration

You should export and save your configuration settings on a regular basis, especially when making modifications, performing maintenance tasks, or upgrading the system.

For a list of exported configuration settings, see “Orchestrator Configuration Files,” on page 62.

IMPORTANT Keep the file with the exported configuration safe and secure, because it contains sensitive administrative information.

VMware, Inc. 27

Installing and Configuring VMware vCenter Orchestrator

Procedure

1 Log in to the Orchestrator configuration interface as vmware.

2 On the General tab, click Export Configuration.

3 (Optional) Type a password to protect the configuration file.

Use the same password when you import the configuration.

4 Click Export.

Orchestrator creates a vmo_config_

dateReference

.vmoconfig file on the machine on which the Orchestrator

server is installed. You can use this file to clone or to restore the system.

Uninstall Orchestrator

You can remove the Orchestrator client and server components from your system by using Add or Remove Programs.

Prerequisites

Save the Orchestrator configuration settings to a local file. For more details, see “Export the Orchestrator

Configuration,” on page 27.

Back up custom workflows and plug-ins.

Procedure

1 From the Windows Start menu, select Settings > Control Panel > Add or Remove Programs.

2 Select vCenter Orchestrator and click Remove.

3 Click Uninstall in the Uninstall vCenter Orchestrator window.

A message confirms that all items have been successfully removed.

4 Click Done.

Orchestrator is uninstalled from your system.

Install Orchestrator Standalone

For production environments and to enhance the scalability of your Orchestrator setup, install Orchestrator on a dedicated Windows machine.

You can install the Orchestrator server only on a 64-bit operating system platform.

The Orchestrator client can run on both 32-bit and 64-bit Windows machines.

You can install the Orchestrator client on a 32-bit machine. For more information, see “Install the Orchestrator

Client on a 32-Bit Machine,” on page 25.

Prerequisites

Verify that your hardware meets the Orchestrator system requirements. See “Hardware Requirements for

Orchestrator,” on page 15.

Download the vCenter Server 5.1 installer from the VMware Web site.

28 VMware, Inc.

Procedure

1 Start the Orchestrator installer.

Chapter 4 Installing and Upgrading Orchestrator

In the software installer directory, browse to the C:\

install_directory

\vCenter-Server\vCO\ folder and

double-click vCenterOrchestrator.exe.

The file contains installers for the client and the server components.

2 Click Next.

3 Accept the terms in the license agreement and click Next.

4 Either accept the default destination folders or click Change to select another location, and click Next.

5 Select the type of installation and click Next.

Option Description

Client

Server

Client-Server

Installs the Orchestrator client application, which allows you to create and edit workflows.

Installs the Orchestrator server platform.

Installs the Orchestrator client and server.

6 Specify the location for the Orchestrator shortcuts and click Next.

CAUTION The name of the shortcuts directory must contain only ASCII characters.

7 Click Install to complete the installation process.

8 Click Done to close the installer.

What to do next

Import the Orchestrator Configuration

You can restore the previously exported system configuration when you reinstall Orchestrator or if a system failure occurs.

If you use the import procedure for cloning the Orchestrator configuration, the vCenter Server plug-in configuration becomes invalid and non-working, because a new ID of the vCenter Server plug-in is generated. After you import the Orchestrator configuration, you must provide a valid password for each registered vCenter Server instance. For more information about configuring the vCenter Server plug-in, see “Configure

the vCenter Server 5.1 Plug-In,” on page 54.

Procedure

1 Log in to the Orchestrator configuration interface as vmware.

2 On the General tab, click Import Configuration.

3 Type the password you used when exporting the configuration.

This step is not necessary if you have not specified a password.

VMware, Inc. 29

+ 67 hidden pages