1. No category

VMware vCloud Director Adapter
Installation and Configuration Guide
vCenter Operations Manager 2.6
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-000922-06
VMware vCloud Director Adapter Installation and Configuration Guide
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 © 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
VMware vCloud Director Adapter Installation and Configuration Guide 5
Updated Information 7
1 Introduction to the vCloud Director Adapter 9
Default Dashboards of vCloud Director Adapter 9
Data that the Adapter Collects 10
Customizing Your Configuration 18
How the Adapter Processes Events 19
Using the vCloud Entity Status Resource Tag 20
vCloud Director Entities in vCenter Operations Manager
Installation and Configuration Requirements 21
20
2 Installing the vCloud Director Adapter 23
Install the Adapter in a Standalone Installation 23
Install the Adapter in a vApp Installation 24
vCloud Director Adapter Folders and Files 25
3 Configuring the vCloud Director Adapter 27
Add an Adapter Instance 27
Filtering the Events that the Adapter Imports
Configuring Adapter Properties 29
Import Dashboard 30
29
4 Troubleshooting the vCloud Director Adapter 33
Troubleshooting a vCloud Director Adapter Instance
Viewing System Log Files 33
Index
VMware, Inc.
33
35
3
VMware vCloud Director Adapter Installation and Configuration Guide
4
VMware, Inc.
VMware vCloud Director Adapter Installation and
Configuration Guide
The VMware vCloud Director Adapter Installation and Configuration Guide describes how to install the vCloud
Director adapter for vCenter Operations Manager.
Intended Audience
This information is intended for anyone who needs to install and configure the vCloud Director adapter.
VMware, Inc.
5
VMware vCloud Director Adapter Installation and Configuration Guide
6
VMware, Inc.
Updated Information
The VMware vCloud Director Adapter Installation and Configuration Guide is updated with each release of the
product or when necessary.
This table provides the update history of the VMware vCloud Director Adapter Installation and Configuration
Guide.
Revision
Description
EN-000922-06
Added new dashboards in “Default Dashboards of vCloud Director Adapter,” on page 9 and alert
processing information in “How the Adapter Processes Alerts,” on page 19.
EN-000922-05
Updated the supported vCloud Director and vCenter Server versions in “Installation and Configuration
Requirements,” on page 21.
EN-000922-04
n
Changed the product name to reflect the new licensing model for the 5.6 release.
n
Added the open_source_license.txt file to “vCloud Director Adapter Folders and Files,” on
page 25.
EN-000922-03
Updated the installation instructions in “Install the Adapter in a Standalone Installation,” on page 23
and “Install the Adapter in a vApp Installation,” on page 24.
EN-000922-02
Updated “Installation and Configuration Requirements,” on page 21 to include more information about
the vCenter adapter requirement.
EN-000922-01
Updated “Add an Adapter Instance,” on page 27 to include a warning about renaming the adapter
instance resource.
EN-000922-00
n
n
The vCloud Director Adapter Technical Note is now the VMware vCloud Director Adapter Installation and
Configuration Guide.
Changed the description of the vCloud Director Host text box in “Add an Adapter Instance,” on
page 27.
The vCloud Director Adapter Technical Note was the initial release of this document.
VMware, Inc.
7
VMware vCloud Director Adapter Installation and Configuration Guide
8
VMware, Inc.
Introduction to the vCloud Director
Adapter
1
The vCloud Director adapter is an embedded adapter for vCenter Operations Manager. The adapter
monitors the health of supported vCloud Director entities and sends early warning smart alerts for
monitored Provider vDC resources.
This chapter includes the following topics:
n
“Default Dashboards of vCloud Director Adapter,” on page 9
n
“Data that the Adapter Collects,” on page 10
n
“Customizing Your Configuration,” on page 18
n
“How the Adapter Processes Events,” on page 19
n
“Using the vCloud Entity Status Resource Tag,” on page 20
n
“vCloud Director Entities in vCenter Operations Manager,” on page 20
n
“Installation and Configuration Requirements,” on page 21
Default Dashboards of vCloud Director Adapter
Following default dashboards are visible after an adapter instance is created in the vCloud Director.
Table 1‑1. Dashboards in the Management Pack
Dashboard Name
Purpose
VCD All Metric Selector
This dashboard visualizes all the metrics associated with a
particular resource that are collected by the vCloud
Director adapter at a single place. The metrics for the
selected resource is displayed if you select the resource.
VCD Organization vDC Utilization
This dashboard provides a quick view of the top 10
Organization vDC based on the CPU usage, memory
usage, storage usage, vApps, network usage, storage
Allocation, etc. Based on these metrics, you can determine
the performances of the respective Organization vDC.
VCD vApp Utilization
This dashboard provides a quick view of the top 10 vApps
based on the CPU allocation, memory allocation, storage
allocation, number of virtual machines, and number of
CPUs. Based on these metrics, you can determine the
performances of the respective vApp.
VMware, Inc.
9
VMware vCloud Director Adapter Installation and Configuration Guide
Table 1‑1. Dashboards in the Management Pack (Continued)
Dashboard Name
Purpose
VCD Mashup charts
This dashboard can be used as a reference for getting the
health of the particular resources collected by the vCloud
Director. This dashboard also provides us with another
metrics known as Anomaly Count Graph, which draws out
the number of anomalies for a resource in the form of
metrics.
VCD Alerts
This dashboard pulls the alerts pulled from vCloud
Director adapter and relationship of the resource which
causes the alert and its Interesting Metric is displayed.
VCD Troubleshooting
This dashboard shows all objects and its relationship in
vCloud Director adapter based on the selection of object,
corresponding health anomalies and its Interesting Metric
is displayed.
NOTE The VCD Troubleshooting dashboard is not created even if the adapter instance is created because
vCenter Operations Manager takes few collection cycle to create a self generated resource kind. You need to
import the dashboard by running the Database Command Line Interface (DBCLI) command. For more
information on importing a dashboard, see “Import Dashboard,” on page 30.
Data that the Adapter Collects
The vCloud Director adapter collects information for Provider vDC, Organization, Organization vDC, and
vApp entities from the vCloud Director database and creates the corresponding resources in
vCenter Operations Manager. The adapter can optionally import events for these vCloud Director entities.
The vCloud Director adapter maps the vApps that it imports to virtual machine resources that the vCenter
adapter has already imported and creates resource relationships between the vApps and the virtual
machines.
The vCloud Director adapter does not collect performance data from vCloud Director. Instead, the vCloud
Director adapter enables vCenter Operations Manager to present health data by mapping vCloud Director
entities to vCenter Server objects. The vCenter adapter collects performance data for vCenter Server objects.
The list of resource kinds that vCloud Director adapter collects are as follows.
10
n
Organization
n
PVDC - Provider Virtual Data Center
n
OVDC - Organization Virtual Data Center
n
vApp
n
Cloud Cell
n
vCloud vCenter
n
vCloud Host
n
vCloud Datastore
n
Org vDC Storage Policy
n
Provider vDC Storage Policy
n
Organization vDC Network
n
vCloud Virtual Machine
n
vCloud network pool
VMware, Inc.
Chapter 1 Introduction to the vCloud Director Adapter
n
vCloud External Network
n
vCloud Entity Status - The vCloud Director adapter creates several types of entity status in vCenter
Opeations Manager user interface and depending on the resource entity status, these resources are
added to the appropriate resource kinds.
The list of metrics that the vCloud Adapater collects are as follows.
Table 1‑2. vCloud Adapter Metrics
Resource Kinds
Metrics
Cloud Cell
Summary|Status
Organization
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
VMware, Inc.
Summary|Deployed VM Quota
Summary|Enabled
Summary|Number of Catalogs
Summary|Number of Disks
Summary|Number of Groups
Summary|Number of Users
Summary|Number of Organization VDCs
Summary|Number of Running VMs
Summary|Number of vApps
Summary|Storage VM Quota
Summary|Number of Blocking Tasks
Network|<vdc>|Number of IPs Free
Network|<vdc>|Number of IPs Used
Network|<vdc>|Number of IPs Provisioned
Network|<vdc>|Number of IPs Used (%)
Network|<vdc>|Number of IPs Free (%)
ORG|Number of Blocking task
ORG|Network|<vdc>|Number of IPs Used
ORG|Network|<vdc>|Number of IPs Free
ORG|Network|<vdc>|Number of IPs Provisioned
ORG|Network|<vdc>|Number of IPs Used (%)
ORG|Network|<vdc>|Number of IPs Free (%)
11
VMware vCloud Director Adapter Installation and Configuration Guide
Table 1‑2. vCloud Adapter Metrics (Continued)
Resource Kinds
Metrics
Organization VDC
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
12
Summary|Allocation Model
Summary|Enabled
Summary|Maximum Number of VMs
Summary|Number of Disks
Summary|Number of Medias
Summary|Number of Resource Pools
Summary|Number of Storage Policies
Summary|Number of vApp Templates
Summary|Number of vApps
Summary|Status
CPU Usage|Allocation(MHz)
CPU Usage|Allocation(GHz)
CPU Usage|Free (%)
CPU Usage|Free (MHz)
CPU Usage|Free (GHz)
CPU Usage|Overhead (MHz)
CPU Usage|Overhead (GHz)
CPU Usage|Reserved (%)
CPU Usage|Reserved (MHz)
CPU Usage|Reserved (GHz)
CPU Usage|Used (%)
CPU Usage|Used (MHz)
CPU Usage|Used (GHz)
CPU Usage|vCPU Speed (MHz)
CPU Usage|vCPU Speed (GHz)
Memory|Allocation(MB)
Memory|Allocation(GB)
Memory |Free (%)
Memory |Free (MB)
Memory |Free (GB)
Memory |Overhead (MB)
Memory |Overhead (GB)
Memory |Reserved (%)
Memory |Reserved (MB)
Memory |Reserved (GB)
Memory |Used (%)
Memory |Used (MB)
Memory |Used (GB)
Storage|Summary|Allocation (MB)
Storage|Summary|Allocation (GB)
Storage|Summary|Fast Provisioning
Storage|Summary|Free (%)
Storage|Summary|Free (MB)
Storage|Summary|Free (GB)
Storage|Summary|Overhead(MB)
Storage|Summary|Overhead(GB)
Storage|Summary|Thin Provisioning
Storage|Summary|Used (%)
Storage|Summary|Used (MB)
Storage|Summary|Used (GB)
Storage|<Storage Policy>|Free (%)
Storage|<Storage Policy>|Free (MB)
VMware, Inc.
Chapter 1 Introduction to the vCloud Director Adapter
Table 1‑2. vCloud Adapter Metrics (Continued)
Resource Kinds
Metrics
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
VMware, Inc.
Storage|<Storage Policy>|Free (GB)
Storage|<Storage Policy>|Used (%)
Storage|<Storage Policy>|Used (MB)
Storage|<Storage Policy>|Used (GB)
Storage|<Storage Policy>|Total (MB)
Storage|<Storage Policy>|Total (GB)
Network|Available Networks
Network|Maximum Provisioned Networks
Network|Number of Networks Used
Summary|Allocation Model
Summary|Enabled
Summary|Maximum Number of VMs
Summary|Number of Disks
Summary|Number of Medias
Summary|Number of Resource Pools
Summary|Number of Storage Policies
Summary|Number of vApp Templates
Summary|Number of vApps
Summary|Status
CPU Usage|Allocation(MHz)
CPU Usage|Allocation(GHz)
CPU Usage|Free (%)
CPU Usage|Free (MHz)
CPU Usage|Free (GHz)
CPU Usage|Overhead (MHz)
CPU Usage|Overhead (GHz)
CPU Usage|Reserved (%)
CPU Usage|Reserved (MHz)
CPU Usage|Reserved (GHz)
CPU Usage|Used (%)
CPU Usage|Used (MHz)
CPU Usage|Used (GHz)
Memory|Allocation(MB)
Memory|Allocation(GB)
Memory |Free (%)
Memory |Free (MB)
Memory |Free (GB)
Memory |Overhead (MB)
Memory |Overhead (GB)
Memory |Reserved (%)
Memory |Reserved (MB)
Memory |Reserved (GB)
Memory |Used (%)
Memory |Used (MB)
Memory |Used (GB)
Storage|Summary|Allocation (MB)
Storage|Summary|Allocation (GB)
Storage|Summary|Fast Provisioning
Storage|Summary|Free (%)
Storage|Summary|Free (MB)
Storage|Summary|Free (GB)
Storage|Summary|Overhead(MB)
13
VMware vCloud Director Adapter Installation and Configuration Guide
Table 1‑2. vCloud Adapter Metrics (Continued)
Resource Kinds
Metrics
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
14
Storage|Summary|Overhead(GB)
Storage|Summary|Thin Provisioning
Storage|Summary|Used (%)
Storage|Summary|Used (MB)
Storage|Summary|Used (GB)
Storage|<Storage Policy>|Free (%)
Storage|<Storage Policy>|Free (MB)
Storage|<Storage Policy>|Free (GB)
Storage|<Storage Policy>|Used (%)
Storage|<Storage Policy>|Used (MB)
Storage|<Storage Policy>|Used (GB)
Storage|<Storage Policy>|Total (MB)
Storage|<Storage Policy>|Total (GB)
Network|Available Networks
Network|Maximum Provisioned Networks
Network|Number of Networks Used
Summary|Allocation Model
Summary|Enabled
Summary|Maximum Number of VMs
Summary|Number of Disks
Summary|Number of Medias
Summary|Number of Resource Pools
Summary|Number of Storage Policies
Summary|Number of vApp Templates
Summary|Number of vApps
Summary|Status
CPU Usage|Limit (MHz)
CPU Usage|Limit (GHz)
CPU Usage|Overhead (MHz)
CPU Usage|Overhead (GHz)
CPU Usage|Reserved (%)
CPU Usage|Used (MHz)
CPU Usage|Used (GHz)
CPU Usage|vCPU Speed (MHz)
CPU Usage|vCPU Speed (GHz)
Memory |Limit (MB)
Memory |Limit (GB)
Memory |Overhead (MB)
Memory |Overhead (GB)
Memory |Reserved (%)
Memory |Used (MB)
Memory |Used (GB)
Storage|Summary|Allocation (MB)
Storage|Summary|Allocation (GB)
Storage|Summary|Fast Provisioning
Storage|Summary|Free (%)
Storage|Summary|Free (MB)
Storage|Summary|Free (GB)
Storage|Summary|Overhead(MB)
Storage|Summary|Overhead(GB)
Storage|Summary|Thin Provisioning
Storage|Summary|Used (%)
VMware, Inc.
Chapter 1 Introduction to the vCloud Director Adapter
Table 1‑2. vCloud Adapter Metrics (Continued)
Resource Kinds
Metrics
n
n
n
n
n
n
n
n
n
n
n
n
n
VMware, Inc.
Storage|Summary|Used (MB)
Storage|Summary|Used (GB)
Storage|<Storage Policy>|Free (%)
Storage|<Storage Policy>|Free (MB)
Storage|<Storage Policy>|Free (GB)
Storage|<Storage Policy>|Used (%)
Storage|<Storage Policy>|Used (MB)
Storage|<Storage Policy>|Used (GB)
Storage|<Storage Policy>|Total (MB)
Storage|<Storage Policy>|Total (GB)
Network|Available Networks
Network|Maximum Provisioned Networks
Network|Number of Networks Used
15
VMware vCloud Director Adapter Installation and Configuration Guide
Table 1‑2. vCloud Adapter Metrics (Continued)
Resource Kinds
Metrics
Provider VDC
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
n
16
Summary|Status
Summary|Enabled
Summary|Number of Datastores
Summary|Number of Organization VDCs
Summary|Number of Resource Pools
Summary|Number of Storage Policies
CPU Usage|Allocation(MHz)
CPU Usage|Allocation(GHz)
CPU Usage|Free (%)
CPU Usage|Free (MHz)
CPU Usage|Free (GHz)
CPU Usage|Overhead (MHz)
CPU Usage|Overhead (GHz)
CPU Usage|Used (%)
CPU Usage|Used (MHz)
CPU Usage|Used (GHz)
CPU Usage|Total (MHz)
CPU Usage|Total (GHz)
Memory |Allocation(MB)
Memory |Allocation(GB)
Memory |Free (%)
Memory |Free (MB)
Memory |Free (GB)
Memory |Overhead (MB)
Memory |Overhead (GB)
Memory |Used (%)
Memory |Used (MB)
Memory |Used (GB)
Memory |Total (MB)
Memory |Total (GB)
Storage|Summary|Allocation (MB)
Storage|Summary|Allocation (GB)
Storage|Summary|Free (%)
Storage|Summary|Free (MB)
Storage|Summary|Free (GB)
Storage|Summary|Overhead(MB)
Storage|Summary|Overhead(GB)
Storage|Summary|Total (MB)
Storage|Summary|Total (GB)
Storage|Summary|Used (%)
Storage|Summary|Used (MB)
Storage|Summary|Used (GB)
Storage|<Storage Policy>|Free (%)
Storage|<Storage Policy>|Free (MB)
Storage|<Storage Policy>|Free (GB)
Storage|<Storage Policy>|Used (%)
Storage|<Storage Policy>|Used (MB)
Storage|<Storage Policy>|Used (GB)
Storage|<Storage Policy>|Total (MB)
Storage|<Storage Policy>|Total (GB)
Storage|<Storage Policy>|Provisioned (%)
Storage|<Storage Policy>|Provisioned (MB)
VMware, Inc.
Chapter 1 Introduction to the vCloud Director Adapter
Table 1‑2. vCloud Adapter Metrics (Continued)
Resource Kinds
Metrics
n
n
n
n
Storage|<Storage Policy>|Provisioned (GB)
Storage|<Storage Policy>|Requested (%)
Storage|<Storage Policy>|Requested (MB)
Storage|<Storage Policy>|Requested (GB)
Organization VDC Network
Direct
n Summary|Status
n Summary|Type
n Network|Network Pool|Used (%)
n Network|Network Pool|Used
n Network|Network Pool|Free (%)
n Network|Network Pool|Used
n Network|Network Pool|Total
Provider VDC Storage Policy
n
n
n
n
n
n
n
n
n
n
n
n
n
n
Organization VDC Storage Policy
n
n
n
n
n
n
n
n
n
n
vCloud Datastore
n
n
n
n
n
n
n
n
n
n
n
n
n
n
VMware, Inc.
Storage|Free (%)
Storage|Free (MB)
Storage|Free (GB)
Storage|Used (%)
Storage|Used (MB)
Storage|Used (GB)
Storage|Total (MB)
Storage|Total (GB)
Storage|Provisioned (%)
Storage|Provisioned (MB)
Storage|Provisioned (GB)
Storage|Requested (%)
Storage|Requested (MB)
Storage|Requested (GB)
Summary|Status
Summary|Default
Storage|Free (%)
Storage|Free (MB)
Storage|Free (GB)
Storage|Used (%)
Storage|Used (MB)
Storage|Used (GB)
Storage|Total (MB)
Storage|Total (GB)
Storage|Free (%)
Storage|Free (MB)
Storage|Free (GB)
Storage|Used (%)
Storage|Used (MB)
Storage|Used (GB)
Storage|Total (MB)
Storage|Total (GB)
Storage|Provisioned (%)
Storage|Provisioned (MB)
Storage|Provisioned (GB)
Storage|Requested (%)
Storage|Requested (MB)
Storage|Requested (GB)
17
VMware vCloud Director Adapter Installation and Configuration Guide
Table 1‑2. vCloud Adapter Metrics (Continued)
Resource Kinds
Metrics
vCloud External Network
n
n
n
n
n
n
vCloud Network Pool
n
n
n
n
n
n
n
vCloud Host
n
n
n
Summary|Status
Network|Network Pool|Used (%)
Network|Network Pool|Used
Network|Network Pool|Free (%)
Network|Network Pool|Used
Network|Network Pool|Total
Summary|Status
Summary|Type
Network|Network Pool|Used (%)
Network|Network Pool|Used
Network|Network Pool|Free (%)
Network|Network Pool|Free
Network|Network Pool|Total
Summary|Enabled
Summary|Status
Summary|Ready
vCloud vCenter
Summary|Status
vApp
n
n
n
n
n
n
n
n
n
n
vCloud Virtual Machine
n
n
n
n
n
n
n
Summary|Status
Summary|Number of VMs
Storage|Allocation (MB)
Storage|Allocation (GB)
Memory|Allocation (MB)
Memory|Allocation (GB)
CPU Usage | Allocation (MHz)
CPU Usage | Allocation (GHz)
CPU Usage | Number of CPUs
-APP|Storage Lease
Summary|Status
Summary|Chain Length
Summary|Guest Customization
Summary | Snapshot Size (MB)
Summary | Snapshot Size (GB)
VM|Chain Length
VM|Guest Customization
Customizing Your Configuration
You can customize your Management Pack for vCloud Director configuration by modifying configuration
properties and workload calculation definitions.
Modifying Configuration Properties
The vcloud.properties file contains configuration properties that control how Management Pack for vCloud
Director models vCloud Director services, synchronizes resource relationships, and reports resource down
alerts.
The vcloud.properties file is in the conf folder in the management pack installation folder. In a vApp
installation, edit the vcloud.properties file in the conf folder on the Analytics virtual machine. Changes to
the vcloud.properties file take effect when you restart vCenter Operations Manager services.
18
VMware, Inc.
Chapter 1 Introduction to the vCloud Director Adapter
How the Adapter Processes Alerts
The vCloud Director adapter can import alerts for vCloud Director entities that have the System
organization and the Provider vDC, Organization, Organization vDC, or vApp entity type.
n
The PROCESS_Alerts property is a global setting property that governs importing of alerts from
vCloud Director to vCenter Operations Manager. Set this property to True to import the alerts specific
to property.
n
The ENABLE_PVDC_Alerts property is a vCloud Director entity level alert setting that governs imports
of alerts specific to a Provider vDC. Set this property to True to import the alerts specific to property.
n
The ENABLE_VDC_Alerts property is a vCloud Director entity level alert setting that governs imports
of alerts specific to a vDC. Set this property to True to import the alerts specific to property.
n
The ENABLE_DATASTORE_Alerts property is a vCloud Director entity level alert setting that governs
imports of alerts specific to a datastore. Set this property to True to import the alerts specific to
property.
n
The ENABLE_VAPP_Alerts property is a vCloud Director entity level alert setting that governs imports
of alerts specific to a vApp. Set this property to True to import the alerts specific to property.
n
The ENABLE_NETWORK_Alerts property is a vCloud Director entity level alert setting that governs
imports of alerts specific to a network. Set this property to True to import the alerts specific to property.
n
The ENABLE_HOST_Alerts property is a vCloud Director entity level alert setting that governs imports
of alerts specific to a host. Set this property to True to import the alerts specific to property.
n
The ENABLE_STORAGE_PROFILE_Alerts property is a vCloud Director entity level alert setting that
governs imports of alerts specific to a storage profile. Set this property to True to import the alerts
specific to property.
How the Adapter Processes Events
The vCloud Director adapter can import events for vCloud Directory entities that have the System
organization and the Provider vDC, Organization, Organization vDC, or vApp entity type. These events
appear as change events in the Custom user interface.
The PROCESS_EVENTS property in the instance-level properties file determines whether a vCloud Director
adapter instance processes events.
A vCloud Director adapter instance uses the value of the LAST_EVENT_TIME property in the instance-level
properties file to filter out events that are already processed. During the first collection cycle,
vCenter Operations Manager sets the LAST_EVENT_TIME property to the current time minus the value of the
MIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING property. The
MIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING property is in the adapter-level properties file and its default
value is 60 minutes.
A vCloud Director adapter instance uses a white list file, called events_white_list.txt, to apply additional
filtering to events that it retrieves from vCloud Director. The adapter instance filters events based on the
white list before it imports the events into vCenter Operations Manager. You can modify the events in the
white list file.
NOTE Because the vCloud Director adapter logs in to vCloud Director as an administrator of the System
organization, it has access to only the subset of events that are available to that user. The events for vApps
are not available.
VMware, Inc.
19
VMware vCloud Director Adapter Installation and Configuration Guide
Using the vCloud Entity Status Resource Tag
The vCloud Director adapter associates each vCloud Directory entity that it maps to a resource with a
vCloud Entity Status resource tag.
The vCloud Entity Status resource tag values are NotExisting, Deployed-vApps, and NotDeployed-vApps.
Each resource tag value includes the name of a vCloud Director instance, for example,
NotExisting:mycloud.
You can select the Deployed-vApps and NotDeployed-vApps tag values to filter resources based on their
deployment status.
You can select the NotExisting tag value to locate resources that no longer exist in the vCloud Director
inventory and remove them from the Custom user interface. When objects are removed from the vCloud
Director inventory, they remain in the Custom user interface until you remove them.
vCloud Director Entities in vCenter Operations Manager
With the vCloud Director adapter, you can monitor vCloud Director entities in the Custom user interface.
The vCloud Director entities that the adapter imports, and how those entities appear in the user interface,
depend on your particular environment.
Resource Detail Page for a vApp
This example shows the type of information that appears on the Resource Detail page for a vApp. The
Health Tree pane shows the topology of the virtual machines and the Root Cause Ranking pane shows a
summary of the virtual machine that indicates a problem.
Figure 1‑1. Example of vApp Details
Resources and Mashup Charts Widgets
This example shows vCloud Director entities in the Resources and Mashup Charts widgets. Health scores
for each entity appear in the Resources widget and the Mashup Charts widget shows historical health
trends.
20
VMware, Inc.
Chapter 1 Introduction to the vCloud Director Adapter
Figure 1‑2. Examples of vCloud Director Entities in the Resources and Mashup Charts Widgets
Installation and Configuration Requirements
The vCloud Director adapter has certain installation and configuration requirements.
Compatible vCloud Director Versions
The vCloud Director adapter is compatible with vCloud Director 5.1 and 5.5.
Compatible vCenter Operations Manager Versions
The vCloud Director adapter is compatible with the following versions of vCenter Operations Manager:
n
5.7.1
n
5.8
n
5.8.x
Compatible vCenter Server Versions
The vCloud Director adapter is compatible with the following versions of vCenter Server:
n
5.1
n
5.5
vCenter Adapter Requirements
You must install and configure the vCenter adapter before you install and configure the vCloud Director
adapter.
The vCloud Director adapter uses the virtual machine resources that the vCenter adapter creates when it
creates relationships between virtual machines and the vApps that it imports from vCloud Director.
VMware, Inc.
21
VMware vCloud Director Adapter Installation and Configuration Guide
For information about installing and configuring the vCenter adapter, see the VMware vCenter Adapter
Installation and Configuration Guide.
NOTE If you have a vCenter Operations Manager vApp installation, the vCenter adapter is installed by
default.
Credential Requirements
You must provide the user name and password of a vCloud Director user when you create a credential for a
vCloud Director adapter instance. The user must have an Administrator or SSO credentials with sysadmin
privileges.
Additional Software Requirements
The vCloud Director adapter uses VCD Java SDK (vsdjavasdk) 5.5.0 to communicate with vCloud Director.
The JAR files for the SDK are provided in the lib folder under the adapter installation folder.
22
VMware, Inc.
Installing the vCloud Director
Adapter
2
How you install the vCloud Director adapter depends on whether you have a vCenter Operations Manager
Standalone or vApp installation.
This chapter includes the following topics:
n
“Install the Adapter in a Standalone Installation,” on page 23
n
“Install the Adapter in a vApp Installation,” on page 24
n
“vCloud Director Adapter Folders and Files,” on page 25
Install the Adapter in a Standalone Installation
If you have a Standalone installation, you install the vCloud Director adapter by extracting the adapter
installation files from a TGZ file and running an installation utility.
Prerequisites
n
Download the management pack installation file from
https://solutionexchange.vmware.com/store/category_groups/cloud-management. You can download
the TGZ file from the Resources tab of the management pack page.
n
Make a note of the build number in the TGZ file name. The build number appears after the
management pack name, for example, managementpack_name-buildnumber.tgz.
n
Read the release notes included with the TGZ file.
Procedure
1
Open the TGZ file and extract the TAR file to a temporary folder on your vCenter Operations Manager
server.
2
In the temporary folder, open the TAR file and extract and run the installer for your operating system
platform.
3
Log in to vCenter Operations Manager as an administrator.
4
Select Admin > Support.
5
On the Info tab, find the Adapters Info pane and click the Describe icon ( ).
The Describe icon is located at the top right of the Adapters Info pane.
6
Click Yes to start the describe process.
7
Verify that the build number in the Adapter Version column for the management pack matches the
build number in the TGZ file that you downloaded.
VMware, Inc.
23
VMware vCloud Director Adapter Installation and Configuration Guide
The installation utility creates the vcloud_adapter3 folder and vcloud_adapter3.jar file in the vcenterops/user/plugins/inbound folder.
Install the Adapter in a vApp Installation
If you have a vApp installation, you install the vCloud Director adapter from a PAK file.
Prerequisites
n
Download the management pack installation PAK file anonymously from
https://solutionexchange.vmware.com/store/category_groups/cloud-management.
n
Make a note of the build number in the PAK file name. The build number appears after the
management pack name, for example, managementPack_name-buildnumber.pak.
n
Read the release notes included with the PAK file.
Procedure
1
Save the PAK file in a temporary folder.
2
Log in to the Admin user interface as the admin user.
For example: https://ipaddress/admin/
3
On the Update tab, click Browse to locate the temporary folder and select the PAK file.
4
Click Update and click OK to confirm the update.
The Admin user interface uploads the PAK file. The upload might take several minutes.
5
Read and accept the EULA and click OK.
6
Click OK to confirm and start the update process.
The update might take several minutes. Status information appears on the Update tab when the update
is finished.
7
Log in to the Custom user interface as an administrator.
For example: https://ipaddress/vcops-custom/
8
Select Admin > Support.
9
On the Info tab, find the Adapters Info pane and click the Describe icon ( ).
The Describe icon is located at the top right of the Adapters Info pane.
10
Click Yes to start the describe process and click OK.
vCenter Operations Manager finds the management pack files, gathers information about the abilities
of the management pack, and updates the user interface with information about the management pack.
The describe process might take several minutes. When the describe process is finished, the
management pack appears in the Adapters Info pane. The build number is in the Adapter Version
column.
11
Verify that the build number in the Adapter Version column for the management pack matches the
build number in the PAK file that you uploaded.
The installation process creates the vcloud_adapter3 folder and vcloud_adapter3.jar file in the vcenter-
ops/user/plugins/inbound folder.
24
VMware, Inc.
Chapter 2 Installing the vCloud Director Adapter
vCloud Director Adapter Folders and Files
The installer places the vCloud Director adapter files in the vcloud_adapter3 folder.
Table 2‑1. vCloud Director Adapter Folders and Files
Folder
File
Description
conf
describe.xml
Describes the resources of the adapter.
events_white_list.txt
Filters the events that the adapter retrieves from vCloud
Director.
vcloud.properties
Contains properties that apply to all adapter instances.
version.txt
Contains version information.
history.txt
Contains the history of the adapter changes.
open_source_license.txt
Open source license file.
vcloud_instanceID.properties
Contains properties that apply to a specific adapter
instance.
VEntitiesLog_instanceID.txt
VEntitiesLog_instanceID.txt.bck
Logs relationships for a specific adapter instance.
allParents_instanceID.txt
allParents_instanceID.txt.bck
Keeps track of all parent resources for a specific adapter
instance.
work
lib
VMware, Inc.
Contains all library files.
25
VMware vCloud Director Adapter Installation and Configuration Guide
26
VMware, Inc.
Configuring the vCloud Director
Adapter
3
To configure the vCloud Director adapter, you must add an adapter instance and credential in
vCenter Operations Manager. You can optionally modify adapter-level and instance-level properties.
This chapter includes the following topics:
n
“Add an Adapter Instance,” on page 27
n
“Filtering the Events that the Adapter Imports,” on page 29
n
“Configuring Adapter Properties,” on page 29
n
“Import Dashboard,” on page 30
Add an Adapter Instance
You must create an adapter instance for the vCloud Director adapter. The adapter instance defines the
adapter type and identifies the vCloud Director host system.
You can optionally list the Provider vDCs or Organizations for which the adapter instance collects data.
IMPORTANT After you create a vCloud Director adapter instance, do not change the name of the adapter
instance resource. Because vCenter Operations Manager uses the adapter instance resource name as a
resource identifier value, renaming the adapter instance resource causes vCenter Operations Manager to
create duplicate vCloud Director resources in the user interface.
Prerequisites
n
Install the vCloud Director adapter. See Chapter 2, “Installing the vCloud Director Adapter,” on
page 23.
n
Verify that your system meets the configuration requirements. See “Installation and Configuration
Requirements,” on page 21.
n
Create a credential, or, if you plan to create a credential when you define the adapter instance, become
familiar with creating credentials. See “Add a Credential,” on page 28.
Procedure
1
Log in to the Custom user interface as an administrator.
2
Select Environment > Configuration > Adapter Instances.
3
Select the collector to use from the Collector drop-down menu.
Unless you added additional collectors, the only available collector is vCenter Operations Server. You
can change the name of this collector when you install the standalone version.
4
VMware, Inc.
Select vCloud Adapter from the Adapter Kind drop-down menu.
27
VMware vCloud Director Adapter Installation and Configuration Guide
5
Click the Add New Adapter Instance icon.
6
Type a name for the adapter in the Adapter Instance Name text box.
7
Type the host name or IP address of the vCloud Director host system in the vCloud Director Host text
box.
If a public REST API base URL is assigned in vCloud Director, type the public address. For example, if
the VCD public REST API base URL is https://vcloud.somehost.com, type vcloud.somehost.com.
8
Select an Auto Discovery option.
If you select true, the adapter instance discovers and imports vCloud Director entities. If you select
false, you must use manual discovery to import vCloud Director entities.
9
(Optional) To limit the vCloud Director entities that the adapter instance imports, list the names of the
Provider vDCs to import in the Filter By Provider vDCs List text box and the names of the
Organizations to import in the Filter By Organizations List text box.
Use a semicolon (;) to separate multiple names, for example, org1; org2; org3.
n
If you leave both lists blank, the adapter instance imports all of the supported entities from the
vCloud Director hierarchy.
n
If you list Organizations and leave the Provider vDC list blank, the adapter instance imports only
the Organizations that you list and the entities that are related to those Organizations.
n
If you list Provider vDCs and leave the Organizations list blank, the adapter instance imports only
the Provider vDCs that you list and the entities that are related to those vDCs.
n
If you list Provider vDCs and Organizations, the adapter instance imports the union of the two
sets.
10
Select the credential to use to sign on to the data source from the Credential drop-down menu, or click
Add to add a new credential.
11
Click Test to test the connection to the vCloud Director host system.
12
Click OK to save your configuration.
What to do next
If you disabled autodiscovery for the adapter instance, use manual discovery to import vCloud Director
entities. For information about using the manual discovery process, see the online help.
Add a Credential
The vCloud Director adapter requires a user name and password to connect to vCloud Director. You use
this user name and password to create a credential for the adapter instance in vCenter Operations Manager.
You can add the credential before you create the adapter instance and select the correct credential when you
define the adapter instance, or you can add the credential when you define the adapter instance.
Prerequisites
n
Install the vCloud Director adapter. See Chapter 2, “Installing the vCloud Director Adapter,” on
page 23.
n
Verify that the user name and password meet the credential requirements. See “Credential
Requirements,” on page 22.
Procedure
28
1
Log in to the Custom user interface as an administrator.
2
Select Environment > Configuration > Credentials.
VMware, Inc.
Chapter 3 Configuring the vCloud Director Adapter
3
Select vCloud Adapter from the Adapter Kind drop-down menu.
4
Select vCloud Adapter Credentials from the Credential Kind drop-down menu.
5
At the top of the list of credentials, next to Action, click Add.
6
Type a unique name for the credential instance in the Instance name text box.
7
Type the user name and password in the User Name and Password text boxes. You must provide
credentials for a user with an Administrator Role.
You can type the user name in the format username or username@System.
8
Click OK to add the credential for the adapter kind.
The credential appears in the list in the Manage Credentials window.
Filtering the Events that the Adapter Imports
The vCloud Director uses a white list file, called events_white_list.txt, to filter events that it retrieves from
vCloud Director. The events_white_list.txt file is in the conf folder. In a vApp installation, you modify the
events_white_list.txt file on the Analytics virtual machine.
By default, events_white_list.txt contains the following events:
VDC_CREATE_REQUEST
VDC_CREATE
VDC_DELETE_REQUEST
VDC_DELETE
VDC_FAST_PROVISIONING_MODIFY
VDC_THIN_PROVISIONING_MODIFY
VDC_MODIFY
PROVIDERVDC_CREATE_REQUEST
PROVIDERVDC_CREATE
PROVIDERVDC_MODIFY
PROVIDERVDC_DELETE_REQUEST
PROVIDERVDC_DELETE
ORG_CREATE
ORG_MODIFY
ORG_DELETE
You can add or remove events from the events_white_list.txt file. If you do not list events to import and
leave the file empty, the vCloud Director adapter imports all events.
Configuring Adapter Properties
You configure adapter-level properties in the vcloud.properties file and instance-level properties in the
vcloud_instanceID.properties file. The adapter-level configuration file contains properties that affect all
adapter instances. The instance-specific configuration files contain properties that affect only particular
adapter instances. Properties files are in the conf folder.
NOTE In a vApp installation, you modify the properties file in the conf folder on the Analytics virtual
machine.
VMware, Inc.
29
VMware vCloud Director Adapter Installation and Configuration Guide
Adapter-Level Properties
You define adapter-level properties in the vcloud.properties file in the conf folder. Adapter-level
properties affect all instances of the vCloud Director adapter.
Table 3‑1. Adapter-Level Properties
Property
Description
PROCESS_EVENTS
Determines whether the adapter processes events. Setting this
property to true causes the adapter to process events.
MIN_BACK_INTIME_FOR_FIRST_EVENT_PROCES
SING
Determines the number of minutes between event processing. For
example, if this property is set to 60 (the default value) and the
adapter starts at 11 a.m., the adapter imports only events that are
generated after 10 a.m. on the same day.
Setting this property ensures that the adapter does not retrieve events
that belong to vCloud Director entities that might no longer exist.
USE_CERTIFICATES
Determines whether the adapter uses the certificates in the collector
truststore in the vcenter-ops/user/conf folder.
If you set this property to true, the adapter uses the certificates in the
truststore each time it logs in to vCloud Director. If the certificates are
not valid or are misisng, the adapter fails to connect to vCloud
Director.
If you set this property to false, the adapter always logs in to vCloud
Director without using certificates.
For information about configuring adapter-level properties for alerts, see “Customizing Your
Configuration,” on page 18.
Instance-Level Properties
Each adapter instance has a properties file in the work folder called vcloud_instanceID.properties, where
instanceID is the resource ID of the adapter instance. Instance-level properties affect only a particular
vCloud Director adapter instance.
The vCloud Director adapter creates and initializes the instance-level properties file during the first
collection cycle of the adapter instance.
The LAST_EVENT_TIME property in the instance-level properties file tracks the last event time that the adapter
instance retrieves from vCloud Director. During the first collection cycle, the LAST_EVENT_TIME property is
set to the current time minus the value of the MIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING property. The
MIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING property is in the vcloud.properties file and its default
value is 60 minutes.
You should not need to modify the LAST_EVENT_TIME property except during adapter testing.
Import Dashboard
Perform the following procedure to import a dashboard to the vCloud Director adapter.
Prerequisites
Verify that vCloud Adapter instance is already created in vCenter Operations Manager and wait for few
collection cycles to complete.
Procedure
30
1
Login by using SSH to Analytics virtual machine.
2
Navigate to the directory /usr/lib/vmware-vcops/tools/dbcli.
VMware, Inc.
Chapter 3 Configuring the vCloud Director Adapter
3
Run the command ./dbcli.sh dashboard import <admin-user-name>
$ALIVE_BASE/user/plugins/inbound/vcloud_adapter3/conf/dashboards/<dashboardname>.xml --retry
10.
VMware, Inc.
31
VMware vCloud Director Adapter Installation and Configuration Guide
32
VMware, Inc.
Troubleshooting the vCloud Director
Adapter
4
Known troubleshooting information can help you diagnose and resolve problems with the vCloud Director
adapter.
This chapter includes the following topics:
n
“Troubleshooting a vCloud Director Adapter Instance,” on page 33
n
“Viewing System Log Files,” on page 33
Troubleshooting a vCloud Director Adapter Instance
Perform these general troubleshooting steps to diagnose and correct problems with a vCloud Director
adapter instance.
1
Test the connection to the vCloud Director host system. See “Add an Adapter Instance,” on page 27.
2
If the adapter instance cannot connect to the vCloud Director host system, verify the address in the
vCloud Director Host text box on the Add Adapter Instance window. If a public REST API base URL is
assigned in vCloud Director, you must type the public address. See “Add an Adapter Instance,” on
page 27.
3
View the collection status and state of the adapter instance resource on the Environment Overview
page.
4
Check the adapter and collector logs for errors. See “Viewing System Log Files,” on page 33.
Viewing System Log Files
You can view vCloud Director errors in the vCenter Operations Manager adapter and collector log files. You
can view log files in the Custom user interface or in an external log viewer.
The vCloud Director adapter log files are in the vcenter-ops/user/log/adapters/VCloudAdapter folder. The
collector log files are in the vcenter-ops/user/log folder.
You can set the log level for each class in the log4j.properties file in the vcenterops/user/log/conf/collector folder, for example:
log4j.logger.com.integrien.adapter3.vlcloud.VCloudAdapter=debug
The logging level is set to ERROR by default. To troubleshoot issues, set the logging level to INFO. To view
detailed messages, including micro steps, queries, and returned results, set the logging level to DEBUG.
NOTE If you set the logging level to DEBUG, log files can become large very quickly. Set the logging level to
DEBUG only for short periods of time.
For information about viewing log files and modifying logging levels, see the online help.
VMware, Inc.
33
VMware vCloud Director Adapter Installation and Configuration Guide
vCloud Director Adapter Classes
The vCloud Director adapter uses certain adapter classes. These classes are in the vcloud_adapter3.jar file.
34
n
com.integrien.adapter3.vcloud.VCloudAdapter
n
com.integrien.adapter3.vcloud.VCloudConstants
n
com.integrien.adapter3.vcloud.RelationshipProcessor
n
com.integrien.adapter3.vcloud.FakeSSLSocketFactory
n
com.integrien.adapter3.vcloud.EventProcessor
n
com.integrien.adapter3.vcloud.vmentity.VCloudEntity
n
com.integrien.adapter3.vcloud.vmentity.VCloudEvent
n
com.integrien.adapter3.vcloud.properties.VCopsDBProperties
n
com.integrien.adapter3.vcloud.properties.InstanceProperties
n
com.integrien.adapter3.vcloud.properties.VCloudProperties
n
com.integrien.adapter3.vcloud.exceptions.VCloudAdapterException
VMware, Inc.
Index
A
vcloud_adapter3 folder 25
adapter classes 34
adapter instances 27
adapter properties 29
adapter-level properties 30
audience information 5
C
change events 19
configuration properties 18
configuration steps 27
credentials 28
customizing configuration 18
D
data collection 10
default dashboards 9
E
events_white_list.txt 29
I
import dashboard 30
installing the adapter 23, 24
instance-level properties 30
introduction 9
M
monitoring vCloud Director entities 20
P
processing alerts 19
S
system requirements 21
system log files 33
T
troubleshooting steps 33
U
updated information 7
V
vCloud Entity Status tag 20
VMware, Inc.
35
VMware vCloud Director Adapter Installation and Configuration Guide
36
VMware, Inc.