VMware vCenter Orchestrator - 6.0 User Manual

Using the vCenter Orchestrator Plug-In
for vCloud Automation Center 6.2
vCenter Orchestrator 6.0.0
vCloud Automation Center 6.2.0
vRealize Automation 6.2.0
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-001681-00
Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2
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 © 2012–2014 VMware, Inc. All rights reserved. Copyright and trademark information.
VMware, Inc.
3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com
2 VMware, Inc.

Contents

Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2 5
Introduction to the VMware vCenter Orchestrator Plug-In for
1
vCloud Automation Center 7
Role of vCenter Orchestrator with the vCloud Automation Center Plug-In 7
Installing the vCloud Automation Center Plug-In 8
vCloud Automation Center Plug-In Functional Prerequisites 8
Install the vCloud Automation Center Plug-In On an External vCenter Orchestrator Server 8
Configuring the vCloud Automation Center Plug-In 11
2
Configuration Workflows 11
Add a vCloud Automation Center Host 12
Add an IaaS Host 13
Using the vCloud Automation Center Plug-In Workflows 15
3
Using the vCloud Automation Center Plug-In Inventory 15
Using the vCloud Automation Center Plug-In Administration Workflows 15
Using the vCloud Automation Center Plug-In Infrastructure Administration Workflows 19
Create a vCloud Automation Center Model Entity 21
Read a vCloud Automation Center Model Entity 22
Using the vCloud Automation Center Plug-In Requests Workflows 22
Using the vCloud Automation Center Plug-In Sample Workflows 22
Access the vCloud Automation Center Plug-In API 23
Example vCloud Automation Center Plug-In Scripts 25
4
CRUD Infrastructure Administration Tasks Example Scripts 25
Finding vCloud Automation Center Entities Example Scripts 29
Get a Resource Provisioned by vCloud Automation Center Example Script 30
Common Tasks Example Scripts 32
Transfer Content Between vCloud Automation Center Hosts Example Script 34
Index 37
VMware, Inc. 3
Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2
4 VMware, Inc.

Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2

Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2 provides information and instructions about configuring and using the VMware® vCenter Orchestrator plug-in for VMware vCloud Automation Center 6.2.
Intended Audience
The information in Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2 is written for experienced users who are familiar with virtual machine technology, with Orchestrator workflow development, and with VMware vCloud Automation Center.
For more information about Orchestrator, see
http://www.vmware.com/support/pubs/orchestrator_pubs.html.
For more information about vCloud Automation Center, see
http://www.vmware.com/support/pubs/vcac-pubs.html.
VMware Technical Publications Glossary
VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions of terms as they are used in VMware technical documentation, go to
http://www.vmware.com/support/pubs.
VMware, Inc.
5
Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2
6 VMware, Inc.
Introduction to the VMware vCenter Orchestrator Plug-In for
vCloud Automation Center 1
The VMware vCenter Orchestrator plug-in for vCloud Automation Center allows interaction between vCenter Orchestrator and vCloud Automation Center.
You can use the vCloud Automation Center plug-in to create and run workflows for the following vCloud Automation Center functions:
Service management
n
Catalog item and resource management and requesting
n
Advanced Services custom resource and blueprint management
n
Entitlement configuration
n
Approval policy configuration
n
Work item interactions
n
vSphere and vCloud Director virtual machine provisioning and post-provisioning actions
n
Create, read, update, and delete (CRUD) operations on the vCloud Automation Center IaaS model
n
This chapter includes the following topics:
“Role of vCenter Orchestrator with the vCloud Automation Center Plug-In,” on page 7
n
“Installing the vCloud Automation Center Plug-In,” on page 8
n

Role of vCenter Orchestrator with the vCloud Automation Center Plug-In

You use the Orchestrator client to run and create workflows and access the plug-in API. You can use either the embedded vCenter Orchestrator instance in your vCloud Automation Center installation, or an external vCenter Orchestrator server.
vCenter Orchestrator powers the vCloud Automation Center plug-in. Orchestrator is a development and process-automation platform that provides a library of extensible workflows to manage the vCenter infrastructure and other technologies.
Orchestrator allows integration with management and administration solutions through its open plug-in architecture.
VMware, Inc.
7
Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2

Installing the vCloud Automation Center Plug-In

The vCloud Automation Center plug-in is installed on the embedded vCenter Orchestrator instance in your vCloud Automation Center installation. You can use the configuration interface of an external vCenter Orchestrator server to install the vCloud Automation Center plug-in.

vCloud Automation Center Plug-In Functional Prerequisites

To install and use the vCloud Automation Center plug-in, your system must meet certain functional prerequisites.
vCloud Automation Center
You must have access to a vCloud Automation Center server. Version 6.2 of the plug-in works with vCloud Automation Center 6.2.
For information about setting up vCloud Automation Center, see vCloud Automation Center Installation and Configuration.
vCenter Orchestrator Server
Version 6.2 of the plug-in works with vCenter Orchestrator 6.0.0.
For information about setting up Orchestrator, see Installing and Configuring VMware vCenter Orchestrator.
Other Prerequisites
For full plug-in functionality, you must uninstall Web Distributed Authoring and Versioning (WebDAV) from your Microsoft Web Server (IIS) role services.

Install the vCloud Automation Center Plug-In On an External vCenter Orchestrator Server

You can install the plug-in on an external vCenter Orchestrator server by using the Orchestrator configuration interface.
Prerequisites
Download the .vmoapp file that contains the plug-in.
n
Log in to the Orchestrator configuration interface at http://orchestrator_server:8283.
n
Procedure
1 On the General tab, click Install Application.
2 Upload the vCloud Automation Center plug-in.
a Click the magnifying glass icon.
b Select the .vmoapp file to install.
c Click Open.
d Click Install.
A message appears after successful installation. The vCloud Automation Center plug-in is installed without a tab in the Orchestrator configuration interface.
3 On the Startup Options tab, click Restart service to complete the plug-in installation.
8 VMware, Inc.
Chapter 1 Introduction to the VMware vCenter Orchestrator Plug-In for vCloud Automation Center
What to do next
Configure the vCloud Automation Center plug-in.
VMware, Inc. 9
Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2
10 VMware, Inc.
Configuring the
vCloud Automation Center Plug-In 2
You add vCloud Automation Center hosts and IaaS hosts to configure the plug-in.

Configuration Workflows

You can use the workflows in the Configuration workflow categories to manage vCloud Automation Center hosts.
vCloud Automation Center Hosts
You can access these workflows from the Workflows view of the Orchestrator client, in the Configuration subdirectory of the plug-in library.
Workflow Name Description
Add a vCAC host Adds a vCloud Automation Center host to the plug-in inventory. For tenant management
and administration tasks, you can use the Inventory view to run workflows on each tenant. To use the full function of the plug-in for a tenant, create a dedicated vCloud Automation Center host for each tenant.
Add a vCAC host using component registry
Add the IaaS host of a vCAC host
Remove a vCAC host Removes a vCloud Automation Center host from the plug-in inventory.
Update a vCAC host Updates a vCloud Automation Center host in the plug-in inventory.
Validate a vCAC host Validates the vCloud Automation Center host and the connection to it.
Adds a vCloud Automation Center host to the plug-in inventory with a Per User Session connection. You must be logged in to the Orchestrator client with the credentials of the vCloud Automation Center system administrator.
To use this function with an external vCenter Orchestrator server, you must register the Orchestrator server in the vCloud Automation Center component registry. To do this registration, you must run the Register vCO in vCAC Component Registry workflow and restart the Orchestrator server.
Adds the IaaS host of the selected vCloud Automation Center host to the plug-in inventory.
NOTE If your vCenter Orchestrator server is registered in the vCloud Automation Center component registry, a vCloud Automation Center host with the name Default is automatically added. The Default host is using Per User Session connection to the default tenant. The embedded Orchestrator server in the vCloud Automation Center installation is registered in the vCloud Automation Center component registry by default.
vCloud Automation Center IaaS Hosts
You can access these workflows from the Workflows view of the Orchestrator client, in the Infrastructure Administration > Configuration subdirectory of the plug-in library.
VMware, Inc.
11
Using the vCenter Orchestrator Plug-In for vCloud Automation Center 6.2
The embedded Orchestrator server in the vCloud Automation Center installation is registered in the vCloud Automation Center component registry by default.
Workflow Name Description
Add an IaaS host Adds a vCloud Automation Center IaaS host to the plug-in inventory. This workflow is
functionally the same as Add the IaaS host of a vCAC host, but does not require a vCloud Automation Center host.
Remove an IaaS host Removes a vCloud Automation Center IaaS host from the plug-in inventory.
Update an IaaS host Updates a vCloud Automation Center IaaS host in the plug-in inventory.
Validate an IaaS host Validates the vCloud Automation Center IaaS host and the connection to it.

Add a vCloud Automation Center Host

You can run a workflow to a vCloud Automation Center host and configure the host connection parameters.
Procedure
1 From the drop-down menu in the Orchestrator client, select Run or Design.
2 Click the Workflows view.
3 Select Library > vCloud Automation Center > Configuration.
4 Right-click the Add a vCAC host workflow and select Start workflow.
5 Enter a unique name for the host in the Host Name text box.
6 Enter the URL address of the host in the Host URL text box.
For example: https://hostname.
7 (Optional) Enter the name of the tenant in the Tenant text box.
To use the full functionality of the plug-in for a tenant, create a dedicated vCloud Automation Center host for each tenant.
8 Select whether to install the SSL certificates automatically without user confirmation.
9 (Optional) To configure the length of time vCenter Orchestrator waits for a connection or response from
vCloud Automation Center, enter timeout intervals in the Connection timeout (seconds) and Operation timeout (seconds) text boxes.
10 Select the type of connection to the host from the Session mode drop-down menu.
Option Actions
Shared Session
Per User Session
Enter the credentials for a vCloud Automation Center user in the Authentication username and Authentication password text boxes.
Connect by using the credentials of the user that is currently logged in. You must be logged in to the Orchestrator client with the credentials of the vCloud Automation Center system administrator.
To use this option with an external vCenter Orchestrator server, you must run the Register vCO in vCAC Component Registry workflow and restart the Orchestrator server.
11 Click Submit.
What to do next
Add a vCloud Automation Center Infrastructure Administration host.
12 VMware, Inc.
Loading...
+ 26 hidden pages