VMware vCloud Director Adapter Installation and ... · VMware vCloud Director Adapter Installation...

VMware vCloud Director AdapterInstallation and Configuration Guide

vCenter Operations Manager 2.6

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

EN-000922-06

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

VMware vCloud Director Adapter Installation and Configuration Guide

2 VMware, Inc.

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:

[email protected]

Copyright © 2014 VMware, Inc. All rights reserved. Copyright and trademark information.

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

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

mailto:[email protected]

http://pubs.vmware.com/copyright-trademark.html

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 9Data that the Adapter Collects 10Customizing Your Configuration 18How the Adapter Processes Events 19Using the vCloud Entity Status Resource Tag 20vCloud Director Entities in vCenter Operations Manager 20Installation and Configuration Requirements 21

2 Installing the vCloud Director Adapter 23

Install the Adapter in a Standalone Installation 23Install the Adapter in a vApp Installation 24vCloud Director Adapter Folders and Files 25

3 Configuring the vCloud Director Adapter 27

Add an Adapter Instance 27Filtering the Events that the Adapter Imports 29Configuring Adapter Properties 29Import Dashboard 30

4 Troubleshooting the vCloud Director Adapter 33

Troubleshooting a vCloud Director Adapter Instance 33Viewing System Log Files 33

Index 35

VMware, Inc. 3


4 VMware, Inc.

VMware vCloud Director Adapter Installation andConfiguration Guide

The VMware vCloud Director Adapter Installation and Configuration Guide describes how to install the vCloudDirector adapter for vCenter Operations Manager.

Intended AudienceThis information is intended for anyone who needs to install and configure the vCloud Director adapter.

VMware, Inc. 5


6 VMware, Inc.

Updated Information

The VMware vCloud Director Adapter Installation and Configuration Guide is updated with each release of theproduct or when necessary.

This table provides the update history of the VMware vCloud Director Adapter Installation and ConfigurationGuide.

Revision Description

EN-000922-06 Added new dashboards in “Default Dashboards of vCloud Director Adapter,” on page 9 and alertprocessing 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 ConfigurationRequirements,” 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 23and “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 aboutthe vCenter adapter requirement.

EN-000922-01 Updated “Add an Adapter Instance,” on page 27 to include a warning about renaming the adapterinstance resource.

EN-000922-00 n The vCloud Director Adapter Technical Note is now the VMware vCloud Director Adapter Installation andConfiguration Guide.

n Changed the description of the vCloud Director Host text box in “Add an Adapter Instance,” onpage 27.

The vCloud Director Adapter Technical Note was the initial release of this document.

VMware, Inc. 7


8 VMware, Inc.

Introduction to the vCloud DirectorAdapter 1

The vCloud Director adapter is an embedded adapter for vCenter Operations Manager. The adaptermonitors the health of supported vCloud Director entities and sends early warning smart alerts formonitored 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 AdapterFollowing 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 aparticular resource that are collected by the vCloudDirector adapter at a single place. The metrics for theselected resource is displayed if you select the resource.

VCD Organization vDC Utilization This dashboard provides a quick view of the top 10Organization vDC based on the CPU usage, memoryusage, storage usage, vApps, network usage, storageAllocation, etc. Based on these metrics, you can determinethe performances of the respective Organization vDC.

VCD vApp Utilization This dashboard provides a quick view of the top 10 vAppsbased on the CPU allocation, memory allocation, storageallocation, number of virtual machines, and number ofCPUs. Based on these metrics, you can determine theperformances of the respective vApp.

VMware, Inc. 9

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 thehealth of the particular resources collected by the vCloudDirector. This dashboard also provides us with anothermetrics known as Anomaly Count Graph, which draws outthe number of anomalies for a resource in the form ofmetrics.

VCD Alerts This dashboard pulls the alerts pulled from vCloudDirector adapter and relationship of the resource whichcauses the alert and its Interesting Metric is displayed.

VCD Troubleshooting This dashboard shows all objects and its relationship invCloud Director adapter based on the selection of object,corresponding health anomalies and its Interesting Metricis displayed.

NOTE The VCD Troubleshooting dashboard is not created even if the adapter instance is created becausevCenter Operations Manager takes few collection cycle to create a self generated resource kind. You need toimport the dashboard by running the Database Command Line Interface (DBCLI) command. For moreinformation on importing a dashboard, see “Import Dashboard,” on page 30.

Data that the Adapter CollectsThe vCloud Director adapter collects information for Provider vDC, Organization, Organization vDC, andvApp entities from the vCloud Director database and creates the corresponding resources invCenter 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 vCenteradapter has already imported and creates resource relationships between the vApps and the virtualmachines.

The vCloud Director adapter does not collect performance data from vCloud Director. Instead, the vCloudDirector adapter enables vCenter Operations Manager to present health data by mapping vCloud Directorentities 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.

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


10 VMware, Inc.

n vCloud External Network

n vCloud Entity Status - The vCloud Director adapter creates several types of entity status in vCenterOpeations Manager user interface and depending on the resource entity status, these resources areadded 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 Summary|Deployed VM Quotan Summary|Enabledn Summary|Number of Catalogsn Summary|Number of Disksn Summary|Number of Groupsn Summary|Number of Usersn Summary|Number of Organization VDCsn Summary|Number of Running VMsn Summary|Number of vAppsn Summary|Storage VM Quotan Summary|Number of Blocking Tasksn Network|<vdc>|Number of IPs Freen Network|<vdc>|Number of IPs Usedn Network|<vdc>|Number of IPs Provisionedn Network|<vdc>|Number of IPs Used (%)n Network|<vdc>|Number of IPs Free (%)n ORG|Number of Blocking taskn ORG|Network|<vdc>|Number of IPs Usedn ORG|Network|<vdc>|Number of IPs Freen ORG|Network|<vdc>|Number of IPs Provisionedn ORG|Network|<vdc>|Number of IPs Used (%)n ORG|Network|<vdc>|Number of IPs Free (%)

Chapter 1 Introduction to the vCloud Director Adapter

VMware, Inc. 11

Table 1‑2. vCloud Adapter Metrics (Continued)


Organization VDC n Summary|Allocation Modeln Summary|Enabledn Summary|Maximum Number of VMsn Summary|Number of Disksn Summary|Number of Mediasn Summary|Number of Resource Poolsn Summary|Number of Storage Policiesn Summary|Number of vApp Templatesn Summary|Number of vAppsn Summary|Statusn CPU Usage|Allocation(MHz)n CPU Usage|Allocation(GHz)n CPU Usage|Free (%)n CPU Usage|Free (MHz)n CPU Usage|Free (GHz)n CPU Usage|Overhead (MHz)n CPU Usage|Overhead (GHz)n CPU Usage|Reserved (%)n CPU Usage|Reserved (MHz)n CPU Usage|Reserved (GHz)n CPU Usage|Used (%)n CPU Usage|Used (MHz)n CPU Usage|Used (GHz)n CPU Usage|vCPU Speed (MHz)n CPU Usage|vCPU Speed (GHz)n Memory|Allocation(MB)n Memory|Allocation(GB)n Memory |Free (%)n Memory |Free (MB)n Memory |Free (GB)n Memory |Overhead (MB)n Memory |Overhead (GB)n Memory |Reserved (%)n Memory |Reserved (MB)n Memory |Reserved (GB)n Memory |Used (%)n Memory |Used (MB)n Memory |Used (GB)n Storage|Summary|Allocation (MB)n Storage|Summary|Allocation (GB)n Storage|Summary|Fast Provisioningn Storage|Summary|Free (%)n Storage|Summary|Free (MB)n Storage|Summary|Free (GB)n Storage|Summary|Overhead(MB)n Storage|Summary|Overhead(GB)n Storage|Summary|Thin Provisioningn Storage|Summary|Used (%)n Storage|Summary|Used (MB)n Storage|Summary|Used (GB)n Storage|<Storage Policy>|Free (%)n Storage|<Storage Policy>|Free (MB)


12 VMware, Inc.



n Storage|<Storage Policy>|Free (GB)n Storage|<Storage Policy>|Used (%)n Storage|<Storage Policy>|Used (MB)n Storage|<Storage Policy>|Used (GB)n Storage|<Storage Policy>|Total (MB)n Storage|<Storage Policy>|Total (GB)n Network|Available Networksn Network|Maximum Provisioned Networksn Network|Number of Networks Usedn Summary|Allocation Modeln Summary|Enabledn Summary|Maximum Number of VMsn Summary|Number of Disksn Summary|Number of Mediasn Summary|Number of Resource Poolsn Summary|Number of Storage Policiesn Summary|Number of vApp Templatesn Summary|Number of vAppsn Summary|Statusn CPU Usage|Allocation(MHz)n CPU Usage|Allocation(GHz)n CPU Usage|Free (%)n CPU Usage|Free (MHz)n CPU Usage|Free (GHz)n CPU Usage|Overhead (MHz)n CPU Usage|Overhead (GHz)n CPU Usage|Reserved (%)n CPU Usage|Reserved (MHz)n CPU Usage|Reserved (GHz)n CPU Usage|Used (%)n CPU Usage|Used (MHz)n CPU Usage|Used (GHz)n Memory|Allocation(MB)n Memory|Allocation(GB)n Memory |Free (%)n Memory |Free (MB)n Memory |Free (GB)n Memory |Overhead (MB)n Memory |Overhead (GB)n Memory |Reserved (%)n Memory |Reserved (MB)n Memory |Reserved (GB)n Memory |Used (%)n Memory |Used (MB)n Memory |Used (GB)n Storage|Summary|Allocation (MB)n Storage|Summary|Allocation (GB)n Storage|Summary|Fast Provisioningn Storage|Summary|Free (%)n Storage|Summary|Free (MB)n Storage|Summary|Free (GB)n Storage|Summary|Overhead(MB)


VMware, Inc. 13



n Storage|Summary|Overhead(GB)n Storage|Summary|Thin Provisioningn Storage|Summary|Used (%)n Storage|Summary|Used (MB)n Storage|Summary|Used (GB)n Storage|<Storage Policy>|Free (%)n Storage|<Storage Policy>|Free (MB)n Storage|<Storage Policy>|Free (GB)n Storage|<Storage Policy>|Used (%)n Storage|<Storage Policy>|Used (MB)n Storage|<Storage Policy>|Used (GB)n Storage|<Storage Policy>|Total (MB)n Storage|<Storage Policy>|Total (GB)n Network|Available Networksn Network|Maximum Provisioned Networksn Network|Number of Networks Usedn Summary|Allocation Modeln Summary|Enabledn Summary|Maximum Number of VMsn Summary|Number of Disksn Summary|Number of Mediasn Summary|Number of Resource Poolsn Summary|Number of Storage Policiesn Summary|Number of vApp Templatesn Summary|Number of vAppsn Summary|Statusn CPU Usage|Limit (MHz)n CPU Usage|Limit (GHz)n CPU Usage|Overhead (MHz)n CPU Usage|Overhead (GHz)n CPU Usage|Reserved (%)n CPU Usage|Used (MHz)n CPU Usage|Used (GHz)n CPU Usage|vCPU Speed (MHz)n CPU Usage|vCPU Speed (GHz)n Memory |Limit (MB)n Memory |Limit (GB)n Memory |Overhead (MB)n Memory |Overhead (GB)n Memory |Reserved (%)n Memory |Used (MB)n Memory |Used (GB)n Storage|Summary|Allocation (MB)n Storage|Summary|Allocation (GB)n Storage|Summary|Fast Provisioningn Storage|Summary|Free (%)n Storage|Summary|Free (MB)n Storage|Summary|Free (GB)n Storage|Summary|Overhead(MB)n Storage|Summary|Overhead(GB)n Storage|Summary|Thin Provisioningn Storage|Summary|Used (%)


14 VMware, Inc.



n Storage|Summary|Used (MB)n Storage|Summary|Used (GB)n Storage|<Storage Policy>|Free (%)n Storage|<Storage Policy>|Free (MB)n Storage|<Storage Policy>|Free (GB)n Storage|<Storage Policy>|Used (%)n Storage|<Storage Policy>|Used (MB)n Storage|<Storage Policy>|Used (GB)n Storage|<Storage Policy>|Total (MB)n Storage|<Storage Policy>|Total (GB)n Network|Available Networksn Network|Maximum Provisioned Networksn Network|Number of Networks Used


VMware, Inc. 15



Provider VDC n Summary|Statusn Summary|Enabledn Summary|Number of Datastoresn Summary|Number of Organization VDCsn Summary|Number of Resource Poolsn Summary|Number of Storage Policiesn CPU Usage|Allocation(MHz)n CPU Usage|Allocation(GHz)n CPU Usage|Free (%)n CPU Usage|Free (MHz)n CPU Usage|Free (GHz)n CPU Usage|Overhead (MHz)n CPU Usage|Overhead (GHz)n CPU Usage|Used (%)n CPU Usage|Used (MHz)n CPU Usage|Used (GHz)n CPU Usage|Total (MHz)n CPU Usage|Total (GHz)n Memory |Allocation(MB)n Memory |Allocation(GB)n Memory |Free (%)n Memory |Free (MB)n Memory |Free (GB)n Memory |Overhead (MB)n Memory |Overhead (GB)n Memory |Used (%)n Memory |Used (MB)n Memory |Used (GB)n Memory |Total (MB)n Memory |Total (GB)n Storage|Summary|Allocation (MB)n Storage|Summary|Allocation (GB)n Storage|Summary|Free (%)n Storage|Summary|Free (MB)n Storage|Summary|Free (GB)n Storage|Summary|Overhead(MB)n Storage|Summary|Overhead(GB)n Storage|Summary|Total (MB)n Storage|Summary|Total (GB)n Storage|Summary|Used (%)n Storage|Summary|Used (MB)n Storage|Summary|Used (GB)n Storage|<Storage Policy>|Free (%)n Storage|<Storage Policy>|Free (MB)n Storage|<Storage Policy>|Free (GB)n Storage|<Storage Policy>|Used (%)n Storage|<Storage Policy>|Used (MB)n Storage|<Storage Policy>|Used (GB)n Storage|<Storage Policy>|Total (MB)n Storage|<Storage Policy>|Total (GB)n Storage|<Storage Policy>|Provisioned (%)n Storage|<Storage Policy>|Provisioned (MB)


16 VMware, Inc.



n Storage|<Storage Policy>|Provisioned (GB)n Storage|<Storage Policy>|Requested (%)n Storage|<Storage Policy>|Requested (MB)n Storage|<Storage Policy>|Requested (GB)

Organization VDC Network Directn Summary|Statusn Summary|Typen Network|Network Pool|Used (%)n Network|Network Pool|Usedn Network|Network Pool|Free (%)n Network|Network Pool|Usedn Network|Network Pool|Total

Provider VDC Storage Policy n Storage|Free (%)n Storage|Free (MB)n Storage|Free (GB)n Storage|Used (%)n Storage|Used (MB)n Storage|Used (GB)n Storage|Total (MB)n Storage|Total (GB)n Storage|Provisioned (%)n Storage|Provisioned (MB)n Storage|Provisioned (GB)n Storage|Requested (%)n Storage|Requested (MB)n Storage|Requested (GB)

Organization VDC Storage Policy n Summary|Statusn Summary|Defaultn Storage|Free (%)n Storage|Free (MB)n Storage|Free (GB)n Storage|Used (%)n Storage|Used (MB)n Storage|Used (GB)n Storage|Total (MB)n Storage|Total (GB)

vCloud Datastore n Storage|Free (%)n Storage|Free (MB)n Storage|Free (GB)n Storage|Used (%)n Storage|Used (MB)n Storage|Used (GB)n Storage|Total (MB)n Storage|Total (GB)n Storage|Provisioned (%)n Storage|Provisioned (MB)n Storage|Provisioned (GB)n Storage|Requested (%)n Storage|Requested (MB)n Storage|Requested (GB)


VMware, Inc. 17



vCloud External Network n Summary|Statusn Network|Network Pool|Used (%)n Network|Network Pool|Usedn Network|Network Pool|Free (%)n Network|Network Pool|Usedn Network|Network Pool|Total

vCloud Network Pool n Summary|Statusn Summary|Typen Network|Network Pool|Used (%)n Network|Network Pool|Usedn Network|Network Pool|Free (%)n Network|Network Pool|Freen Network|Network Pool|Total

vCloud Host n Summary|Enabledn Summary|Statusn Summary|Ready

vCloud vCenter Summary|Status

vApp n Summary|Statusn Summary|Number of VMsn Storage|Allocation (MB)n Storage|Allocation (GB)n Memory|Allocation (MB)n Memory|Allocation (GB)n CPU Usage | Allocation (MHz)n CPU Usage | Allocation (GHz)n CPU Usage | Number of CPUsn -APP|Storage Lease

vCloud Virtual Machine n Summary|Statusn Summary|Chain Lengthn Summary|Guest Customizationn Summary | Snapshot Size (MB)n Summary | Snapshot Size (GB)n VM|Chain Lengthn VM|Guest Customization

Customizing Your ConfigurationYou can customize your Management Pack for vCloud Director configuration by modifying configurationproperties and workload calculation definitions.

Modifying Configuration PropertiesThe vcloud.properties file contains configuration properties that control how Management Pack for vCloudDirector models vCloud Director services, synchronizes resource relationships, and reports resource downalerts.

The vcloud.properties file is in the conf folder in the management pack installation folder. In a vAppinstallation, edit the vcloud.properties file in the conf folder on the Analytics virtual machine. Changes tothe vcloud.properties file take effect when you restart vCenter Operations Manager services.


18 VMware, Inc.

How the Adapter Processes AlertsThe vCloud Director adapter can import alerts for vCloud Director entities that have the Systemorganization 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 fromvCloud Director to vCenter Operations Manager. Set this property to True to import the alerts specificto property.

n The ENABLE_PVDC_Alerts property is a vCloud Director entity level alert setting that governs importsof 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 importsof 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 governsimports of alerts specific to a datastore. Set this property to True to import the alerts specific toproperty.

n The ENABLE_VAPP_Alerts property is a vCloud Director entity level alert setting that governs importsof 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 governsimports 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 importsof 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 thatgoverns imports of alerts specific to a storage profile. Set this property to True to import the alertsspecific to property.

How the Adapter Processes EventsThe vCloud Director adapter can import events for vCloud Directory entities that have the Systemorganization and the Provider vDC, Organization, Organization vDC, or vApp entity type. These eventsappear as change events in the Custom user interface.

The PROCESS_EVENTS property in the instance-level properties file determines whether a vCloud Directoradapter instance processes events.

A vCloud Director adapter instance uses the value of the LAST_EVENT_TIME property in the instance-levelproperties 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 theMIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING property. TheMIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING property is in the adapter-level properties file and its defaultvalue is 60 minutes.

A vCloud Director adapter instance uses a white list file, called events_white_list.txt, to apply additionalfiltering to events that it retrieves from vCloud Director. The adapter instance filters events based on thewhite list before it imports the events into vCenter Operations Manager. You can modify the events in thewhite list file.

NOTE Because the vCloud Director adapter logs in to vCloud Director as an administrator of the Systemorganization, it has access to only the subset of events that are available to that user. The events for vAppsare not available.


VMware, Inc. 19

Using the vCloud Entity Status Resource TagThe vCloud Director adapter associates each vCloud Directory entity that it maps to a resource with avCloud 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 theirdeployment status.

You can select the NotExisting tag value to locate resources that no longer exist in the vCloud Directorinventory and remove them from the Custom user interface. When objects are removed from the vCloudDirector inventory, they remain in the Custom user interface until you remove them.

vCloud Director Entities in vCenter Operations ManagerWith 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 vAppThis example shows the type of information that appears on the Resource Detail page for a vApp. TheHealth Tree pane shows the topology of the virtual machines and the Root Cause Ranking pane shows asummary of the virtual machine that indicates a problem.

Figure 1‑1. Example of vApp Details

Resources and Mashup Charts WidgetsThis example shows vCloud Director entities in the Resources and Mashup Charts widgets. Health scoresfor each entity appear in the Resources widget and the Mashup Charts widget shows historical healthtrends.


20 VMware, Inc.

Figure 1‑2. Examples of vCloud Director Entities in the Resources and Mashup Charts Widgets

Installation and Configuration RequirementsThe vCloud Director adapter has certain installation and configuration requirements.

Compatible vCloud Director VersionsThe vCloud Director adapter is compatible with vCloud Director 5.1 and 5.5.

Compatible vCenter Operations Manager VersionsThe 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 VersionsThe vCloud Director adapter is compatible with the following versions of vCenter Server:

n 5.1

n 5.5

vCenter Adapter RequirementsYou must install and configure the vCenter adapter before you install and configure the vCloud Directoradapter.

The vCloud Director adapter uses the virtual machine resources that the vCenter adapter creates when itcreates relationships between virtual machines and the vApps that it imports from vCloud Director.


VMware, Inc. 21

For information about installing and configuring the vCenter adapter, see the VMware vCenter AdapterInstallation and Configuration Guide.

NOTE If you have a vCenter Operations Manager vApp installation, the vCenter adapter is installed bydefault.

Credential RequirementsYou must provide the user name and password of a vCloud Director user when you create a credential for avCloud Director adapter instance. The user must have an Administrator or SSO credentials with sysadminprivileges.

Additional Software RequirementsThe 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 DirectorAdapter 2

How you install the vCloud Director adapter depends on whether you have a vCenter Operations ManagerStandalone or vApp installation.


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 InstallationIf you have a Standalone installation, you install the vCloud Director adapter by extracting the adapterinstallation 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 downloadthe 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 themanagement 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 Managerserver.

2 In the temporary folder, open the TAR file and extract and run the installer for your operating systemplatform.

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 thebuild number in the TGZ file that you downloaded.

VMware, Inc. 23

https://solutionexchange.vmware.com/store/category_groups/cloud-management

The installation utility creates the vcloud_adapter3 folder and vcloud_adapter3.jar file in the vcenter-ops/user/plugins/inbound folder.

Install the Adapter in a vApp InstallationIf 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 themanagement 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 updateis 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 abilitiesof 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, themanagement pack appears in the Adapters Info pane. The build number is in the Adapter Versioncolumn.

11 Verify that the build number in the Adapter Version column for the management pack matches thebuild 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.

https://solutionexchange.vmware.com/store/category_groups/cloud-management

vCloud Director Adapter Folders and FilesThe 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 vCloudDirector.

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.

work vcloud_instanceID.properties Contains properties that apply to a specific adapterinstance.

VEntitiesLog_instanceID.txtVEntitiesLog_instanceID.txt.bck

Logs relationships for a specific adapter instance.

allParents_instanceID.txtallParents_instanceID.txt.bck

Keeps track of all parent resources for a specific adapterinstance.

lib Contains all library files.

Chapter 2 Installing the vCloud Director Adapter

VMware, Inc. 25


26 VMware, Inc.

Configuring the vCloud DirectorAdapter 3

To configure the vCloud Director adapter, you must add an adapter instance and credential invCenter Operations Manager. You can optionally modify adapter-level and instance-level properties.


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 InstanceYou must create an adapter instance for the vCloud Director adapter. The adapter instance defines theadapter 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 adapterinstance resource. Because vCenter Operations Manager uses the adapter instance resource name as aresource identifier value, renaming the adapter instance resource causes vCenter Operations Manager tocreate duplicate vCloud Director resources in the user interface.

Prerequisites

n Install the vCloud Director adapter. See Chapter 2, “Installing the vCloud Director Adapter,” onpage 23.

n Verify that your system meets the configuration requirements. See “Installation and ConfigurationRequirements,” on page 21.

n Create a credential, or, if you plan to create a credential when you define the adapter instance, becomefamiliar with creating credentials. See “Add a Credential,” on page 28.

Procedure


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. Youcan change the name of this collector when you install the standalone version.

4 Select vCloud Adapter from the Adapter Kind drop-down menu.

VMware, Inc. 27

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 textbox.

If a public REST API base URL is assigned in vCloud Director, type the public address. For example, ifthe 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 selectfalse, 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 theProvider vDCs to import in the Filter By Provider vDCs List text box and the names of theOrganizations 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 thevCloud Director hierarchy.

n If you list Organizations and leave the Provider vDC list blank, the adapter instance imports onlythe 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 onlythe 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 twosets.

10 Select the credential to use to sign on to the data source from the Credential drop-down menu, or clickAdd 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 Directorentities. For information about using the manual discovery process, see the online help.

Add a CredentialThe vCloud Director adapter requires a user name and password to connect to vCloud Director. You usethis 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 youdefine 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,” onpage 23.

n Verify that the user name and password meet the credential requirements. See “CredentialRequirements,” on page 22.

Procedure


2 Select Environment > Configuration > Credentials.


28 VMware, Inc.

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 providecredentials 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 ImportsThe vCloud Director uses a white list file, called events_white_list.txt, to filter events that it retrieves fromvCloud Director. The events_white_list.txt file is in the conf folder. In a vApp installation, you modify theevents_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 andleave the file empty, the vCloud Director adapter imports all events.

Configuring Adapter PropertiesYou configure adapter-level properties in the vcloud.properties file and instance-level properties in thevcloud_instanceID.properties file. The adapter-level configuration file contains properties that affect alladapter instances. The instance-specific configuration files contain properties that affect only particularadapter 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 virtualmachine.

Chapter 3 Configuring the vCloud Director Adapter

VMware, Inc. 29

Adapter-Level PropertiesYou define adapter-level properties in the vcloud.properties file in the conf folder. Adapter-levelproperties 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 thisproperty to true causes the adapter to process events.

MIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING

Determines the number of minutes between event processing. Forexample, if this property is set to 60 (the default value) and theadapter starts at 11 a.m., the adapter imports only events that aregenerated after 10 a.m. on the same day.Setting this property ensures that the adapter does not retrieve eventsthat belong to vCloud Director entities that might no longer exist.

USE_CERTIFICATES Determines whether the adapter uses the certificates in the collectortruststore in the vcenter-ops/user/conf folder.If you set this property to true, the adapter uses the certificates in thetruststore each time it logs in to vCloud Director. If the certificates arenot valid or are misisng, the adapter fails to connect to vCloudDirector.If you set this property to false, the adapter always logs in to vCloudDirector without using certificates.

For information about configuring adapter-level properties for alerts, see “Customizing YourConfiguration,” on page 18.

Instance-Level PropertiesEach adapter instance has a properties file in the work folder called vcloud_instanceID.properties, whereinstanceID is the resource ID of the adapter instance. Instance-level properties affect only a particularvCloud Director adapter instance.

The vCloud Director adapter creates and initializes the instance-level properties file during the firstcollection cycle of the adapter instance.

The LAST_EVENT_TIME property in the instance-level properties file tracks the last event time that the adapterinstance retrieves from vCloud Director. During the first collection cycle, the LAST_EVENT_TIME property isset to the current time minus the value of the MIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING property. TheMIN_BACK_INTIME_FOR_FIRST_EVENT_PROCESSING property is in the vcloud.properties file and its defaultvalue is 60 minutes.

You should not need to modify the LAST_EVENT_TIME property except during adapter testing.

Import DashboardPerform 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 fewcollection cycles to complete.

Procedure

1 Login by using SSH to Analytics virtual machine.

2 Navigate to the directory /usr/lib/vmware-vcops/tools/dbcli.


30 VMware, Inc.

3 Run the command ./dbcli.sh dashboard import <admin-user-name>$ALIVE_BASE/user/plugins/inbound/vcloud_adapter3/conf/dashboards/<dashboardname>.xml --retry

10.

Chapter 3 Configuring the vCloud Director Adapter

VMware, Inc. 31


32 VMware, Inc.

Troubleshooting the vCloud DirectorAdapter 4

Known troubleshooting information can help you diagnose and resolve problems with the vCloud Directoradapter.


n “Troubleshooting a vCloud Director Adapter Instance,” on page 33

n “Viewing System Log Files,” on page 33

Troubleshooting a vCloud Director Adapter InstancePerform these general troubleshooting steps to diagnose and correct problems with a vCloud Directoradapter 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 thevCloud Director Host text box on the Add Adapter Instance window. If a public REST API base URL isassigned in vCloud Director, you must type the public address. See “Add an Adapter Instance,” onpage 27.

3 View the collection status and state of the adapter instance resource on the Environment Overviewpage.

4 Check the adapter and collector logs for errors. See “Viewing System Log Files,” on page 33.

Viewing System Log FilesYou can view vCloud Director errors in the vCenter Operations Manager adapter and collector log files. Youcan 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. Thecollector 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 vcenter-ops/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 viewdetailed 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 toDEBUG only for short periods of time.

For information about viewing log files and modifying logging levels, see the online help.

VMware, Inc. 33

vCloud Director Adapter ClassesThe vCloud Director adapter uses certain adapter classes. These classes are in the vcloud_adapter3.jar file.

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


34 VMware, Inc.

Index

Aadapter classes 34adapter instances 27adapter properties 29adapter-level properties 30audience information 5

Cchange events 19configuration properties 18configuration steps 27credentials 28customizing configuration 18

Ddata collection 10default dashboards 9

Eevents_white_list.txt 29

Iimport dashboard 30installing the adapter 23, 24instance-level properties 30introduction 9

Mmonitoring vCloud Director entities 20

Pprocessing alerts 19

Ssystem requirements 21system log files 33

Ttroubleshooting steps 33

Uupdated information 7

VvCloud Entity Status tag 20

vcloud_adapter3 folder 25

VMware, Inc. 35


36 VMware, Inc.

Date post:	05-May-2018
Category:	Documents
Upload:	lethu
View:	239 times
Download:	3 times

VMware vCloud Director Adapter Installation and ... · VMware vCloud Director Adapter Installation...

Documents