VMware vCenter Orchestrator - 5.1 User Manual
Using the VMware vCenter Orchestrator
Client
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-000808-00
Using the VMware vCenter Orchestrator Client
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.
Contents
Using the VMware vCenter Orchestrator Client 5
The Orchestrator Client 7
1
Log in to the Orchestrator Client 7
Orchestrator Client Perspectives 8
Orchestrator Views in the Run Perspective 8
Orchestrator Views in the Design Perspective 9
Orchestrator Views in the Administer Perspective 9
User Preferences 10
Access the Orchestrator API Explorer 11
Managing Workflows 13
2
Key Concepts of Workflows 14
Workflow User Permissions 14
Workflow Parameters 14
Workflow Attributes 15
Workflow Schema 15
Workflow Presentation 15
Workflow Tokens 15
Workflow Version History 15
Standard Workflows in the Workflow Library 16
Set User Permissions on a Workflow 16
Run a Workflow 17
Respond to a Request for a User Interaction 18
Scheduling Workflows 19
Schedule a Workflow 19
Edit the Workflow Recurrence Pattern 20
Use Workflow Version History 20
Restore Deleted Workflows 21
Export a Workflow 21
Import a Workflow 21
VMware, Inc.
Managing Policies 23
3
Create a Policy 23
Apply a Policy 24
Using Packages 25
4
Create a Package 25
Set User Permissions on a Package 26
Export a Package 27
Import a Package 28
3
Using the VMware vCenter Orchestrator Client
Get a Remote Package 28
Synchronize a Remote Package 29
Remove a Package 30
Using Authorizations 31
5
Create an Authorization Element 31
Configure an Authorization Element 31
Index 33
4 VMware, Inc.
Using the VMware vCenter Orchestrator Client
Using the VMware vCenter Orchestrator Client provides information and instructions about performing tasks in
the VMware® vCenter Orchestrator client.
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. 5
Using the VMware vCenter Orchestrator Client
6 VMware, Inc.
The Orchestrator Client 1
The Orchestrator client is an easy-to-use desktop application. By using the Orchestrator client you can import
packages, run and schedule workflows, and manage user permissions.
In addition, by using the Orchestrator client you can also develop workflows and actions as well as create
packages and resource elements. For more information, see Developing with VMware vCenter Orchestrator.
This chapter includes the following topics:
n
“Log in to the Orchestrator Client,” on page 7
n
“Orchestrator Client Perspectives,” on page 8
n
“User Preferences,” on page 10
n
“Access the Orchestrator API Explorer,” on page 11
Log in to the Orchestrator Client
To perform general administration tasks or to edit and create workflows, you must log in to the Orchestrator
client interface.
The Orchestrator client interface is designed for developers with administrative rights who want to develop
workflows, actions, and other custom elements.
VMware, Inc.
IMPORTANT Ensure that the clocks of the Orchestrator server machine and the Orchestrator client machine are
synchronized.
Prerequisites
All components of the Orchestrator server must be configured and the Orchestrator server service must be
running.
Procedure
1 Log in as an administrator to the machine on which the Orchestrator client is installed.
2 Click Start > Programs > VMware > vCenter Orchestrator Client.
3 In the Host name field, type the IP address to which Orchestrator server is bound.
To check the IP address, log in to the Orchestrator configuration interface and check the IP settings on the
Network tab.
4 Log in by using the Orchestrator user name and password.
To check the credentials, log in to the Orchestrator configuration interface and check the credentials on
the Authentication tab.
7
Using the VMware vCenter Orchestrator Client
5 In the Security Warning window select an option to handle the certificate warning.
The Orchestrator client communicates with the Orchestrator server by using an SSL certificate. A trusted
CA does not sign the certificate during installation. Because of this, you receive a certificate warning each
time you connect to the Orchestrator server.
Option Description
Ignore
Cancel
Install this certificate and do not
display any security warnings for it
anymore.
You can change the default SSL certificate with a certificate signed by CA. For more information about
changing SSL certificates, see Installing and Configuring VMware vCenter Orchestrator.
The My Orchestrator view appears. This view summarizes the recent activities on the server, shows pending
and running workflows, running policies, scheduled tasks, completed workflows, and elements you recently
edited.
Click Ignore to continue using the current SSL certificate.
The warning message appears again when you reconnect to the same
Orchestrator server, or when you try to synchronize a workflow with a
remote Orchestrator server.
Click Cancel to close the window and stop the login process.
Select this check box and click Ignore to install the certificate and stop
receiving security warnings.
What to do next
You can import a package, start a workflow, or set root access rights on the system.
Orchestrator Client Perspectives
You can access different views in the Orchestrator client by selecting one of three perspectives. Each perspective
offers specific functionality.
You can select a perspective by using the drop-down list on the main menu in the Orchestrator client. The
default view is Run.
Perspective Description
Run You can schedule tasks, manage policies, run workflows, access the inventory, and manage permissions from
the My Orchestrator view. This perspective also gives you an overview of recent activities.
Design You can create and modify workflows and actions. You can also manage resources, configuration elements,
and policy templates.
Administer You can access the inventory and manage authorizations, Web views, and packages.
Orchestrator Views in the Run Perspective
From the Run perspective in the Orchestrator client, you can schedule tasks, manage policies, run workflows,
access the inventory, and manage permissions.
View Description
My Orchestrator Summarizes the most recent activities on the Orchestrator server, such as recently modified elements,
pending and running workflows, running policies, completed workflows, and workflows that are
waiting for user interaction.
You can use the My Orchestrator view to perform common administrative tasks, such as running a
workflow, importing a package, and setting root access rights.
Scheduler Displays a list of all scheduled workflows in the system. The workflows are sorted by name or date,
together with their status.
You can use the Scheduler view to create, edit, suspend, resume, and cancel scheduled workflows.
8 VMware, Inc.
Chapter 1 The Orchestrator Client
View Description
Policies Displays existing policies.
You can use the Policies view to create and apply policies.
Workflows Provides access to the Orchestrator workflow library.
You can use the Workflows view to view information about each workflow, create, edit, and run
workflows, as well as to interact with the workflows.
Inventory Displays the objects of the plug-ins that are enabled in Orchestrator.
You can use the Inventory view to run workflows on an inventory object.
Orchestrator Views in the Design Perspective
From the Design perspective in the Orchestrator client, you can create and modify workflows and actions. You
can also manage resources, configuration elements, and policy templates.
View Description
Workflows Provides access to the Orchestrator workflow library.
You can use the Workflows view to view information about each workflow, create, edit, and run
workflows, as well as to interact with the workflows.
Actions Provides access to the libraries of predefined actions.
You can use the Actions view to duplicate actions, export them to a file, or move them to a different
module in the actions hierarchical list.
Resources Provides access to the list of resource elements.
You can use the Resources view to import external objects such as images, sysprep files, HTML templates,
XML templates, and custom scripts, and use them as resource elements in workflows and Web views.
Configurations Provides access to the available configuration elements.
You can use the Actions view to create configuration elements to define common attributes across an
Orchestrator server.
Packages Displays a list of the available packages and where a selected package is used.
You can use the Packages view to add, import, export, and synchronize packages.
Inventory Displays the objects of the plug-ins that are enabled in Orchestrator.
You can use the Inventory view to run workflows on an inventory object.
Orchestrator Views in the Administer Perspective
From the Administer perspective in the Orchestrator client, you can access the inventory and manage
authorizations, Web views, and packages.
View Description
Inventory Displays the objects of the plug-ins that are enabled in Orchestrator.
You can use the Inventory view to run workflows on an inventory object.
Policy Templates Displays a list of the available master policies.
You can use the Policy Templates view to create policy templates.
Authorizations Displays a list of the available authorization elements.
You can use the Authorizations view to create and edit authorization elements.
Web views Displays a list of the available Web views.
You can use the Web views view to create, publish, and export Web views to a working folder. You
can either modify exported Web views or use them as templates from which to create other Web views.
You can also use Web views to access Orchestrator functions from a Web browser.
Packages Displays a list of the available packages and where a selected package is used.
You can use the Packages view to add, import, export, and synchronize packages.
VMware, Inc. 9
Using the VMware vCenter Orchestrator Client
User Preferences
You can customize the options displayed to users of the Orchestrator client by using the User preferences tool.
Your preferences are saved on the client side in the vmware-vmo.cfg file.
To set preferences, select Tools > User preferences in the Orchestrator client toolbar.
From the User preferences tool you can change the following preferences.
General Preferences
Table 1-1. Orchestrator Client Customization Options
Option Description
Auto-edit new inserted The new elements that you add open in an editor.
Script compilation delay [ms] The frequency of the background task that compiles the scripts and reports
Show decision scripts The option enables you to see the decision script of the implemented
Delete non empty folder permitted The option enables you to delete a folder together with its subfolders and
Size of run logs (number of lines) The maximum number of lines in the system log that Orchestrator displays
Server log fetch limit The maximum number of lines in the server logs that Orchestrator fetches
Finder maximum size The maximum number of results that the searches return when you search
Check usage when deleting an element (slow) Orchestrator checks whether the element you are trying to delete is
Check OGNL expression Orchestrator validates the OGNL expressions in the workflow
errors in edit mode in milliseconds.
decision functions.
contents.
when you select a workflow run in the Orchestrator client and click
Logs on the Schema tab.
The value must be greater than 0.
from the database and displays when you click any of the Events tabs in
the Orchestrator client.
The value must be greater than 0.
for elements such as actions or workflows.
The value must be greater than 0.
referenced by other elements. If the element is used by another workflow,
policy, or action, a warning message appears.
presentations.
NOTE The use of OGNL expressions in workflow presentations is
deprecated as of Orchestrator 4.1. Using OGNL expressions in workflow
presentations is not supported in Orchestrator 4.1 and later.
Workflows Preferences
Table 1-2. Workflow Editor Customization Options
Option Description
Check task/decision IN/OUT parameters Orchestrator checks whether the input and output parameters of an
activity are correctly bound to the corresponding input or output attribute
of the workflow.
Check error in task's scripts Orchestrator validates the script in scriptable task elements.
Check workflow termination Orchestrator checks whether each terminal transition of a workflow with
different possible outcomes is connected to an End Workflow schema
element.
10 VMware, Inc.
Chapter 1 The Orchestrator Client
Table 1-2. Workflow Editor Customization Options (Continued)
Option Description
Check unreachable items Orchestrator checks whether all activities are reachable.
Check unused workflow's
parameters/attributes
Check for unknown types within plug-ins Orchestrator checks whether all parameters and attributes of a workflow
Check for legacy actions scripting calls Orchestrator detects legacy actions calls and displays a warning message.
Use direct lines as workflow diagram links The connector tool uses direct lines to link the workflow schema elements.
Display workflows in a tree view The workflow selector displays a hierarchical tree viewer instead of the
Edit workflow items in a pop-up window Orchestrator opens a pop-up window in which you can edit the workflow
Display grid in the schema editor Orchestrator displays a grid in the schema editor.
Validate a workflow before running it Orchestrator validates each workflow before running it.
Validate a workflow before saving it Orchestrator validates each workflow before saving it.
Increase the workflow version when clicking
save and close
Pop up a workflow user interaction form Orchestrator pops up a workflow user interaction form.
Orchestrator checks whether all parameters and attributes of a workflow
are used.
are of a known type.
default list panel.
items.
Orchestrator increases the workflow version when clicking save and close.
Inventory Preferences
You can select the Use contextual menu in inventory option to display the workflows that are available for
an inventory object. After the option is enabled, when you right-click an object in the Orchestrator inventory,
all workflows applicable to the selected object type are displayed.
Script Editor Preferences
You can customize the scripting engine. For example, you can disable automatic completion of lines, highlight
selected lines and brackets, and change the options for default color code formatting.
Access the Orchestrator API Explorer
Orchestrator provides an API Explorer that you can use to search the Orchestrator API and see the
documentation for JavaScript objects that you can use in scripted elements.
You can consult an online version of the Scripting API for the vCenter Server plug-in on the Orchestrator
documentation home page.
Procedure
1 Log in to the Orchestrator client and select Design or Run from the drop-down menu in the left upper
corner.
2 Select Tools > API Explorer.
The API Explorer appears. You can use it to search all the objects and functions of the Orchestrator API.
What to do next
Use the API Explorer to write scripts for scriptable elements.
VMware, Inc. 11
Loading...